Shared nested objects
Some of the Core API objects share common nested objects and are documented here for ease of reference.
Field name | Type | Description |
---|---|---|
actions | Array of action objects | An optional array of pending action objects. This field is not provided when the EC MCL information pertains to the HMC. When the EC MCL information pertains to an SE, this field is only provided when the HMC is communicating with the CPC's SE, and this field will be null if the information is currently unavailable or there are no pending actions. |
ec | Array of ec objects | An optional array of EC objects. When the EC MCL information pertains to an SE, this field is only provided when the HMC is communicating with the CPC's SE, and this field will be null if the information is currently unavailable. |
lic-control-level | String (1-4) or String Enum | An optional field containing the Licensed Internal Code control level or a
string enumeration value indicating this information is not available. The possible string
enumeration values are:
When the EC MCL information pertains to an SE, this information can only be retrieved when the HMC is communicating with the CPC's SE; therefore, this field will be null if the information could not be retrieved. |
driver-level | String (1-4) or String Enum | An optional field containing the driver level of the installed code or a
string enumeration value containing information about why this information is not available. The
possible string enumeration values are:
When the EC MCL information pertains to a CPC, this information can only be retrieved when the HMC is communicating with the CPC's SE; therefore, this field will be null if the information could not be retrieved. |
bundle-level | String (1-4) or String Enum | An optional field containing the bundle level of the installed code or a
string enumeration value indicating this information is not available. The possible string
enumeration values are:
When the EC MCL information pertains to an CPC, this information can only be retrieved when the HMC is communicating with the CPC's SE; therefore, this field will be null if the information could not be retrieved. |
arom-info | String Enum | An optional field indicating if the system was loaded with a CDU (Concurrent
Driver Upgrade) EC AROM in the form of a string enumeration value. The possible string enumeration
values are:
When the EC MCL information pertains to an CPC, this information can only be retrieved when the HMC is communicating with the CPC's SE; therefore, this field will be null if the information could not be retrieved. |
Field name | Type | Description |
---|---|---|
type | String Enum | One of:
|
activation | String Enum | One of:
|
pending | Boolean | Is the action pending (true) or not pending (false) |
Field name | Type | Description |
---|---|---|
number | String (1-6) | Engineering Change stream identifier. |
part-number | String (1-8) | Engineering Change stream part number. |
type | String (1-32) | Engineering Change stream name. |
description | String (1-65) | Engineering Change stream descriptive text. |
mcl | Aray of mcl objects | The list of MicroCode Levels for this Engineering Change. |
Field name | Type | Description |
---|---|---|
type | String Enum | One of:
|
level | String (1-3) | Microcode level. |
last-update | Timestamp | Time stamp of the last update, in the number of milliseconds since midnight January 1, 1970 UTC. A null object is returned if no updates have occurred. |
Field name | Type | Description |
---|---|---|
stp-id | String (0-8) | If in STP-only or Mixed CTN, the STP identifier. Otherwise, an empty string. Valid characters are 0-9, a-z, A-Z, underscore(_) and dash(-). |
etr-id | Integer (0-31) | ETR Identifier, if in ETR mode. If not in ETR mode, a null object is returned. |
preferred-time-server | stp-node-object | Describes the Preferred Timer Server. This property is optional, only returned on a Get request when the information is set. |
backup-time-server | stp-node-object | Describes the Backup Timer Server. This property is optional, only returned on a Get request when the information is set. |
arbiter | stp-node-object | Describes the arbiter of the CTN. This property is optional, only returned on a Get request when the information is set. |
current-time-server | String Enum | Describes the CPC's role in the CTN. One of:
|
This object is used to identify a CPC to the STP services. When used as input on the Set STP Configuration operation, if the object-uri field is not provided, all other fields are required with the exception of the target-name and node-name fields which are ignored for the set operation. If the object-uri field is provided, all other fields are optional. If all fields are provided, the object-uri field is ignored.
Field name | Type | Description |
---|---|---|
object-uri | String URI | If the CPC is known to the HMC, contains the CPC's object-uri. Otherwise, contains a null object |
type | String (0-6) | The CPC machine type, right justified and left padded with zeros or a empty string |
model | String (0-3) | The CPC machine model or a empty string |
manuf | String (0-3) | The CPC manufacturer or a empty string |
po-manuf | String (0-2) | The CPC plant of manufacturer or a empty string |
seq-num | String (0-12) | The CPC sequence number or a empty string |
node-name | String (1-8) | The CPC name |
target-name | String (1-17) | The value that must be used on the X-API-Target-Name request header when
performing an operation on this object. Note: This property is only returned when the BCPii interface
was used for the request and the object-uri is not null.
|
Field name | Type | Description |
---|---|---|
psw | String | Program Status Word (PSW) information for a single processor. |
cpid | String (2) | The hexadecimal processor identifier, right justified and left padded with zeros. |
Field name | Type | Description |
---|---|---|
chpid | String (2) | The required network adapter channel path identifier, in hexadecimal characters 0-9,a-f,A-F. The format is two hexadecimal digits (00-FF). |
ipaddr-type | String Enum | Indicates how this network adapter's IP address
is obtained. One of the following values:
|
vlan-id | Integer (0-4094) | If this network adapter is attached to a Virtual LAN, this field contains the VLAN identifier. Otherwise, a null object indicating that this network adapter is not attached to a Virtual LAN. |
static-ip-info | network-ip-info object | When ipaddr-type is "static", contains the static IP information. Otherwise, contains a null object indicating that a static IP address is not used. |
Field name | Type | Description |
---|---|---|
chpid | String (2) | The required network adapter channel path identifier, in hexadecimal characters 0-9,a-f,A-F. The format is two hexadecimal digits (00-FF). |
port | Integer | The number of the port on the network adapter identified by
chpid. When the associated Support Element is at Version 2.13.1 or earlier, this property is not returned on a Get operation, and it cannot be specified on an Update operation. |
ipaddr-type | String Enum | Indicates how this network adapter's IP address is obtained. One of the
following values:
|
vlan-id | Integer (0-4094) | If this network adapter is attached to a Virtual LAN, this field contains the VLAN identifier. Otherwise, a null object indicating that this network adapter is not attached to a Virtual LAN. |
static-ip-info | network-ip-info object | When ipaddr-type is "static", contains the static IP information. Otherwise, contains a null object indicating that a static IP address is not used. |
Field name | Type | Description |
---|---|---|
type | String Enum | The type of IP address being provided. One of
the following values:
|
ip-address | String/IPV4 address or String/IPV6 address | The IP address to be used. The format of the string (IPv4 or IPv6) must be as indicated by the type field. |
Field name | Type | Description |
---|---|---|
type | String Enum | The type of IP address being provided. One of
the following values:
|
ip-address | String/IPV4 address or String/IPV6 address | The IP address to be used. The format of the string (IPv4 or IPv6) must be as indicated by the type field. |
prefix | Integer | The number of leading bits of ip-address that
represent the network prefix.
|
Field name | Type | Description |
---|---|---|
type | String Enum | The type of absolute capping. One of the following
values:
|
value | Float | When type is "none", value is not specified. When type is "processors", value is in the range .01...255.00 in increments of .01 and is the limit of usage independent of priority. |