Previous Page Contents Page Next Page

2.11 define_channel_dlc

The define_channel_dlc command defines a new channel DLC. This command can also be used to modify an existing DLC, if the DLC is not currently active.

2.11.1 Supplied Parameters

Parameter                         Type           Length     Default
[define_channel_dlc]
dlc_name                          character      8
description                       character      32         (null string)
initially_active                  constant                  YES

Supplied parameters are:

dlc_name

Name of the DLC. This name is a character string using any locally displayable characters.

description

A text string describing the DLC. SNAP-IX uses this string for information only. It is stored in the node's configuration file and returned on the query_dlc command.

initially_active

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

YES

The DLC is automatically started when the node is started.

NO

The DLC is automatically started only if a port or LS that uses it is defined to be initially active; otherwise, it must be manually started.

2.11.2 Returned Parameters

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

2.11.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_DLC_NAME

The supplied dlc_name parameter contained a character that was not valid.

State Check

No specific state errors, other than those listed in Common Return Codes from snaadmin Commands, occur for this command.

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