YKSETENV command format

Business Continuity Manager Installation Guide

Version
9.8.7
File Size
1.1 MB
Audience
anonymous
Part Number
MK-95HC104-41
The following shows the formats of the YKSETENV commands. For details about command formats, see Conventions in syntax explanations.
Format
START YKSETENV,
      PARM='{YKCMDIF=[host-id]|
      YKLCNSE=[prefix1]|
      YKLCNS2=[prefix2]|
      LOGPUT=[LOGR|SAM]|
      SYSLOG=[YES|CONSOLE|NO]}[,...]'
Function
Sets the following Business Continuity Manager environment variables:
  • Host ID.
  • Prefix for the license information dataset.
  • BCM Log output method.
  • Whether or not CLI command-execution logs are output to SYSLOG or the console.
parameters
YKCMDIF=[host-id] ~ <2-digit hexadecimals> ((00 to 1F))
For the host ID, specify a value that is unique among hosts (operating systems). The specified value for the host ID is given priority over the &YKCMDIF system symbol in the IEASYMxx parmlib member. If this command is executed with the host ID omitted (PARM='YKCMDIF=' is specified), the value of the &YKCMDIF system symbol will be used.
YKLCNSE=[prefix1] ~ <8 or fewer alphanumeric characters>
Specify a prefix1 for the license information dataset so that the name of the dataset is unique. If the prefix1 is omitted, specify PARM='YKLCNSE='.

For details about the prefix1 for the license information dataset, see section Naming for license information datasets.

YKLCNS2=[prefix2] ~ <8 or fewer alphanumeric characters>
Specify a prefix2 for the license information dataset so that the name of the dataset is unique. If the prefix2 is omitted, specify PARM='YKLCNS2='.

For details about the prefix2 for the license information dataset, see section Naming for license information datasets.

LOGPUT=[LOGR|SAM]
Specify whether or not the system logger service is to be used, when outputting BCM logs.

The specified value for the LOGPUT parameter is given priority over the &YKLOGPT system symbol in the IEASYMxx parmlib member. If this command is executed with the LOGPUT parameter omitted (PARM='LOGPUT=' is specified), the value of the &YKLOGPT system symbol will be used.

LOGR: BCM logs are output using the system logger service.

SAM: BCM logs are output to sequential datasets.

SYSLOG=[YES|CONSOLE|NO]
Specify whether or not CLI command-execution logs are output to SYSLOG or the console.

The value specified for the SYSLOG parameter is given priority over the &YKSYSLG system symbol in the IEASYMxx parmlib member. If this command is executed with the SYSLOG parameter omitted (PARM='SYSLOG=' is specified), the value of the &YKSYSLG system symbol will be used.

YES: CLI command-execution logs are output to SYSLOG.

CONSOLE: CLI command-execution logs are output to the console.

NO: CLI command-execution logs are not output to SYSLOG.

For details about commands that collect CLI command-execution logs, see the Hitachi Business Continuity Manager User Guide.

Note: For the output of CLI command-execution logs in an environment where multiple versions of Business Continuity Manager exist, see Specifying whether to output the CLI command-execution logs (SYSLOG).
Return codes
Table. YKSETENV command return codes list

Return code

Meaning

0

Successful completion.

4

The specified value is incorrect. Another value was used for execution.

8

The specified value is incorrect. Processing was cancelled.

12

Processing was cancelled due to a system error (such as a GETMAIN error).

16

An internal error occurred.

Note: For parameters, you can specify multiple items within the allowable length for PARM. If more than one of the same parameter is specified, the latter one will take effect.