 |
» |
|
|
 |
The query_cos_tg_row command returns TG row information for a specified class
of service (COS). This command can be used to obtain information
about a specific COS TG row or about multiple COS TG rows, depending
on the options used. The information is returned as a formatted list. To obtain
information about a specific TG row or to obtain the list information
in several rows, specify values for the tg_row_index and cos_name parameters. This returned list is ordered by the cos_name first and then by tg_row_index. The cos_name is ordered first by name length and then by ASCII lexicographical
ordering for names of the same length. The tg_row_index is ordered numerically. Supplied Parameters |  |
Parameter name Type Length Default [query_cos_tg_row] num_entries decimal 1 list_options constant LIST_INCLUSIVE cos_name character 8 (null string) tg_row_index decimal 0
|
Supplied parameters are: - num_entries
Maximum number of COS TG rows for which data should
be returned. You can specify 1 to return
data for a specific COS TG row, a number greater than 1 to return
data for multiple COS TG rows, or 0 (zero)
to return data for all COS TG rows. - list_options
The position in the list of COS TG rows from which SNAplus2
begins to return data. The list is ordered by cos_name, and then by tg_row_index, for each COS. Possible values are: - FIRST_IN_LIST
Start at the first entry in the list - LIST_INCLUSIVE
Start at the entry specified by the combination
of the cos_name and tg_row_index parameters - LIST_FROM_NEXT
Start at the entry immediately following the entry specified
by the combination of the cos_name and tg_row_index parameters
- cos_name
Class of service (COS) name for which data is required, or
the name to be used as an index into the list. The name is a type-A
character string starting with a letter. This parameter is ignored
if list_options is set to FIRST_IN_LIST. - tg_row_index
TG row number for which data is required, or the number
to be used as an index into the list. The first row has an index
of 0 (zero). This parameter is ignored if list_options is set to FIRST_IN_LIST.
Returned Parameters |  |
Parameter name Type Length cos_name character 8 tg_row_index decimal min_effect_cap hex number min_connect_cost decimal min_byte_cost decimal min_security constant min_prop_delay constant min_user_def_parm_1 decimal min_user_def_parm_2 decimal min_user_def_parm_3 decimal max_effect_cap hex number max_connect_cost decimal max_byte_cost decimal max_security constant max_prop_delay constant max_user_def_parm_1 decimal max_user_def_parm_2 decimal max_user_def_parm_3 decimal weight decimal
|
If the command executes successfully, SNAplus2 returns the
following parameters: - cos_name
Specifies the class of service (COS) name. - tg_row_index
Specifies the TG row index (the first row has an
index of zero). - min_effect_cap
Minimum limit for line speed, in bits per second. - min_connect_cost
Minimum limit for cost per connect time. - min_byte_cost
Minimum limit for 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, in microseconds.
Possible values are: - PROP_DELAY_LAN
Delay less than .5 microseconds (typical for a LAN)
or minimum propagation delay. This value is returned if the define_cos specified either PROP_DELAY_MINIMUM or PROP_DELAY_LAN. - PROP_DELAY_TELEPHONE
Delay is in the range .5-50 microseconds
(typical delay for a telephone network). - PROP_DELAY_PKT_SWITCHED_NET
Delay is in the range 50-250 microseconds
(typical delay for a packet-switched network). - PROP_DELAY_SATELLITE
Delay is greater than 250 microseconds (typical
delay 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 has a range of 0-255. - max_effect_cap
Maximum limit for line speed, in bits per second. - max_connect_cost
Maximum limit for cost per connect time. - max_byte_cost
Maximum limit for 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. - SEC_MAXIMUM
Data is transmitted over a network that has maximum security.
- max_prop_delay
Maximum limits for propagation delay, which is the time
that a signal takes to travel the length of the link, in microseconds. Possible values are: - 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 delay for a telephone network). - PROP_DELAY_PKT_SWITCHED_NET
Delay is in the range 50-250 microseconds
(typical delay for a packet-switched network). - PROP_DELAY_SATELLITE
Delay is greater than 250 microseconds (typical
delay for a satellite link), or maximum propagation delay. This
value is returned if the define_cos specified either PROP_DELAY_SATELLITE or PROP_DELAY_MAXIMUM for max_prop_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
defined parameters. Each of these parameters has a range of 0-255. - weight
Weight associated with this TG row.
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. 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_COS_NAME
The list_options parameter was set to LIST_INCLUSIVE to
list all entries starting from the supplied name, but the cos_name parameter value was not valid.
|