UPDATE MSPLINK 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 MSPLINK command and keywords can be issued.

Syntax

                                .-,----------------.       
                                V                  |       
>>-+-UPDATE-+--MSPLINK--+-NAME(---+-msplinkname--+-+-)-+-------->
   '-UPD----'           |         '-msplinkname*-'     |   
                        '-NAME(*)----------------------'   

>--+-START(-+-LOGON----------+-)--------------------------+----><
   |        +-GENLOGON-------+                            |   
   |        '-LOGON,GENLOGON-'                            |   
   +-STOP(-+-LOGON----------+-)---------------------------+   
   |       +-GENLOGON-------+                             |   
   |       '-LOGON,GENLOGON-'                             |   
   |      .-,-----------------------------------------.   |   
   |      V                                           |   |   
   '-SET(---+-ASR(-+-ON--+-)------------------------+-+-)-'   
            |      '-OFF-'                          |         
            +-ICONPLKID(TCPIP_IMS_Connect_LCLPLKID)-+         
            +-IMSCON(TCPIP_local_IMS_Connect)-------+         
            +-MODETBL(-+---------------+-)----------+         
            |          '-modetablename-'            |         
            +-MSPLINK(new_msplinkname)--------------+         
            +-NODE(VTAM_node_name)------------------+         
            '-RMTIMS(TCPIP_remote_IMS_ID)-----------'         

Keywords

The following keywords are valid for the UPDATE MSPLINK command:

NAME()

Specifies the 1- to 8-character name of the MSC physical link that is processed. You can specify wildcards (*) in the name. NAME(*) and NAME(abc*) are examples of valid names.

SET()

Specifies the attribute values to be updated or sets the resource state.

ASR(), MODETBL() and NODE() are VTAM® link specific parameters.

ASR()

The Automatic Session Restart (ASR) designation for each logical link assigned to the specified VTAM physical link changes when the Session Outage Notification facility of VTAM is used. The ASR parameter allows you to override the system definition option that is defined for the automatic session restart designation of a link.

You cannot change the designation of ASR for non-VTAM MSC links.

Stop the physical link and each assigned logical link before you change the ASR designation.

ON

Specifies that the logical link uses automatic session restart. Automatic session restart is not necessarily activated for a link if a status of ASR is displayed for that link. SONSCIP=YES must also be specified on the APPL definition statement for VTAM when defining the network to VTAM. ASR works only if both sides of the link use the ASR option.

OFF

Specifies that the logical link does not use automatic session restart.

ICONPLKID()

For TCP/IP physical links, defines a 1- to 8-character alphanumeric ID by which IMS™ Connect knows the MSC physical link. This ID must match the ID defined to IMS Connect on the LCLPLKID parameter of the MSC configuration statement that defines the physical link to IMS Connect.

You can use the ICONPLKID keyword to modify the MSC physical link to reference a different IMS Connect MSC configuration statement.

This ID can also be specified on the LCLPLKID keyword of the MSPLINK macro.

IMSCON()

For TCP/IP physical links, specifies the IMSplex name of the local IMS Connect instance that manages the TCP/IP connections for this physical link. IMSCON accepts a 1- to 8- alphanumeric value.

You can use the IMSCON keyword to switch the IMS Connect instance that an MSC physical link uses.

MODETBL()

Changes the name of the default VTAM logon mode table entry (logon mode table) for this physical link. This changes the name for each logical link currently assigned to this physical link. This name is usually established by system definition. To reset this field to its null state (as if no mode table name was specified at system definition), specify MODETBL().

You cannot use the SET(MODETBL) parameter for a non-VTAM MSC link.

The physical link and each assigned logical link must be stopped before changing the MODETBL.

MSPLINK()

Specifies the 1- to 8-alphanumeric new physical link name for this physical link. This keyword also allows you to change the name of a reserved link to a real name and activate it. The name specified in MSPLINK() must be unique. If the command is successful, the old physical link name specified on the NAME keyword is no longer valid.

Only one NAME parameter can be specified to change the MSPLINK name.

The physical link must be stopped before changing the MSPLINK.

NODE()

Specifies a 1- to 8-alphanumeric name for the remote VTAM node (APPLID) name for the VTAM line. This node is the VTAM node name of the remote IMS system at the other end of the link. This node is the label on the VTAM APPL statement for the remote IMS system. For an MSC VTAM link communicating with an XRF complex, the node name must be the VTAM USERVAR that is associated with the partner XRF complex.

The physical link and each assigned logical link must be stopped before changing the NODE.

RMTIMS()

For TCP/IP physical links, defines the remote IMS system that this physical link connects to. Enter the 1- to 8- alphanumeric IMSID of the remote IMS system.

You can use the RMTIMS keyword to change the remote IMS system that an MSC physical link references.

START()

Specifies the attributes to start.

GENLOGON

For IMS systems that participate in a TCP/IP generic resource group, enables the IMS systems that process this command to resume accepting logical link connection requests to the generic resource group on the specified physical link.

START(GENLOGON) is independent of LOGON, which is used for links that do not use the TCP/IP generic resource group. If STOP(LOGON) has been previously issued, you must issue START(LOGON), either separately or with the GENLOGON parameter, before the IMS system can resume starting and accepting logical links that do not use TCP/IP generic resources.

LOGON

For MSC TCP/IP and VTAM physical link types only. For TCP/IP-type links, START(LOGON) allows the starting of the logical links assigned to the physical link. For VTAM-type links, START(LOGON) enables logical links to logon to the physical link. START(LOGON) and STOP(LOGON) are mutually exclusive.

START(LOGON) is independent of GENLOGON, which is used for links that use a TCP/IP generic resource group. If STOP(GENLOGON) has been previously issued, you must issue START(GENLOGON), either separately or with the LOGON parameter, before the IMS system can resume starting and accepting logical links that use TCP/IP generic resources.

STOP()

Specifies the attributes to stop.

GENLOGON

For IMS systems that participate in a TCP/IP generic resource group, prevents the IMS systems that process this command from either starting or accepting the specified TCP/IP physical link.

The STOP(GENLOGON) keyword is applicable only to TCP/IP-type physical links that are defined in IMS systems that participate in a TCP/IP generic resource group.

The STOP(GENLOGON) does not affect links that are already in session.

Use STOP(GENLOGON) to control where the restart message from a remote link restart is accepted within the local IMSplex. Issue STOP(GENLOGON) against every IMS system in the TCP/IP generic resource group, except the IMS system with which you need to establish link affinity.

After an UPDATE MSPLINK NAME(plnkname) STOP(GENLOGON) command is issued, the QUERY MSPLINK command displays a local status of STOGENLGN.

STOP(GENLOGON) does not prevent the IMS system from accepting links that do not use the generic resource group. GENLOGON is independent of LOGON and both can be specified together on the STOP() keyword to prevent the IMS system from starting or accepting all links, regardless of whether they use TCP/IP generic resources.

LOGON

For MSC TCP/IP and VTAM physical link types only.

For TCP/IP links, STOP(LOGON) prevents the IMS systems that process this command from starting of the physical link or accepting start requests for the physical link from a link partner. The LOGON keyword does not affect TCP/IP physical links that are used for TCP/IP generic resources.

The LOGON keyword is independent of the GENLOGON keyword that is used for physical links that are used with TCP/IP generic resources. Both keywords can be specified together on the STOP() keyword to prevent the IMS system from starting or accepting all links, regardless of whether they use TCP/IP generic resources.

For VTAM links, STOP(LOGON) prevents logons to the physical link. START(LOGON) and STOP(LOGON) are mutually exclusive.

After an UPDATE MSPLINK NAME(plnkname) STOP(LOGON) command is issued, the QUERY MSPLINK command displays a local status of STOLGN.

The STOP(LOGON) does not affect links that are already in session.

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 MSPLINK 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 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 MSPLINK 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 this command are returned as completion codes. A completion code is returned for each action against an individual resource.