Jump to content United States-English
HP.com Home Products and Services Support and Drivers Solutions How to Buy
» Contact HP
More options
HP.com home
HP-UX SNAplus2 NOF Programmers Guide: HP-UX 11i > Chapter 3 NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE)

DEFINE_INTERNAL_PU

» 

Technical documentation

Complete book in PDF
» Feedback
Content starts here

 » Table of Contents

 » Index

The DEFINE_INTERNAL_PU verb defines a PU on the local node that is served by DLUR. (To define a downstream PU served by PU concentration or to define a local PU that is directly attached to the host, use DEFINE_LS instead of DEFINE_INTERNAL_PU.)

VCB Structure

typedef struct define_internal_pu
{
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 pu_name[8]; /* internal PU name */
INTERNAL_PU_DEF_DATA def_data; /* defined data */
} DEFINE_INTERNAL_PU;
typedef struct internal_pu_def_data
{
unsigned char description[32]; /* resource description */
unsigned char initially_active; /* is PU initially active? */
unsigned char reserv1[15]; /* reserved */
unsigned char dlus_name[17]; /* DLUS name */
unsigned char bkup_dlus_name[17]; /* backup DLUS name */
unsigned char pu_id[4]; /* PU identifier */
AP_UINT16 dlus_retry_timeout; /* DLUS retry timeout */
AP_UINT16 dlus_retry_limit; /* DLUS retry limit */
unsigned char reserv2[4]; /* reserved */
} INTERNAL_PU_DEF_DATA;

Supplied Parameters

The application supplies the following parameters:

opcode

AP_DEFINE_INTERNAL_PU

pu_name

Name of the internal PU that is being defined. This is a type-A EBCDIC string (starting with a letter), padded on the right with EBCDIC spaces.

def_data.description

A null-terminated text string (0-31 characters followed by a null character) describing the internal PU. This string is for information only; it is stored in the node's configuration file and returned on the QUERY_DLUR_PU and QUERY_PU verbs, but SNAplus2 does not make any other use of it.

def_data.initially_active

Specifies whether this internal PU is automatically started when the node is started. Possible values are:

AP_YES

The PU is automatically started when the node is started.

AP_NO

The PU is not automatically started; it must be started manually.

def_data.dlus_name

Name of DLUS node which DLUR will use when it initiates SSCP-PU activation. The name is a 17-byte EBCDIC string, right-padded with EBCDIC spaces. It consists of a network ID of up to 8 A-string characters, an EBCDIC dot (period) character, and a network name of up to 8 A-string characters.

To indicate that DLUR should use the global default DLUS, set this parameter to 17 binary zeros. In this case, you must also use DEFINE_DLUR_DEFAULTS to define the global default DLUS.

def_data.bkup_dlus_name

Name of DLUS node which will serve as the backup DLUS for this PU. The name is a 17-byte EBCDIC string, right-padded with EBCDIC spaces. It consists of a network ID of up to 8 A-string characters, an EBCDIC dot (period) character, and a network name of up to 8 A-string characters.

To indicate that DLUR should use the global backup default DLUS, set this parameter to 17 binary zeros. In this case, you must also use DEFINE_DLUR_DEFAULTS to define the global backup default DLUS.

def_data.pu_id

PU identifier. This is a 4-byte hexadecimal string, consisting of a block number (3 hexadecimal digits) and a node number (5 hexadecimal digits). The PU ID must match the pu_id configured at the host.

def_data.dlus_retry_timeout

Reactivation timer for contacting a DLUS. If SNAplus2 fails to contact the DLUS, this parameter specifies the time in seconds between retries.

Specify a value in the range 0x0001-0xFFFF.

def_data.dlus_retry_limit

The interval in seconds between the second and subsequent attempts to contact the DLUS specified by the def_data.dlus_name and def_data.bkup_dlus_name parameters. The interval between the first and second attempts is always 1 second. If zero is specified, then the defaults specified using the DEFINE_DLUR_DEFAULTS verb are used. .

Returned Parameters: Successful Execution

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

primary_rc

AP_OK

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

Possible values are:

AP_INVALID_PU_NAME

The pu_name parameter contained a character that was not valid.

AP_INVALID_PU_ID

The pu_id parameter contained a character that was not valid.

AP_INVALID_DLUS_NAME

The dlus_name parameter contained a character that was not valid or was not in the correct format.

AP_INVALID_BKUP_DLUS_NAME

The bkup_dlus_name parameter contained a character that was not valid or was not in the correct format.

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
AP_PU_ALREADY_DEFINED

A PU with the specified name has already been defined.

Returned Parameters: Function Not Supported

If the verb does not execute because the node's configuration does not support it, SNAplus2 returns the following parameter:

primary_rc
AP_FUNCTION_NOT_SUPPORTED

The node does not support DLUR; this is defined by the dlur_supported parameter on the DEFINE_NODE verb.

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.

Printable version
Privacy statement Using this site means you accept its terms Feedback to webmaster
© 2003 Hewlett-Packard Development Company, L.P.