Limited supportBMC provides limited support for this version of the product. As a result, BMC no longer accepts comments in this space. If you encounter problems with the product version or the space, contact BMC Support.BMC recommends upgrading to the latest version of the product. To see documentation for that version, see BMC AMI Datastream for z/OS 7.1.

START command

The START command (S) initiates BMC AMI Defender for z/OS as a started task.

The following diagram shows the syntax of the START command:

STARTzos_spe2101.png

For information about traceSpecification, see Using-the-TRACE-facility.

Note

One or more blanks are required after START or S and before czagentName or taskName, but there must be no embedded blanks before, between or within the optional parameters.

Statement parameter

START uses the following parameters:

Parameter

Description

czagentName | taskName

Name of the BMC AMI Defender job or started task specified on the START command or in the JCL

For a description of how this name is determined and specified, see "MODIFY command" in the "MVS system commands reference" section on the IBM Knowledge Center website.

This parameter is required.

DEFINES=CZDEFINE | primeFieldDefFile

Name of the primary, field definitions file

The field definitions file is an input file. The * (SYSOUT) specification is invalid, and output variable symbols are not supported. For more information about field definition files, see Defining-fields.

If you omit DEFINES, the default CZDEFINE, defined in the CZAPARMS DD statement, is used.

INSTALL=WARM | FORCE | COLD

Type of restart that BMC AMI Defender will attempt if requred

Parameter

Description

BMC AMI Defender attempts to start normally. If it finds a duplicate instance name and the duplicate is not running, BMC AMI Defender attempts to warm start the instance and continue processing any records on the existing queue.

Note

 A warm start might fail if you attempt it with a version other than BMC AMI Defender 6.1.

If a warm start fails, an INSTALL=FORCE might be required.

FORCE | COLD

Use with extreme caution and only after an unrecoverable failure (see Restarting zDefender after an Unrecoverable Failure), or as directed by BMC Support.

INSTALL=FORCE is invalid with INSTANCE=*; you must specify an explicit instance number. If BMC AMI Defender is already running as the specified INSTANCE, using FORCE might cause unpredictable problems.

If you need to use FORCE, you might need to run it several times to enable BMC AMI Defender to resolve the errors that required FORCE. If BMC AMI Defender encounters an error the first time that FORCE is used, it reports the error, attempts to resolve it, and then terminates with an error message. If you then attempt FORCE again, you might succeed because the error was resolved in the first attempt. So if FORCE fails, you should try it two or three times. A different error message appears for each subsequent failure. If you have two failures with the same error message, contact BMC Support.

(SPE2101)You can use COLD instead of FORCE. The parameters function the same.

(SPE2101) If you omit INSTALL, the default WARM is used.

INSTANCE=instanceNumber | *

Specifies a BMC AMI Defender instance number between 0 and 7 inclusive, or * (asterisk) to use the next available instance number. The use of the default, * (an asterisk) is generally recommended. Instances allow you to start more than one copy of BMC AMI Defender in a single LPAR. The multiple instances run completely independently and could specify different SIEM collectors, different SMF records, different formatting options, and so forth. If you specify the number of an instance that is already running you receive an error message.

If you omit INSTANCE, the default * (the next available instance number) is used.

LEOPTS=CZALEOPT | leOptionsMember

Specifies the name of a member in the amihlq.CZAGENT.CNTL data set that contains overriding z/OS Language Environment (LE) options. See Language Environment Options in Configuring-SMF-and-other-IBM-z-OS-subsystems. Generally, you should use this parameter only as directed by BMC Support.

If you omit this parameter, the default CZALEOPT is used.

PARMS=CZAPARMS | primaryParmFile

Specifies the name of the primary parameter file. As the parameter file is an input file, a specification of * (SYSOUT) is invalid, and the output variable symbols are not supported. The default PDS(E) is DD:CZAPARMS, that is, the library specified by the CZAPARMS DD statement.

If you omit PARMS, the default CZAPARMS is used.

SET='SSID(ssid)'

Specifies a single SSID for the SMF DAM or SMF DB2 parameter. The variable symbol &SSID. (note terminating period) might be used as the operand of SMF DAM or DB2 SSIDs() and the operand is processed as though ssid had been coded.

This option is intended especially for use with BMC AMI Defender for Db2.

SWITCH='configName,...'

Specifies the name of one or more custom configurations

You can use custom configurations members to perform specialized tasks. Configurations specified here override the default configuration.

TRACE='traceSpecification'

Specifies that BMC AMI Defender is to output additional diagnostic messages and the types of diagnostic messages, in the CZAPRINT data set. TRACE might be useful for diagnosing certain problems. If TRACE is completely omitted then all tracing is turned off.

Specify zero or more of the trace types described in section Using-the-TRACE-facility (in any order). Prefix any of the specifications with - (a minus sign or hyphen) to indicate negation. The specifications are processed left to right. For instance, TRACE(ALL –XL –ENV) indicates all TRACE output except what is related to translation and the operating environment.

TYPERun=SCANonly

(Applies to BMC AMI Defender for z/OS only) Specifies that BMC AMI Defender is to scan the field definition and parameter files and log any errors, and then terminate. TYPERun=SCANonly might be useful for validating parameter file changes before putting them into production.

Initialization (START) responses

The CZA0201I message displays the precise version information for BMC AMI Defender.

The CZA0205I message indicates successful initialization, the instance name, and that the product is ready to forward syslog messages.

For more details, see Messages CZA0200 through CZA0299.

Related topics

Parameter-file-statements

Command-and-syntax-reference


 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*