Command Reference Pages

This section provides information about the commands an administrator uses to perform activities with the Communications Resource Manager (CRM) to maintain Oracle Tuxedo Mainframe Adapter for SNA applications. These commands work using JCL on z/OS MVS.

This section discusses the following commands:

•

CRM

•

CRMLOGS

•

crmlkon

•

crmlkoff

•

crmchtr

•

crmdown

CRM

Launches the Communications Resource Manager.

Synopsis

CRM [ -t 0|1|2|3 ] [-p<nbr>] [-s] [-n <type>:#:#] [-u <keyfile>] [-V] <addr> <group>

Description

When you start CRM from the command line, the CRM Command Line Console puts its prompt in the window and, if exited, shuts down all of the active links.

You must configure one CRM for each Oracle Tuxedo Mainframe Adapter for SNA Gateway, as well as configure one stack for each CRM definition. Each stack can manage one or more SNA links.

CRM has two types of log files stored in $APPDIR, RSTRTLOG, and BLOBLOG. RSTRTLOG is the transaction state log used during the recovery process, while the BLOBLOG log stores session and link information. Deleting the log files requires a cold start for each link involved. You can use the CRMLOGS command to display the contents and state of the CRM log files.

Trace Options

When initiating the CRM from the UNIX command line, you can specify any of the following CRM trace levels using the -t option:

•	0 = No tracing. Setting this level effectively disables CRM tracing and closes the trace file, if there is one. If tracing is subsequently restarted, a new file is created with an incremented numerical suffix.

•	1 = Minimum tracing. At this level, CRM traces only major events and is sufficient only to determine the sequence of application conversations.

•	2 = Medium tracing. At this level, CRM also traces all I/O buffers.

•	3 = Maximum tracing. At this level, CRM also traces all APPC verbs.

The APPC Stack API trace is either enabled or disabled using the -s option of the CRM command (refer to “General Options”). If enabled, it generally shows the parameters and results of all API calls. Depending on the stack being used, other options (such as vendor-specified environment variables) may have to be activated for CRM to enable the trace.

Note:

The time tag information in the CRM trace should reflect the current system time. In order to make use of the correct time zone information on UNIX and MVS systems, it is important that the TZ environment variable be set correctly. If this variable is not set correctly on your system, refer to your system documentation for further information.

Authentication Option

-u

Establishes that process authentication is in effect for communications between the CRM and a client process.

keyfile

Is the location of a file containing a hash key known to both the CRM and the client process. The file contains a single line specifying a unique hash key (limited to eight characters). The file should be protected.

Encryption Option

-n

Establishes that encryption is in effect for this process.

type

Is the encryption type. Currently, the only valid entry is GPE (for general purpose encryption).

min

Designates the minimum number of bits to be used for encryption. These levels are used during the negotiation between the CRM and client process. Any number is acceptable, but the negotiated values resolve to 0, 56, or 128.

max

Designates the maximum number of bits to be used for encryption. These levels are used during the negotiation between the CRM and client process. Any number is acceptable, but the negotiated values resolve to 0, 56, or 128

General Options

The following parameters apply to this command:

-s

APPC Stack API trace (default none)

addr

Socket listening address (required)

//host:port group

GWSNAX Group Name (required)

Generic Resource Option

-V

Reset session affinity created by previous connection in VGR environment.

Environment Variables

You must set the following environment variables before starting the CRM:

•	From the UNIX command line:

APPDIR must be set to the application directory.

•

From MVS:

APPDIR=<High level qualifier for datasets to be created in APPDIR>

Portability

Refer to the Oracle Tuxedo Mainframe Adapter for SNA Release Notes for a list of operating systems and stacks that can communicate with the CRM.

Diagnostics

CRM exits with a return code of 0 upon successful completion.

Examples

Following is an example of the CRM command:

CRM -t 0 //myhost:5587 GROUP2 /dev/null>std.out 2>std.err &

When you start CRM from the UNIX command line, the following CRM Command Line Console appears:

$ CRM -t 0 //myhost:5587 GROUP2
BEA Tuxedo Mainframe Adapter for SNA Resource Manager started Thu Dec 11
18:40:49.098 1997
[CRM]

Console active. Enter commands
?>
da => Display active tasks
dl => Display remote links
ds => Display link statistics
dt => Display trace status
st => Start all links
sh => Stop all links and terminate
si => Terminate immediately (no quiesce)

To launch CRM with the console running in the background:

$ CRM -t 0 //myhost:5587 GROUP2 <dev/null>std.out 2>std.err &

To launch CRM with detailed tracing and APPC Stack API tracing turned on from the command line using the host/port address, type:

CRM -t 2 -s //myhost:5587

CRMLOGS

Displays the content and state of the Oracle Tuxedo Mainframe Adapter for SNA Communications Resource Manager (CRM) log files in the current directory.

Synopsis

CRMLOGS <group> [<crm name>]

Description

Use the CRMLOGS command to display the contents and state of the two CRM log files. RSTRTLOG is the transaction state log used during the recovery process and the BLOBLOG log stores session and link information. Deleting the log files requires a cold start for each link involved.

CRMLOGS requires the following parameters:

group

SNA domain group name (required)

crm name

CRM name (default CRM)

Diagnostics

CRMLOGS exits with a return code of 0 upon successful completion.

Examples

To display the RSTRTLOG log file for group2, type:

CRMLOGS GROUP2 CRM.GROUP2.RSTRTLOG

To display the BLOBLOG log file for group1, type:

CRMLOGS GROUP1 CRM.GROUP1.BLOBLOG

See Also

CRM

crmlkon

Start one or more named CRM links.

Synopsis

crmlkon -n<hostname:port> [-v -i -h -u<keyfile>] <linkname> ...

Description

crmlkon starts all of the CRM links named on the command line. This command is useful if one or more individual links failed to start when the CRM server booted. Use this command from any machine located on the same TCP/IP network as the machine running the CRM server. When used in a script, crmlkon will return 0 if the command could be sent to the target CRM. It will return 1 if the command could not be sent to the target CRM.

-n

Names the machine and port running the CRM server; indicates that the parameters immediately following are the hostname and port of the machine running the CRM where the linkname is located.

-v

Specifies verbose. Normally the command will not produce any messages, facilitating use in a script.

-i

Ignores errors. When specifying multiple links, any error encountered when issuing CRM commands will cause crmlkon to stop processing links and return. Errors can be ignored for individual links and processing continued with the next named link.

-u

Establishes that process authentication is in effect for communications between this process and the CRM.

<keyfile>

Is the location of a file containing a hash key known to both this process and the CRM. The file contains a single line specifying a unique hash key (limited to eight characters). The file should be protected.

<linkname>

Names the link to be started. This is the DM_SNALINKS entry in the DMCONFIG that defines this link. Multiple link names can be specified.

<hostname:port>

Specifies the IP host name and port of the machine running the CRM where the linkname is located.

h

Invokes a help screen that shows the syntax usage for this command.

Example

To start links link2 and cicstest owned by the CRM running on mach1 at port 5000:

crmlkon -n mach1:5000 link2 cicstest

Diagnostics

crmlkon only checks the syntax of the command. Separate facilities, either jsnacrm or mainframe-based facilities must be used to determine if the link actually became active. If the command could not be successfully sent to the CRM, crmlkon prints an error message if in verbose mode and exits with error code 1. Upon successful completion, crmlkon exits with exit code 0.

crmlkoff

Stop one or more named CRM links.

Synopsis

crmlkoff -n<hostname:port> [-v -i -h -u<keyfile>] <linkname> ...

Description

crmlkoff stops all of the CRM links named on the command line. This is useful if one or more individual links need to be stopped after the CRM server booted. It can be used from any machine located on the same TCP/IP network as the machine running the CRM server. It can be used in a script and will return 0 if the command could be sent to the target CRM. It will return 1 if the command could not be sent to the target CRM.

-n

Names the machine and port running the CRM server; indicates that the parameters immediately following are the hostname and port of the machine running the CRM where the linkname is located. This is required.

-v

Specifies verbose. Normally the command will not produce any messages, facilitating use in a script.

-i

Ignores errors. When specifying multiple links, any error encountered when issuing CRM commands will cause crmlkoff to stop processing links and return. Errors can be ignored for individual links, and processing continued with the next named link.

-u

Establishes that process authentication is in effect for communications between this process and the CRM.

<keyfile>

Is the location of a file containing a hash key known to both this process and the CRM. The file contains a single line specifying a unique hash key (limited to eight characters). The file should be protected.

<linkname>

Names the link to be stopped. This is the *DM_SNALINKS entry in the DMCONFIG which defines this link. Multiple link names can be specified.

h

Invokes a help screen that shows the syntax usage for this command.

Example

To stop links link1 and cicstest owned by the CRM running on mach at port 5000:

crmlkoff -n mach:5000 link1 cicstest

Diagnostics

crmlkoff only checks the syntax of the command. Separate facilities, either jsnacrm or mainframe based facilities, must be used to determine if the link actually became inactive. If the command could not be successfully sent to the CRM, crmlkoff prints an error message if in verbose mode and exits with error code 1. Upon successful completion, crmlkoff exits with exit code 0.

crmchtr

Dynamically change CRM trace level.

Synopsis

crmchtr -n<hostname:port> -t<trace level> [-u <keyfile>]

Description

Use the crmchtr command to dynamically change CRM trace level.

-n

Mandatory. Specifies the IP host name and port for the machine running the CRM. This is the value that was used on the CRM command line. For example, myhostmachine:5000.

-t

Mandatory. Changes CRM trace level. Values could be 0, 1, 2, or 3.

•	0 (Stop CRM Trace): Stop CRM Trace disables CRM tracing and closes the trace file, if it exists. This option is trace level 0 as described in the Trace Options section for the CRM command.

•	1 (Set Minimum CRM Trace): Set Minimum CRM Trace establishes tracing of only major events. This level is sufficient only to determine the sequence of application conversations. This option is trace level 1 as described in the Trace Options section for the CRM command.

•	2 (Set Medium CRM Trace): Set Medium CRM Trace establishes tracing of major events plus tracing of all I/O buffers. This option is trace level 2 as described in the Trace Options section for the CRM command.

•	3 (Set Maximum CRM Trace): Set Maximum CRM Trace establishes tracing of major events and all I/O buffers, plus tracing of all APPC verbs. This option is trace level 3 as described in the Trace Options section for the CRM command.

-h

Optional. Prints usage help screen.

-u

Optional. Specifies a key file containing the authentication name to be used with the CRM. For example, /secure/secret.key.

Example

To change the trace level to 2 (set medium CRM trace) by the CRM running on mach1 at port 5000, use the following command:

crmchtr -n mach1:5000 -t 2

Diagnostics

crmchtr only checks the syntax of the command. If the command could not be successfully sent to the CRM, crmchtr prints an error message and exits with error code 1. Upon successful completion, crmchtr exits with exit code 0.

crmdown

Shut down a CRM.

Synopsis

crmdown -n<hostname:port> [-v -i -h -u<keyfile>]

Description

crmdown shuts down the CRM specified on the command line. It can be used from any machine located on the same TCP/IP network as the machine running the CRM server. It can be used in a script and will return 0 if the command could be sent to the target CRM. It will return 1 if the command could not be sent to the target CRM.

-n

Names the machine and port running the CRM server.

-v

Specifies verbose. Normally the command will not produce any messages, facilitating use in a script.

-i

Ignores errors.

-u

Establishes that process authentication is in effect for communications between this process and the CRM.

<keyfile>

Is the location of a file containing a hash key known to both this process and the CRM. The file contains a single line specifying a unique hash key (limited to eight characters). The file should be protected.

Example

To stop the CRM running on mach1 at port 5000:

crmdown -n mach1:5000

Diagnostics

crmdown only checks the syntax of the command. If the command could not be successfully sent to the CRM, crmdown prints an error message if in verbose mode and exits with error code 1. Upon successful completion, crmdown exits with exit code 0.