Previous Page Contents Page Next Page

2.16 define_cpic_side_info

The define_cpic_side_info command adds a side information entry to the configuration file or replaces an existing entry. A CPI-C side information entry associates a set of conversation characteristics with a symbolic destination name.

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

2.16.1 Supplied Parameters

Parameter name                   Type       Length       Default
[define_cpic_side_info]
sym_dest_name                    character   8
description                      character   31          (null string)
partner_lu_name                  character   17          (null string)
tp_name_type                     constant                APPLICATION_TP
tp_name                          character   64          (null string)
mode_name                        character   8           (null string)
conversation_security_type       constant                NONE
security_user_id                 character   10          (null string)
security_password                character   10          (null string)
lu_alias                         character   8           (null string)

Supplied parameters are:

sym_dest_name

Symbolic destination name that identifies the side information entry. The name can contain any displayable character.

description

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

partner_lu_name

Fully qualified name of the partner LU. Specify 3-17 type-A characters that consist of a 1-8 character network name, followed by a period, followed by a 1-8 character partner LU name.

tp_name_type

The type of the target TP (the valid characters for a TP name are determined by the TP type). Possible values are:

APPLICATION_TP

Application TP. All characters in the TP name must be valid ASCII characters.

SNA_SERVICE_TP

Service TP. The TP name must be specified as a hex array representing the 8 hexadecimal digits of a 4-character name (for example 0x21F0F0F8). The first character (represented by two hexadecimal digits) must be a hexadecimal value in the range 0x0-0x3F, excluding 0x0E and 0x0F; the remaining characters (each represented by two hexadecimal digits) must be valid EBCDIC characters.

tp_name

TP name of the target TP.

mode_name

Name of the mode used to access the target TP.

conversation_security_type

Specifies whether the target TP uses conversation security. Allowed values:

NONE

The target TP does not use conversation security.

PROGRAM

The target TP uses conversation security. The security_user_id and security_password parameters are used to access the target TP.

PROGRAM_STRONG

The target TP uses conversation security. The security_user_id and security_password parameters are used to access the target TP. However, the local node must not send the password across the network in clear text format. This option can be used only if the remote system supports password substitution.

SAME

The target TP uses conversation security and can accept an already verified indicator from the local TP. (This value indicates that the local TP was invoked by another TP, and has verified the security user ID and password supplied by this TP.) The security_user_id parameter is used to access the target TP; no password is required.

security_user_id

User ID used to access the partner TP. This parameter is not required if the conversation_security_type parameter is set to NONE.

security_password

Password used to access the partner TP. This parameter is required only if the conversation_security_type parameter is set to PROGRAM or PROGRAM_STRONG.

lu_alias

The alias of the local LU used to communicate with the target TP. This alias is a character string using any locally displayable characters.

2.16.2 Returned Parameters

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

2.16.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

INVALID_SYM_DEST_NAME

The sym_dest_name parameter contained a character that was not valid.

State Check

No specific state errors, other than those listed in Common Return Codes from snaadmin Commands, occur for this 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