kc_cluster_node_str - Node applications of a UTM cluster application

The data structure kc_cluster_node_str is defined for the parameter type KC_CLUSTER_NODE. In the case of KC_GET_OBJECT, openUTM uses kc_cluster_node_str to return the properties of the individual node applications (instances) in a UTM cluster application (Unix, Linux and Windows systems).

mod1	Data structure kc_cluster_node_str
-	char node_indx[4];
x(GID)	char hostname[8];
x(GID)	struct kc_file_base filebase;
-	char bcamappl[8];
-	char port_nbr[8];
-	struct kc_admi_date_time_model kdcdef_time;
-	struct kc_admi_date_time_model startup_time;
-	struct kc_admi_date_time_model shut_n_time;
-	char start_type;
-	char node_state;
-	char monitored_node[4];
-	char monitoring_node[4];
-	struct kc_admi_date_time_model state_change_time;
x(GID)	char virtual_host[8];
-	node_name[8]
x(GID)	char hostname_long[64];
x(GID)	char virtual_host_long[64];

¹ Field content can be modified with KC_MODIFY_OBJECT , see chapter "obj_type=KC_CLUSTER_NODE"

The fields in the data structure have the following meanings:

node_indx

Number (index) of the node application in the UTM cluster application. The number is assigned internally in the cluster and is used for diagnostic purposes. The index uniquely identifies the node application within the UTM cluster application.
The node index is determined on the basis of the sequence of CLUSTER-NODE statements in the KDCDEF input: The node that is described by the first statement to occur has the index ‘1', the second '2' etc.

KC_MODIFY_OBJECT:
In order to modify the properties of a node application, you must pass the number of the node application in the identification area. You may first need to determine the number by means of a KC_GET_OBJECT call. You can only modify nodes that are not active.

hostname

Contains the primary host name of the node on which this node application is running. 
The name returned in this field may be shortened to 8 characters. The complete computer name, up to 64 characters long, is returned in the hostname_long field.

KC_MODIFY_OBJECT:
Specify the primary name of the node on which the node application is to run.

The name can be up to 8 characters in length.

filebase

Base name of the KDCFILE, the user log file and the system log file SYSLOG for the node application. When the node application is started, the UTM system files are expected under the name specified here.

The name is passed in the element filebase of type kc_file_base:

struct kc_file_base

char length[2];

char fb_name[42];

fb_name contains the base name and length the length of the base name.

KC_MODIFY_OBJECT:
You can modify the base name of the node application. When doing so, please note the following:

• The base names of the individual node applications of a UTM cluster application must differ from each other.

• Specify the directory which contains the UTM system files of the node application. The name specified here must identify the same directory for all the nodes. It may be up to 27 characters in length.

bcamappl

Name of the transport system endpoint (BCAMAPPL name) that is used for communication within the cluster. It is defined in the CLUSTER statement during generation.

port_nbr

Number of the listener port used for communication within the cluster. It is defined in the CLUSTER statement during generation.

kdcdef_time 

Time at which the KDCFILE of this node application was generated.

The date and time are returned in the element kdcdef_time of type kc_admi_date_time_model:

struct kc_admi_date_time_model

struct kc_admi_date_model admi_date;

struct kc_admi_time_model admi_time

where

struct kc_admi_date_model

char admi_day [2];

char admi_month [2];

char admi_year_4 [4];

char admi_julian_day [3];

char admi_daylight_saving_time

and

struct kc_admi_time_model

admi_hours [2];

admi_minutes [2];

admi_seconds [2]

startup_time

Time of the last start of this node application.

The date and time of the start are returned in the element startup_time of type kc_admi_date_time_model (see kdcdef_time).

shut_n_time

Time at which this node application was last terminated normally.

The date and time are returned in the element shut_n_time of type kc_admi_date_time_model (see kdcdef_time).

state_change_time;

Time of the last status change of this node application (see node_state).

The date and time are returned in the element state_change_time of type kc_admi_date_time_model (see kdcdef_time).

start_type

Type of the last start of this node application:

'C'	The last start of the application was a cold start following a normal termination of the application (COLD).
'W'	The last start of the application was a warm start following an abnormal termination of the application (WARM).
'D'	The node application was started for the first time after the generation run (DEF).
'U'	The node application was started after a KDCUPD run (UPDATE).

node_state

State of the node application:

'G' (Generated)

The node application has not yet been started after the generation run.

'R' (Running)

The node application is currently running.

'T' (Terminated)

The node application is not running. It was terminated normally.

'A' (Abnormally terminated)

The node application is not running. It was terminated abnormally.

'F' (Failure)

The node application was identified as failed by its monitoring node application.

monitored_node

Number (index) of the node application which is monitored by this node application, i.e. whose availability is cyclically checked.

monitoring_node

Number (index) of the node application which monitors the availability of this node application.

virtual_host

By specifying HOSTNAME, it is possible to specify the sender address for network connections which are established from this node application.

Blanks mean that the default sender address of the transport system is used when connections are established. This function is required in a cluster if the relocatable IP address is to be used as the sender address instead of the static IP address when establishing a connection.

The name returned in this field may be shortened to 8 characters. The complete computer name, up to 64 characters long, is returned in the virtual_host_long field.

node_name

Reference name of the node application.

Default: NODEnn
nn = 01..32, where nn is determined by the sequence of the CLUSTER-NODE statements during generation.

hostname_long

Contains the primary host name of the node on which this node application is running.

KC_MODIFY_OBJECT:
Specify the primary name of the node on which the node application is to run.

virtual_host_long

Specifying virtual_host_long enables the sender address for network connections established from this node application to be specified.

Blanks mean that the default sender address of the transport system is used for establishing connections. This function is required in a cluster if the relocatable IP address is to be used as the sender address instead of the static IP address when establishing a connection.