UPDATE MSNAME command

Subsections:

• Environment
• Syntax
• Keywords
• Usage notes
• Equivalent IMS type-1 commands
• Output fields
• Return, reason, and completion codes
• Examples

Environment

The following table lists the environments (DB/DC, DBCTL, and DCCTL) from which the UPDATE MSNAME command and keywords can be issued.

Syntax

                                  .-,-----------.        
                                  V             |        
>>-+-UPDATE-+--MSNAME--+-NAME--(----+-msname--+-+--)-+---------->
   '-UPD----'          |            '-msname*-'      |   
                       '-NAME(*)---------------------'   

>--+-| A |--------+--------------------------------------------><
   +-| B |--------+   
   +-| C |--------+   
   '-| B |--| C |-'   

A

|--SET--(--+-MSLINK(new_linkname)-------+--)--------------------|
           | .-,----------------------. |      
           | V                        | |      
           '---+-SIDL(local_sysid)--+-+-'      
               '-SIDR(remote_sysid)-'          

B

             .-,--------.      
             V          |      
|--START--(----+-Q----+-+--)------------------------------------|
               '-SEND-'        

C

            .-,--------.      
            V          |      
|--STOP--(----+-Q----+-+--)-------------------------------------|
              '-SEND-'        

Keywords

The following keywords are valid for the UPDATE MSNAME command:

NAME()

Specifies the 1- to 8-character name of the MSC logical link path to be processed. You can specify wildcards (*) for the NAME keyword. NAME(*) and NAME(abc*) are examples of valid names.

SET()

Specifies the updates to attributes or parameters. You can only change attributes for statically-defined MSNAMEs. Dynamic MSNAMEs cannot be changed.

MSLINK()

Assigns the specified logical link path to the logical link for input and output purposes. Enter the 1- to 8-character name of the MSC logical link to which you want to assign this logical link path. The logical link name specified must already exist.

Both the source logical link (where the MSNAME is currently assigned) and the target logical link (where the MSNAME is being assigned to) must be stopped.

SIDL()

Specifies the system identification of a local system in a multiple system configuration. The specified value must be a number from 1 to 2036. The new specified value must be currently undefined or already defined as a local SID on this system. The SID cannot already be defined as remote.

You can change the SIDL value for only one logical link path on a command. Therefore, if you specify the SIDL parameter, you can specify only one NAME parameter.

The logical link and logical link path must be stopped to change the SIDL.

To change the SIDR or SIDL value of a logical link path:

1. Verify the existing SID values of the logical link path of either /DIS ASMT MSNAME or QUERY MSNAME SHOW(SYSID).

   For SIDL verification only, the operator must verify that the current SIDL value is not the lowest SIDL value in the system. If it is the lowest SIDL value in the system, and there are no other logical link paths in the system with the same SIDL, then the SIDL cannot be changed because the lowest SIDL in the system cannot change.

2. Verify there are no transactions with the existing SID values of either /DIS SYSID TRAN or QUERY TRAN SHOW(MSNAME).
3. If any transactions were found in step 2, assign the transactions to a new valid system of either /MSASSIGN TRAN TO MSNAME, UPDATE TRAN SET(MSNAME()) or UPDATE TRAN SET(SIDR(),SIDL()).
4. Change the SID values of the logical link path using UPDATE MSNAME SET(SIDR(),SIDL()). However, this is not allowed if the new SIDL value is lower than the current lowest SIDL in the system. The lowest SIDL in the system cannot change, and must remain the lowest SIDL in the system.

SIDR()

Specifies the system identification of a remote system in a multiple system configuration. The value specified must be a number from 1 to 2036. The new value specified must be currently undefined on this system (it cannot be already defined as remote or local).

You can change the SIDR value for only one logical link path on a command. Therefore, if you specify the SIDR parameter, you can specify only one NAME parameter.

The logical link and logical link path must be stopped to change the SIDR.

To change the SIDR or SIDL value of a logical link path:

1. Verify the existing SID values of the logical link path of either /DIS ASMT MSNAME or QUERY MSNAME SHOW(SYSID).
2. Verify there are no transactions with the existing SID values of either /DIS SYSID TRAN or QUERY TRAN SHOW(MSNAME).
3. If any transactions were found in step 2, assign the transactions to a new valid system of either /MSASSIGN TRAN TO MSNAME, UPDATE TRAN SET(MSNAME()) or UPDATE TRAN SET(SIDR(),SIDL()).
4. Change the SID values of the logical link path using UPDATE MSNAME SET(SIDR(),SIDL()).

START()

Specifies the attributes to start. You cannot specify the START and STOP parameters with the same attributes.

Q

Starts the queuing to the logical link path and starts input for the specified logical link path.

SEND

Starts the sending of messages to the specified logical link path.

STOP()

Specifies the attributes to stop. You cannot specify the START and STOP parameters with the same attributes.

Q

Stops the queuing to the logical link path and stops input for the specified logical link path.

SEND

Stops the sending of messages to the specified logical link path.

Usage notes

You can issue this command only through the Operations Manager (OM) API. This command applies to DB/DC and DCCTL systems.

The syntax for this command is defined in XML and is available to automation programs that communicate with OM.

Equivalent IMS type-1 commands

The following table shows variations of the UPDATE MSNAME command and the type-1 IMS™ commands that perform similar functions.

Output fields

Short label

Contains the short label that is generated in the XML output.

Keyword

Identifies the keyword on the command that caused the field to be generated. error appears for output fields that can appear for a non-zero completion code. N/A (not applicable) appears for output fields that are always returned.

Meaning

Provides a brief description of the output field.

Return, reason, and completion codes

The return and reason codes that can be returned as a result of the UPDATE MSNAME command are standard for all commands entered through the OM API.

The following table includes the return and reason codes and a brief explanation of the codes. The return or reason code returned for the command might also indicate an error from a CSL request.

Errors that are unique to the processing of the UPDATE MSNAME command are returned as completion codes. A completion code is returned for each action against an individual resource.