query_cpic_side

The query_cpic_side_info command returns the side information entry for a given symbolic destination name or for multiple symbolic destination names, depending on the options used.

Because CPI-C side information entries are defined as domain resources, this command is not associated with a particular node.

Supplied Parameters

Parameter name          Type        Length    Default
[query_cpic_side_info]
num_entries             decimal               1
list_options            constant              LIST_INCLUSIVE 
sym_dest_name           character   8         (null string)

Supplied parameters are:

num_entries

Maximum number of symbolic destination names for which data should be returned. You can specify 1 to return data for a specific symbolic destination name, a number greater than 1 to return data for multiple symbolic destination names, or 0 (zero) to return data for all symbolic destination names.

list_options

The position in the list of symbolic destination names 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 sym_dest_name parameter
LIST_FROM_NEXT: Start at the entry immediately following the entry specified by the sym_dest_name parameter

sym_dest_name

Symbolic destination name for which data is required, or the name to be used as an index into the list. Valid characters are uppercase A-Z and numerals 0-9. This value is ignored if list_options is set to FIRST_IN_LIST.

Returned Parameters

Parameter name                 Type             Length
sym_dest_name                  character        8 
description                    character        31 
partner_lu_name                character        17 
tp_name_type                   constant
tp_name                        character        64
mode_name                      character        8
conversation_security_type     constant
security_user_id               character        10 
security_password              character        10
lu_alias                       character        8

If the command executes successfully, SNAplus2 returns the following parameters:

sym_dest_name: Symbolic destination name for the returned side information entry.
description: A text string describing the side information entry, as specified in the definition of the side information entry.
partner_lu_name through lu_alias: For more information about these parameters, see “define_cpic_side_info”.

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.

Parameter Check

No parameter errors occur for this command.

State Check

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

primary_rc

STATE_CHECK

secondary_rc

INVALID_SYM_DEST_NAME: The list_options parameter was set to LIST_INCLUSIVE to list all entries starting from the supplied name, but the sym_dest_name parameter value was not valid.

Other Conditions

Appendix A “Common Return Codes from snapadmin Commands” lists combinations of primary and secondary return codes that are common to all commands.

query_cpic_side_info

Technical documentation

» Table of Contents