Previous Page Contents Page Next Page

2.15 define_cos

The define_cos command adds a class of service (COS) definition or modifies a previously defined COS. The definition specifies TG rows and node rows, which associate a range of node and TG characteristics with weights that are used for route calculation. The lower the weight the more favorable the route.

2.15.1 Supplied Parameters

Parameter name                    Type           Length     Default
[define_cos]
cos_name                          character      8
description                       character      31         (null string)
transmission_priority             constant                  LOW 
{cos_tg_row}
min_effect_cap                    decimal                   0
min_connect_cost                  decimal                   0
min_byte_cost                     decimal                   0
min_security                      constant                  SEC_NONSECURE
min_prop_delay                    constant                  PROP_DELAY_LAN
min_user_def_parm_1               decimal                   0
min_user_def_parm_2               decimal                   0
min_user_def_parm_3               decimal                   0
max_effect_cap                    hex            1          0xFF
max_connect_cost                  decimal                   255
max_byte_cost                     decimal                   255
max_security                      constant                  SEC_GUARDED_RADIATION
max_prop_delay                    constant                  PROP_DELAY_MAXIMUM
max_user_def_parm_1               decimal                   0
max_user_def_parm_2               decimal                   0
max_user_def_parm_3               decimal                   0
weight                            decimal

(Up to eight cos_tg_row subrecords can be included, in ascending order of weight.)

{cos_node_row}
min_rar                           decimal                   0
min_status                        constant                  UNCONGESTED
max_rar                           decimal                   255
max_status                        constant                  CONGESTED
weight                            decimal

(Up to eight cos_node_row subrecords can be included, in ascending order of weight.)

Supplied parameters are:

cos_name

Class of service name. This name is a type-A character string starting with a letter.

description

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

transmission_priority

Transmission priority. Possible values are:

LOW

The session using this COS is given low priority.

MEDIUM

The session using this COS is given medium priority.

HIGH

The session using this COS is given high priority.

NETWORK

The session using this COS is given the highest priority.

The following subrecord contains additional parameters:

cos_tg_row

Each TG row contains a set of minimum TG characteristics, a set of maximum TG characteristics, and a weight. When computing the weights for a TG, its characteristics are checked against the minimum and maximum characteristics defined for each TG row. The TG is then assigned the weight of the first TG row which bounds all the TG's characteristics within the limits specified. If the TG characteristics do not satisfy any of the listed TG rows, the TG is considered unsuitable for this COS, and is assigned an infinite weight. The TG rows must be listed in ascending order of weight.

The additional parameters are:

min_effect_cap

Minimum limit for actual bits per second rate (line speed).

min_connect_cost

Minimum limit for 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.

min_byte_cost

Minimum limit for 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.

min_security

Minimum level of security. Possible values are:

SEC_NONSECURE

Data is transmitted over an unsecured network.

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.

min_prop_delay

Minimum limits for propagation delay, which is 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.

min_user_def_parm_1 through min_user_def_parm_3

Minimum limits for user-defined parameters, which you can use to include TG characteristics not covered by previously defined parameters. Each of these parameters must be set to a value in the range 0- 255.

max_effect_cap

Maximum limit for actual bits per second rate (line speed). Specify a value in the range 0-603,979,776,000.

max_connect_cost

Maximum limit for 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.

max_byte_cost

Maximum limit for 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.

max_security

Maximum level of security. Possible values are:

SEC_NONSECURE

Data is transmitted over an unsecured network.

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.

max_prop_delay

Maximum limits for propagation delay, which is 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.

max_user_def_parm_1 through max_user_def_parm_3

Maximum limits for user-defined parameters, which you can use to include TG characteristics not covered by previously described parameters. Each of these parameters must be set to a value in the range 0- 255.

weight

Weight associated with this TG row.

The following subrecord contains additional parameters:

cos_node_row

Each node row contains a set of minimum node characteristics, a set of maximum node characteristics, and a weight. When computing the weights for a node, its characteristics are checked against the minimum and maximum characteristics defined for each node row. The node is then assigned the weight of the first node row which bounds all the node's characteristics within the limits specified. If the node characteristics do not satisfy any of the listed node rows, the node is considered unsuitable for this COS, and is assigned an infinite weight. The node rows must be listed in ascending order of weight.

The additional parameters are:

min_rar

Specifies the minimum route additional resistance (RAR). Values must be in the range 0-255.

min_status

Specifies the minimum congestion status of the node. Possible values are:

UNCONGESTED

The number of ISR sessions is less than the isr_sessions_upper_threshold value in the node's configuration.

CONGESTED

The number of ISR sessions exceeds the isr_sessions_upper_threshold value.

max_rar

Specifies the maximum route additional resistance (RAR). Values must be in the range 0-255.

max_status

Specifies the maximum congestion status of the node. Possible values are:

UNCONGESTED

The number of ISR sessions is less than the isr_sessions_upper_threshold value in the node's configuration.

CONGESTED

The number of ISR sessions exceeds the isr_sessions_upper_threshold value.

weight

Weight associated with this node row.

2.15.2 Returned Parameters

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

2.15.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_COS_NAME

The cos_name parameter contained a character that was not valid.

INVALID_NUMBER_OF_NODE_ROWS

Too many node rows were specified.

INVALID_NUMBER_OF_TG_ROWS

Too many TG rows were specified.

NODE_ROW_WGT_LESS_THAN_LAST

The node rows were not listed in ascending order of weight.

TG_ROW_WGT_LESS_THAN_LAST

The TG rows were not listed in ascending order of weight.

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

COS_TABLE_FULL

You cannot define a new COS because you would exceed the maximum number of COS definitions allowed for the node (specified by the cos_cache_size parameter on the define_node 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