 |
» |
|
|
|
The query_cos_node_row command returns node row information for a specified
class of service (COS). This command can be used to obtain information
about a specific COS node row or about multiple COS node rows, depending
on the options used. Supplied Parameters | |
Parameter name Type Length Default
[query_cos_node_row]
num_entries decimal 1
list_options constant LIST_INCLUSIVE
cos_name character 8 (null string)
node_row_index decimal 0
|
Supplied parameters are: - num_entries
Maximum number of COS node rows for which data should
be returned. You can specify 1 to return
data for a specific COS node row, a number greater than 1 to return
data for multiple COS node rows, or 0 (zero)
to return data for all COS node rows. - list_options
The position in the list of COS node rows from which SNAplus2
begins to return data. The list is ordered by cos_name, and then by node_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 node_row_index parameters - LIST_FROM_NEXT
Start at the entry immediately following the entry specified
by the combination of the cos_name and node_row_index parameters
- cos_name
Class of service name for which node row information is
required, or the name to be used as an index into the list. This
value is ignored if list_options is set to FIRST_IN_LIST. The
name is a type-A character string starting with a letter. - node_row_index
Node row number for which information is required,
or the number to be used as an index into the list. This value is
ignored if list_options is set to FIRST_IN_LIST. Use query_cos to determine the number of node rows associated with
this COS.
Returned Parameters | |
Parameter name Type Length
cos_name character 8
node_row_index decimal
min_rar decimal
min_status constant
max_rar decimal
max_status constant
weight decimal
|
If the command executes successfully, SNAplus2 returns the
following parameters: - cos_name
Specifies the class of service (COS) name. - node_row_index
Specifies the node row index. - min_rar through weight
For more information about these parameters, see “define_cos”.
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. - INVALID_LIST_OPTION
The list_options parameter was not set to a valid value.
|
Printable version
