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 API NOF Programmer's Guide: HP-UX 11.0, 11i v1, and 11i v2 > Chapter 3 NOF API Verbs (ACTIVATE_SESSION to OPEN_FILE)

DEFINE_DSPU_TEMPLATE

» 

Technical documentation

Complete book in PDF
» Feedback
Content starts here

 » Table of Contents

 » Index

The DEFINE_DSPU_TEMPLATE verb defines a template for the downstream LUs that use the SNAplus2 PU concentration feature. This template is used to define downstream LUs on a group of downstream workstations when a workstation connects over an implicit link (a link not previously defined)..

VCB Structure

typedef struct define_dspu_template
{
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 template_name[8]; /* Name of template */
description description; /* resource description */
unsigned char modify_template; /* Modify existing template? */
unsigned char reserv1[11]; /* reserved */
AP_UINT16 max_instance; /* Max active template */
/* instances */
AP_UINT16 num_of_dslu_templates;/* number of DSLU templates*/
}DEFINE_DSPU_TEMPLATE;

typedef struct dslu_template
}
unsigned char min_nau; /* Minimum NAU address in range*/
unsigned char max_nau; /* Maximum NAU address in range*/
unsigned char allow_timeout; /* Allow timeout of host LU? */
unsigned char delayed_logon; /* Allow delayed logon to host */
/* LU */
unsigned char reserv1[8]; /* reserved */
unsigned char host_lu[8]; /* Host LU or Pool name */
}DSLU_TEMPLATE;

Supplied Parameters

The application supplies the following parameters:

opcode

AP_DEFINE_DSPU_TEMPLATE

template_name

The name of the template for downstream LUs that are present on a group of downstream workstations.

description

Resource description that is returned on the QUERY_DSPU_TEMPLATE verb.

modify_template

Specifies whether this verb should add additional DSLU templates to an existing DSPU template or should replace an existing DSPU template. Possible values are:

AP_MODIFY_DSPU_TEMPLATE

If the named DSPU template does not exist, then it is created. If the named DSPU template does exist, then appended DSLU templates are added to the existing DSPU template.

AP_REPLACE_DSPU_TEMPLATE

A new template is created, overwriting any existing definition.

max_instance

The maximum number of instances of the template that can be active concurrently. When the limit is reached, no new instances are created. Specify a value in the range 0-65,535, where 0 (zero) indicates no limit.

The subrecord dslu_template contains the following parameters:

min_nau

NAU address of the first downstream PU, in the range 1-255.

max_nau

NAU address of the last downstream PU, in the range 1-255.

allow_timeout

Specifies whether to timeout host LUs used by the downstream LU if the session is left inactive for the timeout period specified on the host LU definition. Possible values are:

AP_YES

SNAplus2 is allowed to timeout host LUs used by this downstream LU.

AP_NO

SNAplus2 is not allowed to timeout host LUs used by this downstream LU.

delayed_logon

Specifies whether to delay connecting the downstream LU to the host LU until the first data is received from the downstream LU. Possible values are:

AP_YES

SNAplus2 delays connecting the downstream LU to the host LU. A simulated logon screen is sent to the downstream LU.

AP_NO

SNAplus2 does not delay connecting the downstream LU to the host LU.

host_lu

Name of the host LU or host LU pool that the downstream LU uses. This name is an 8-byte character string.

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_TEMPLATE_NAME

The name specified for the template_name parameter was not valid.

AP_INVALID_NAU_ADDRESS

The min_nau or max_nau parameter was not valid.

AP_INVALID_NAU_RANGE

The address specified on the min_nau or max_nau parameters was not in the valid range.

AP_CLASHING_NAU_RANGE

The range of addresses specified by the min_nau parameter through the max_nau parameter in a dslu_template subrecord clashes with a range specified by another dslu_template subrecord in the template named by the template_name parameter.

AP_INVALID_NUM_DSPU_TEMPLATES

The value specified for the num_of_dslu_templates parameter was not in the valid range.

AP_INVALID_ALLOW_TIMEOUT

The value specified for the allow_timeout parameter was not valid.

AP_INVALID_DELAYED_LOGON

The value specified for the delayed_logon parameter was not valid.

AP_INVALID_MODIFY_TEMPLATE

The value specified for the modify_template 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_INVALID_HOST_LU_NAME

The specified host_lu_name parameter value was not valid.

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

Returned Parameters: Function Not Supported

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

primary_rc
AP_FUNCTION_NOT_SUPPORTED

The local node does not support PU concentration; this is defined by the pu_conc_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.