Previous Page Contents Page Next Page

2.20 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 for a local PU, or define_*_ls (for the appropriate link type) for a downstream PU.)

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

2.20.1 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
prefer_active_dlus                constant                  

Supplied parameters are:

description

A text string describing the DLUR defaults. SNAP-IX uses this string for information only. It is stored in the node's configuration file, but SNAP-IX 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 SNAP-IX 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 SNAP-IX should retry indefinitely until it contacts the DLUS.

prefer_active_dlus

Specifies how SNAP-IX operates when it receives a negative RSP(REQACTPU) from DLUS, or is attempting to reactivate a failed DLUR PU. Possible values are:

YES

If either the default primary DLUS or default backup DLUS is active, SNAP-IX will attempt to activate or reactivate the PU by using the active DLUS only.

NO

SNAP-IX will attempt to activate or reactivate the PU by using the standard retry logic.

2.20.2 Returned Parameters

No parameters are returned by SNAP-IX when this command executes successfully.

2.20.3 Error Return Codes

If the command cannot be executed, SNAP-IX 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, SNAP-IX 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 Common Return Codes from snaadmin Commands, occur for this command.

Function Not Supported

If the command does not execute because the node's configuration does not support it, SNAP-IX 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

Common Return Codes from snaadmin Commands, lists combinations of primary and secondary return codes that are common to all commands.

Previous Page Contents Page Top of Page Next page