Previous Page Contents Page Next Page

2.14 define_cn

The define_cn command defines a connection network (also known as a virtual routing node or VRN). The command provides the network qualified name of the connection network along with its Transmission Group (TG) characteristics. Also provided is a list of the names of the local ports that can access this connection network.

This command can also be used to add new ports to an existing connection network. (Ports can be removed from an existing connection network by issuing delete_cn.)

This command is valid only at a network node or an end node, and not at a LEN node.

2.14.1 Supplied Parameters

Parameter name                    Type           Length     Default
[define_cn]
fqcn_name                         character      17
description                       character      32         (null string)
effect_cap                        decimal                   3686400
connect_cost                      decimal                   0
byte_cost                         decimal                   0
security                          constant                  SEC_NONSECURE
prop_delay                        constant                  PROP_DELAY_LAN
user_def_parm_1                   decimal                   0
user_def_parm_2                   decimal                   0
user_def_parm_3                   decimal                   0
port_name                         character      8          (null string)

(1-239 port_name entries can be included)

Supplied parameters are:

fqcn_name

Fully qualified name of the connection network. Specify 3-17 type-A characters that consist of a 1-8 character network name, followed by a period, and followed by a 1-8 character connection network name.

description

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

effect_cap

A decimal value representing the line speed in bits per second.

connect_cost

Cost per connect time. Valid values are integer values in the range 0-255, where 0 is the lowest cost per connect time and 255 is the highest cost per connect time.

byte_cost

Cost per byte. Valid values are integer values in the range 0-255, where 0 is the lowest cost per byte and 255 is the highest cost per byte.

security

Security level of the network. Possible values are:

SEC_NONSECURE

No security.

SEC_PUBLIC_SWITCHED_NETWORK

Data is transmitted over a public switched network.

SEC_UNDERGROUND_CABLE

Data is transmitted over secure underground cable.

SEC_SECURE_CONDUIT

Data is transmitted over a line in a secure conduit that is not guarded.

SEC_GUARDED_CONDUIT

Data is transmitted over a line in a conduit that is protected against physical tapping.

SEC_ENCRYPTED

Data is encrypted before transmission over the line.

SEC_GUARDED_RADIATION

Data is transmitted over a line that is protected against physical and radiation tapping.

prop_delay

Propagation delay. The time that a signal takes to travel the length of the link. Specify one of the following values, according to the type of link:

PROP_DELAY_MINIMUM

Minimum propagation delay.

PROP_DELAY_LAN

Delay is less than .5 microseconds (typical for a LAN).

PROP_DELAY_TELEPHONE

Delay is in the range .5-50 microseconds (typical for a telephone network).

PROP_DELAY_PKT_SWITCHED_NET

Delay is in the range 50-250 microseconds (typical for a packet-switched network).

PROP_DELAY_SATELLITE

Delay is greater than 250 microseconds (typical for a satellite link).

PROP_DELAY_MAXIMUM

Maximum propagation delay.

user_def_parm_1 through user_def_parm_3

User-defined parameters, which you can use to include other characteristics not covered by the previous parameters. Each of these parameters must be set to a value in the range 0-255.

port_name

Array of port names defined on the connection network. Each port name is an 8-byte string consisting of locally displayable characters that must match the name of a previously-defined port. If the fqcn_name parameter identifies an existing connection network, the new ports are added to it (without changing any ports already defined on the connection network).

2.14.2 Returned Parameters

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

2.14.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:

DEF_LINK_INVALID_SECURITY

The security parameter was not set to one of the valid values.

EXCEEDS_MAX_ALLOWED

Adding the specified ports would exceed the maximum total number of ports on a CN.

INVALID_CN_NAME

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

INVALID_PORT_NAME

One or more of the port names specified did not match the name of a defined port.

INVALID_PORT_TYPE

One or more of the specified ports cannot be on a CN because its DLC type is a point-to-point type (such as SDLC) rather than a network type.

State Check

If the command does not execute because of a state error, SNAP-IX returns the following parameters:

primary_rc

STATE_CHECK

secondary_rc

PORT_ACTIVE

The port specified by the port_name parameter cannot be modified because it is currently active.

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 is a LEN node. This command is valid only at a network node or an end node.

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