 |
» |
|
|
|
The query_cos command returns route calculation information for a specific
class of service (COS). This
command can be used to obtain information about a specific COS or
about multiple COSs, depending on the options used. Supplied Parameters | |
Parameter name Type Length Default
[query_cos]
num_entries decimal 1
list_options constant LIST_INCLUSIVE
cos_name character 8 (null string)
|
Supplied parameters are: - num_entries
Maximum number of classes of service (COSs) for which
data should be returned. You can specify 1 to return
data for a specific COS, a number greater than 1 to
return data for multiple COSs, or 0 (zero)
to return data for all COSs. - list_options
The position in the list of COSs from which SNAplus2 begins
to return data. Possible values are: - FIRST_IN_LIST
Start at the first entry in the list - LIST_INCLUSIVE
Start at the entry specified by the cos_name parameter - LIST_FROM_NEXT
Start at the entry immediately following the entry specified
by the cos_name parameter
- cos_name
COS name for which data 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.
Returned Parameters | |
Parameter name Type Length
cos_name character 8
description character 31
transmission_priority constant
num_of_node_rows decimal
num_of_tg_rows decimal
trees decimal
calcs decimal
rejs decimal
|
If the command executes successfully, SNAplus2 returns the
following parameters: - cos_name
Specifies the class of service (COS) name which
is an 8-byte character string. - description
A text string describing the COS, as specified in
the definition of the COS. - transmission_priority
Specifies the 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.
- num_of_node_rows
Number of node rows defined for this COS. - num_of_tg_rows
Number of TG rows defined for this COS. - trees
Number of route tree caches built for this COS since the
last initialization. - calcs
Number of session activation requests (and therefore route
calculations) specifying this COS. - rejs
Number of session activation requests that failed because
there was no acceptable route through the network from this node
to the named destination. A route is only acceptable if it is made
up entirely of active TGs and nodes that can provide the specified class
of service.
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.
|
Printable version
