define_dlur_defaults

The define_dlur_defaults command defines a default Dependent LU Server (DLUS) and a backup default DLUS. If a default DLUS or backup default DLUS is already defined, the command overrides the existing definition. DLUR uses the default DLUS name when it initiates SSCP-PU activation for PUs that do not have an explicitly specified associated DLUS. (To define a PU and its associated DLUS, use define_internal_pu .)

The command can also be used to revoke a default DLUS or backup default DLUS, so that one is not defined.

Supplied Parameters

Parameter name             Type              Length       Default
[define_dlur_defaults]
description                character         31           (null string)
dlus_name                  character         17
bkup_dlus_name             character         17           (null string) 
dlus_retry_timeout         decimal                        5 
dlus_retry_limit           decimal                        3

Supplied parameters are:

description

A text string describing the DLUR defaults. SNAplus2 uses this string for information only. It is stored in the node's configuration file, but SNAplus2 does not make any other use of it.

dlus_name

Name of the DLUS node that is to be the default. Specify 3-17 type-A characters that consist of a 1-8 character network name, followed by a period, followed by a 1-8 character DLUS node name. To revoke the current default DLUS, so that no default DLUS is defined, do not specify this parameter.

bkup_dlus_name

Name of the DLUS node that is to serve as the backup default. Specify 3-17 type-A characters that consist of a 1-8 character network name, followed by a period, followed by a 1-8 character backup DLUS node name. To revoke the current backup default DLUS, so that no backup default DLUS is defined, do not specify this parameter.

dlus_retry_timeout

The interval in seconds between the second and subsequent attempts to contact the DLUS specified by the dlus_name and bkup_dlus_name parameters. The interval between the first and second attempts is always 1 second.

Specify a value in the range 1- 65,535.

dlus_retry_limit

Retry count for contacting a DLUS. This parameter is used to specify the number of times SNAplus2 should retry if it fails to contact the DLUS on the first attempt.

Specify a value in the range 1-65,534, or specify 65,535 to indicate that SNAplus2 should retry indefinitely until it contacts the DLUS.

Returned Parameters

No parameters are returned by SNAplus2 when this command executes successfully.

Error Return Codes

If the command cannot be executed, SNAplus2 returns a primary return code to indicate the type of error and a secondary return code to provide specific details about the reason for unsuccessful execution.

Parameter Check

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

primary_rc

PARAMETER_CHECK

secondary_rc

Possible values are:

INVALID_DLUS_NAME: The supplied dlus_name parameter contained a character that was not valid or was not in the correct format.
INVALID_BKUP_DLUS_NAME: The supplied bkup_dlus_name parameter contained a character that was not valid or was not in the correct format.

State Check

No specific state errors, other than those listed in Appendix A “Common Return Codes from snapadmin Commands” occur for this command.

Function Not Supported

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

primary_rc

FUNCTION_NOT_SUPPORTED: The local node does not support DLUR; this support is defined by the dlur_support parameter on the define_node command.

secondary_rc

(This parameter is not used.)

Other Conditions

Appendix A “Common Return Codes from snapadmin Commands” lists combinations of primary and secondary return codes that are common to all commands.