APCMOSI Command Syntax

Managing CMOS Processors › APCMOSI REXX Program › APCMOSI Command Syntax

APCMOSI Command Syntax

Given the HMC console command and associated parameters, APCMOSI.REX directs the request and data as specified to a designated HMC/SE for execution using the SNMP protocol.

The command has the following format:

APCMOSI 	{ACTION(hmc_command) [{additional_argument(setting) …}] |
ACTION(GetAttribute) ATTRIBUTE(attribute_name) |
ACTION(SetAttribute) ATTRIBUTE(attribute_name) VALUE(attribute_value) |
ACTION(GetStatus) }
CPC(cpc_name)
COMMUNITY(hmc_community)
[LPAR(lpar_name)]
TARGET(hmc_tcpip_address)

ACTION

Specifies the HMC command to perform.

GetAttribute is an APCMOSI supported ACTION that is not a direct console command or action specified in the HMC Console API. ACTION(GetAttribute) returns the value of a specified attribute for a specified CPC or LPAR. The value of the returned attribute appears in a text message that is written to the default output stream.

SetAttribute is an APCMOSI supported ACTION that is not a direct console command or action specified in the HMC Console API. ACTION(SetAttribute) sets the value for a specified attribute for a specified CPC or LPAR.

Note: Some attributes are read-only and therefore cannot be set.

GetStatus is an APCMOSI supported ACTION that is not a direct console command or action specified in the HMC Console API. ACTION(GetStatus) returns a status indicator for a specified CPC or LPAR. The status appears in a text message that is written to the default output stream. For descriptions of returned status, see the IBM System z Application Programming Interfaces manual (SB10-7030-11) .

For a full list of possible ACTION parameter values that are supported by the APCMOSI command, see the apcmosi.txt file found in installDir\sample\APCMOS directory. For a detailed description of the HMC command, see the IBM System z Application Programming Interfaces manual (SB10-7030-11).

Note: To simplify the APCMOSI program call, APCMOSI accepts the console command without the standard prefix or suffix. Therefore, the HMC commands as described in the IBM System z Application Programming Interfaces manual (SB10-7030-11), are listed under the full name, which includes the prefix and suffix.

For example,

ACTION(RESETNORMAL) is described under HWMCA_RESETNORMAL_COMMAND

Note: APCMOSI.REX may be customized to add support for HCM commands that are not already supported by APCMOSI or listed in the apcmosi.txt file.

[{additional_argument(setting) …}]

Specifies additional command arguments and their settings, if required, associated with the command specified by the ACTION parameter. For a list of possible additional argument values that are supported by the APCMOSI command for ACTION specified, reference the apcmosi.txt file found in installDir\sample\APCMOS directory. For a detailed description of command arguments applicable to the specified action, see the IBM System z Application Programming Interfaces manual (SB10-7030-11).

ATTRIBUTE

Specifies the name of the attribute that is subject to either the SetAttribute or the GetAttribute action. Forr the names of attributes that can be retrieved or set, see the IBM System z Application Programming Interfaces manual (SB10-7030-11).

Note: To simplify the APCMOSI program call, APCMOSI accepts attribute names with or without the prefix and suffix.

For example,

ATTRIBUTE(weight) is equivalent to ATTRIBUTE(hwmca_weight_suffix)

COMMUNITY

Specifies the community name of the HMC/SE workstation to which the HMC command specified in ACTION parameter is directed.

Note: This value is case sensitive.

CPC

Specifies the name of the Central Processing Complex (CPC) to which the HMC command specified in ACTION parameter is directed.

LPAR

Specifies the name of the Logical Partition (LPAR) within a given CPC where each partition supports one copy of the z/OS or other operating system to which the HMC command specified in ACTION is directed.

TARGET

Specifies the TCP/IP address of the HMC/SE workstation to which the HMC command specified in ACTION parameter is directed.

VALUE

Specifies the value the SetAttribute action sets for a specified attribute.

Follow these rules when invoking the APCMOSI command:

Keywords and values are not case-sensitive.
Parameters shown in brackets ([ ]) are optional.
Parameter names can be abbreviated to the minimum number of characters that will uniquely identify the parameter. For example, if LPAR and CPC are the only required parameters, you can specify L(lpar1) and C(cpc1) in place of LPAR (lpar1) and CPC(cpc1). However if Action and ActivationProfile are allowable parameters, you must specify at least ACTIO(pswrestart) and ACTIV(activation-profile-name).
There are no default values for the parameters. The APCMOSI.REX program can be customized to set default values for parameters. If you set default values within the APCMOSI.REX program, you do not have to specify the parameter when invoking the APCMOSI command. However, you can still override the default values by specifying the parameter with overriding value. For example, if you have only one HMC/SE workstation or CPC, setting default values for Community, CPC, and Target parameters in APCMOSI.REX will simplify required parameter settings for APCMOSI program call to just the ACTION parameter.