CONNECT_NODE

An application uses this verb in order to establish communications with a SNAplus2 node (active or inactive). The verb returns a handle identifying the node, which the application can then use on other NOF verbs to indicate the target for the verb. The application should always issue DISCONNECT_NODE for any open node handles before it exits.

The CONNECT_NODE verb can also be issued on a HP-UX client computer as well as on a server; this allows you to use SET_CS_TRACE, QUERY_CS_TRACE, SET_TRACE_FILE, and QUERY_TRACE_FILE to control client-server tracing for the client. See the descriptions of these verbs for more information. No other NOF verbs can be issued to client computers.

VCB Structure

typedef struct connect_node
{
      AP_UINT16         opcode;           /* verb operation code             */
      unsigned char     reserv2;          /* reserved                        */
      unsigned char     format;           /* reserved                        */
      AP_UINT16         primary_rc;       /* primary return code             */
      AP_UINT32         secondary_rc;     /* secondary return code           */
      unsigned char     node_type;        /* which node to connect to        */
      unsigned char     node_name[64];    /* name of Node                    */
      AP_UINT32         target_handle;    /* handle for subsequent verbs     */
      unsigned char     node_status;      /* node status                     */
 } CONNECT_NODE;

Supplied Parameters

The application supplies the following parameters:

opcode

AP_CONNECT_NODE

node_type

To connect to a particular node in order to manage the node's configuration, set this parameter to AP_SPECIFIED_NODE.

To connect to the node currently acting as the central logger, set this parameter to AP_CENTRAL_LOGGER. This value is required if the application will be issuing the following verbs:

SET_CENTRAL_LOGGING, QUERY_CENTRAL_LOGGING
SET_GLOBAL_LOG_TYPE, QUERY_GLOBAL_LOG_TYPE
SET_LOG_FILE, QUERY_LOG_FILE (if central logging is in use)

node_name

Name of the SNAplus2 node to connect to. This parameter is reserved if node_type is set to AP_CENTRAL_LOGGER.

If SNAplus2 is running with all components on a single computer, you can set this parameter to all binary zeros; there is no need to specify the node name. Otherwise, setting this parameter to all binary zeros indicates the default local node (on the same SNAplus2 server as the application).

To connect to a HP-UX client in order to control client-server tracing, set this parameter to all binary zeros. The NOF application must be running on the client computer.

Returned Parameters: Successful Execution

If the verb executes successfully, SNAplus2 returns the following parameters:

primary_rc

AP_OK

secondary_rc

Not used.

target_handle

Returned value for use on subsequent verbs.

node_status

Specifies the status of the node. Possible values are:

AP_NDE_STARTING: The node is in the process of being activated.
AP_NDE_STARTED: The node is active.
AP_NDE_STOPPING: The node is in the process of being deactivated.
AP_NDE_STOPPED: The node is not active.

Returned Parameters: Parameter Check

If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters:

primary_rc

AP_PARAMETER_CHECK

secondary_rc

AP_INVALID_NODE_NAME: The value that was specified for the node_name parameter was not valid.

Appendix A “Common Return Codes” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs.

Returned Parameters: State Check

If the verb does not execute because of a state error, SNAplus2 returns the following parameters:

primary_rc

AP_STATE_CHECK

secondary_rc

Possible values are:

AP_CONNECTION_NOT_MADE: An error occurred in connecting to the node.
AP_INVALID_VERSION: The application could not connect to the node, because there was a version mismatch between the SNAplus2 software on the computer where the application is running and the computer where the target node is defined. If you are in the process of upgrading the network, so that different computers are running different levels of the SNAplus2 software, nodes running on the back-level software can be managed only by applications running on the back-level software.

Appendix A “Common Return Codes” lists further secondary return codes associated with AP_STATE_CHECK, which are common to all NOF verbs.

Returned Parameters: Other Conditions

Appendix A “Common Return Codes” lists further combinations of primary and secondary return codes that are common to all NOF verbs.

CONNECT_NODE

Technical documentation

» Table of Contents

» Index

VCB Structure

Supplied Parameters

Returned Parameters: Successful Execution

Returned Parameters: Parameter Check

Returned Parameters: State Check

Returned Parameters: Other Conditions