Class specific additional properties

In addition to the properties defined through included schemas, this object includes the following additional class-specific properties.

Table 1. CPC object: class specific additional properties
Name Qualifier Type Description
se-version (pc) String (1-8) The current release level of the primary SE internal code. For example, 2.11.1. Note that the alternate SE is normally at the same level, except when installing new internal code levels.
has-hardware-messages (pc) Boolean The CPC object has hardware messages (true), or does not have hardware messages (false).
iml-mode (pc) String Enum The Initial Microcode Load (IML) mode type of the CPC object. One of:
  • "not-set" - the CPC is not IMLed or the CPC is not communicating with the HMC.
  • "esa390" - the CPC is in ESA/390 mode
  • "lpar" - the CPC is in logical partition mode
  • "esa390-tpf" - the CPC is in ESA/390 TPF mode
  • "dpm" - the CPC is in DPM mode
dpm-enabled (pc) Boolean The CPC is enabled for DPM (true) or not (false).
auto-start-list (pc) Array of objects The array of nested auto-start-entry objects in sequence, each representing a single partition or a group of partitions that are automatically started when this CPC is started. This is an ordered array. The partitions or partition groups that are earlier in the array are started before those that are later in the array. The order in which the individual partitions within a given partition group are started is not specified. An empty array indicates that no partitions are automatically started. The auto-start list is specified through the Set Auto-Start List operation.

This property is only present when dpm-enabled is true.

is-cpacf-enabled Boolean Whether Central Processor Assist for Cryptographic Functions (CPACF) is enabled (true) for the CPC or not (false).
next-activation-profile-name (w)(pc) String (1-16) For a CPC that is not enabled for DPM, the name of the activation profile to be used on the next activation of the CPC. The group-uri query parameter can be used on a Get CPC Properties operation to specify the object URI of the Custom Group object used for determining the next activation profile name to be used. If not specified, the system-defined CPC group is used for this determination.
Note: This property is not returned on a Get CPC Properties operation when the CPC is enabled for DPM.
Note: This property is not permitted on an Update CPC Properties operation when the CPC is enabled for DPM.
last-used-activation-profile (pc) String (0-16) For a CPC that is not enabled for DPM, the name of the activation profile used on the last activation of the CPC or an empty string.
Note: This property is not returned on a Get CPC Properties operation when the CPC is enabled for DPM.
last-used-iocds (pc) String (0-3) For a CPC that is not enabled for DPM, the name of the IOCDS most recently used by the CPC or an empty string if the CPC has not been IMLed.
Note: This property is not returned on a Get CPC Properties operation when the CPC is enabled for DPM.
machine-model (pc) String (1-3) The model of the machine containing this CPC. For example, M15.
machine-type (pc) String (1-4) The type of the machine containing this CPC. For example, 2817.
machine-serial-number (pc) String (1-12) The serial number of the machine containing this CPC. For example, 00 - SP1D92B.
cpc-serial-number String (1-12) The serial number of the CPC. For example, 00000SP1D92B.
cpc-node-descriptor (pc) String (2) The hexadecimal number mapped to the device location of the CPC. This property identifies the CPC's relative order among other CPCs, if any, in the machine. For example, 00.
is-cbu-installed Boolean The Capacity Backup Upgrade (CBU) facility is installed (true), or not installed (false). Note: if status is "not-communicating", a null object is returned. Refer to the Capacity On Demand User's Guide for details.
is-cbu-enabled Boolean CBU is enabled (true), or is not enabled (false). Note: if status is "not-communicating", a null object is returned. Refer to the Capacity On Demand User's Guide for details.
is-cbu-activated Boolean CBU is activated (true), or is not activated (false). Note: if status is "not-communicating", a null object is returned. Refer to the Capacity On Demand User's Guide for details.
is-real-cbu-available Boolean Real CBU is available (true), or not available (false). Note: if status is "not-communicating", a null object is returned. Refer to the Capacity On Demand User's Guide for details.
cbu-activation-date Timestamp The date of CBU activation. Note: if status is "not-communicating", a null object is returned. Refer to the Capacity On Demand User's Guide for details.
cbu-expiration-date Timestamp The date of CBU expiration. Note: if status is "not-communicating", a null object is returned. Refer to the Capacity On Demand User's Guide for details.
cbu-number-of-tests-left Integer The number of CBU tests left. Note: if status is "not-communicating", a null object is returned. Refer to the Capacity On Demand User's Guide for details.
is-secure-execution-enabled1 (pc) Boolean If true, Secure Execution for Linux® is enabled. If false, Secure Execution for Linux is disabled.
is-global-key-installed1 (pc) Boolean If true, the Global key is installed. If false, the Global key is not installed. If Secure Execution for Linux is not enabled, this property will be returned as a null.
is-host-key-installed1 (pc) Boolean If true, the Host key is installed. If false, the Host key is not installed. If Secure Execution for Linux is not enabled, this property will be returned as a null.
global-primary-key-hash1 (pc) String (64) The lowercase hexadecimal global primary key hash. If a global primary key is not installed, this property will be returned as a null.
Note: This property is not returned on a Get CPC Properties operation when the API user does not have action/task permission to the Manage Secure Execution Keys task.
global-secondary-key-hash1 (pc) String (64) The lowercase hexadecimal global secondary key hash. If a global secondary key is not installed, this property will be returned as a null.
Note: This property is not returned on a Get CPC Properties operation when the API user does not have action/task permission to the Manage Secure Execution Keys task.
host-primary-key-hash1 (pc) String (64) The lowercase hexadecimal host primary key hash. If a host primary key is not installed, this property will be returned as a null.
Note: This property is not returned on a Get CPC Properties operation when the API user does not have action/task permission to the Manage Secure Execution Keys task.
host-secondary-key-hash1 (pc) String (64) The lowercase hexadecimal host secondary key hash. If a host secondary key is not installed, this property will be returned as a null.
Note: This property is not returned on a Get CPC Properties operation when the API user does not have action/task permission to the Manage Secure Execution Keys task.
is-host-import-key-installed (pc) Boolean If true, Host Import Key is installed. If false, Host Import Key is not installed. If Secure Execution for Linux is not enabled, this property is returned as a null.

[Added by feature secure-execution-key-management]

primary-host-import-key-id-pattern (pc) String (64) The lowercase hexadecimal primary host import key identification pattern. If a primary host import key is not installed, this property will be returned as a null.
Note: This property is not returned on a Get CPC Properties operation when the API user does not have the task permission to the Manage Secure Execution Keys task.

[Added by feature secure-execution-key-management]

is-service-required Boolean Whether the CPC is operating using the last redundant part of a particular type (true) or not (false). If true, repairs should be made before additional parts fail that would make this CPC non-operational.

Support Element (Version 2.12.1 and newer) information can be found on console help system. For information about earlier versions of the Support Element, see the Support Element Operations Guide.

degraded-status (pc) Array of String Enum The set of degraded status values. If the CPC is not degraded, this property contains not-degraded as the only value. Otherwise, this property contains one or more of the following:
  • "memory" - loss of memory
  • "io" - loss of I/O channels
  • "node" - one or more books are no longer functioning
  • "ring" - the ring connecting the book is open
  • "cbu" - CBU resources have expired
  • "mru" - cycle time reduction due to an MRU problem
  • "ambient-temp" - cycle time reduction due to a temperature problem
  • "iml" - CPC was IMLed during cycle time reduction.
processor-running-time-type (w) String Enum For a CPC that is not enabled for DPM, denotes how the processor-running-time property value was determined. One of:
  • "system-determined" - the processor running time is dynamically determined by the system
  • "user-determined" - the processor running time is set to a constant value.
Note: If iml-mode is not "lpar", a null object is returned.
Note: This property is not returned on a Get CPC Properties operation when the CPC is enabled for DPM.
Note: This property is not permitted on an Update CPC Properties operation when the CPC is enabled for DPM.
processor-running-time (w) Integer For a CPC that is not enabled for DPM, the amount of continuous time, in milliseconds, allowed for logical processors to perform jobs on shared processors for the CPC object. Note: a null object is returned if the iml-mode is not "lpar" or processor-running-time-type is "system-determined".
Note: This property is not returned on a Get CPC Properties operation when the CPC is enabled for DPM.
Note: This property is not permitted on an Update CPC Properties operation when the CPC is enabled for DPM.
does-wait-state-end-time-slice (w) or — if se-version is "2.14.0" or later Boolean For a CPC that is not enabled for DPM, Logical Partitions of the CPC should lose their share of running time when they enter a wait state (true), or should not lose their share of running time when they enter a wait state (false). Note: a null object is returned if the iml-mode is not "lpar" or processor-running-time-type is "system-determined".
Note: This property is not returned on a Get CPC Properties operation when the CPC is enabled for DPM.
Note: This property is not permitted on an Update CPC Properties operation when the CPC is enabled for DPM.
Note: When se-version is "2.14.0" or later, this property is not permitted on an Update CPC Properties operation, and its value is always false.
is-on-off-cod-installed Boolean On/Off Capacity on Demand is installed for the CPC object (true), or is not installed (false). Note: if status is "not-communicating", a null object is returned. Refer to the Capacity On Demand User's Guide for details.
is-on-off-cod-enabled Boolean On/Off CoD is enabled (true), or is not enabled (false). Note: if status is "not-communicating", a null object is returned. Refer to the Capacity On Demand User's Guide for details.
is-on-off-cod-activated Boolean On/Off CoD is currently activated for the CPC object (true), or is not currently activated (false). Note: if status is "not-communicating", a null object is returned. Refer to the Capacity On Demand User's Guide for details.
on-off-cod-activation-date Timestamp The date when On/Off CoD was activated. Note: if status is "not-communicating", a null object is returned. Refer to the Capacity On Demand User's Guide for details.
software-model-permanent (pc) String (1-3) The software model based on the permanent processors and the capacity level that the processors are running on. For example, 723.
software-model-permanent-plus-billable (pc) String (1-3) The software model based on the permanent plus billable processors and the capacity level that the processors are running on. For example, 723.
software-model-permanent-plus-temporary (pc) String (1-3) The software model based on the permanent plus all temporary processors and the capacity level that the processors are running on. For example, 723.
software-model-purchased4 String (1-3) The software model based on the purchased processors and the capacity level that the processors are running on. For example, 723.
msu-permanent Integer The MSU value associated with the software model based on the permanent processors.
msu-permanent-plus-billable Integer The MSU value associated with the software model based on the permanent plus billable processors.
msu-permanent-plus-temporary Integer The MSU value associated with the software model based on the permanent plus all temporary processors.
msu-purchased4 Integer The MSU value associated with the software model based on the purchased processors.
processor-count-general-purpose (pc) Integer The count of active general purpose processors.
processor-count-service-assist Integer The count of active service assist processors (SAP).
processor-count-aap Integer The count of active IBM® zEnterprise® Application Assist Processor (zAAP) processors.
processor-count-ifl (pc) Integer The count of active Integrated Facility for Linux (IFL) processors.
processor-count-icf (pc) Integer The count of active Internal Coupling Facility (ICF) processors.
processor-count-iip (pc) Integer The count of active IBM z Integrated Information Processor (zIIP) processors.
processor-count-defective Integer The count of defective processors. Includes all processor types.
processor-count-spare Integer The count of spare processors. Includes all processor types.
processor-count-pending Integer The combined number of processors that will become active, when more processors are made available by adding new hardware or by deactivating capacity records.
processor-count-pending-general-purpose Integer The number of general purpose processors that will become active, when more processors are made available by adding new hardware or by deactivating capacity records. Note: if status is "not-communicating", a null object is returned.
processor-count-pending-service-assist3 Integer The number of service assist processors (SAP) that will become active, when more processors are made available by adding new hardware or by deactivating capacity records. Note: if status is "not-communicating", a null object is returned.
processor-count-pending-aap3 Integer The number of Application Assist processors (zAAP) that will become active, when more processors are made available by adding new hardware or by deactivating capacity records. Note: if status is "not-communicating", a null object is returned.
processor-count-pending-ifl3 Integer The number of Integrated Facility for Linux processors (IFL) that will become active, when more processors are made available by adding new hardware or by deactivating capacity records. Note: if status is "not-communicating", a null object is returned.
processor-count-pending-icf3 Integer The number of Integrated Coupling Facility processors (ICF) that will become active, when more processors are made available by adding new hardware or by deactivating capacity records. Note: if status is "not-communicating", a null object is returned.
processor-count-pending-iip3 Integer The number of z Integrated Information Processors (zIIP) that will become active, when more processors are made available by adding new hardware or by deactivating capacity records. Note: if status is "not-communicating", a null object is returned.
processor-count-permanent-service-assist4 Integer The count of permanent service assist processors (SAP).
processor-count-permanent-ifl4 Integer The count of permanent Integrated Facility for Linux (IFL) processors.
processor-count-permanent-icf4 Integer The count of permanent Internal Coupling Facility (ICF) processors.
processor-count-permanent-iip4 Integer The count of permanent z Integrated Information Processor (zIIP) processors.
processor-count-unassigned-service-assist4 Integer The count of unassigned service assist processors (SAP).
processor-count-unassigned-ifl4 Integer The count of unassigned Integrated Facility for Linux (IFL) processors.
processor-count-unassigned-icf4 Integer The count of unassigned Internal Coupling Facility (ICF) processors.
processor-count-unassigned-iip4 Integer The count of unassigned z Integrated Information Processor (zIIP) processors.
has-temporary-capacity-change-allowed Boolean Whether API applications are allowed to make changes to temporary capacity (true), or not (false).
ec-mcl-description ec-mcl-description object Describes the Engineering Change (EC) and MicroCode Level (MCL) for the CPC object. An empty object is returned if the information is unavailable from the SE. Refer to the description of the ec-mcl-description object for details.
has-automatic-se-switch-enabled Boolean Automatic switching between primary and alternate Support Elements is enabled for the CPC object (true), or is not enabled (false).

Support Element (Version 2.12.1 and newer) information can be found on console help system. For information about earlier versions of the Support Element, see the Support Element Operations Guide.

stp-configuration stp-config object Describes the Server Time Protocol (STP) configuration. Refer to the description of the stp-config object for details. Note: if the required feature(s) are not installed, the property is not returned.
lan-interface1-type (pc) String Enum The adapter type of the Support Element's LAN interface 1. One of the following:
  • "ethernet"
  • "token-ring"
  • "unknown"
lan-interface1-address (pc) String (1-12) The MAC address of the Support Element's LAN interface 1.
lan-interface2-type (pc) String Enum The adapter type of the Support Element's LAN interface 2. One of the following:
  • "ethernet"
  • "token-ring"
  • "unknown"
lan-interface2-address (pc) String (1-12) The MAC address of the Support Element's LAN interface 2.
network1-ipv4-mask (pc) String (1-15) The network IP mask value.
network1-ipv4-pri-ipaddr (pc) String IPV4 address The primary IPv4 address or a null object if not configured.
network1-ipv4-alt-ipaddr (pc) String IPV4 address The alternate IPv4 address or a null object if not configured.
network1-ipv6-info Array of ipv6-info objects A list of objects describing the Support Element's IPv6 network connections. If no IPv6 connections are defined, an empty list is returned.
network2-ipv4-mask (pc) String (1-15) The network IP mask value.
network2-ipv4-pri-ipaddr (pc) String IPV4 address The primary IPv4 address or a null object if not configured.
network2-ipv4-alt-ipaddr (pc) String IPV4 address The alternate IPv4 address or a null object if not configured.
network2-ipv6-info Array of ipv6-info objects A list of objects describing the Support Element's IPv6 network connections. If no IPv6 connections are defined, an empty list is returned.
hardware-messages (c)(pc) Array of hardware-message objects The complete list of all CPC hardware messages, each identified by its URI. This list corresponds to the list provided by the List CPC Hardware Messages operation. If the CPC has no hardware messages, then an empty array is provided.

The list of returned hardware messages can change as a result of new messages being dynamically added or removed by the infrastructure or due to hardware messages being deleted through the Delete CPC Hardware Message operation.

Note: This property is not returned by the Get CPC Properties operation, and only sessions associated with an HMC user with permission to the Hardware Messages task will receive a property-change notification for this property.
storage-total-installed (pc) Long Amount of installed storage, in megabytes.
storage-hardware-system-area Long Amount of storage, in megabytes, reserved for the base hardware system area (HSA).
storage-customer Long Amount of storage, in megabytes, for use by the customer.
storage-customer-central Long Amount of storage, in megabytes, which is the central storage in use across the active partitions.
storage-customer-expanded Long Amount of storage, in megabytes, which is the expanded storage in use across the active partitions.

When the iml-mode is "dpm" this property will be set to 0.

storage-customer-available Long Amount of storage, in megabytes, which is not in use.
storage-vfm-increment-size1 Long The increment size of any IBM Virtual Flash Memory (VFM) storage property, in gigabytes (GB), on this CPC and its logical partitions or partitions.
storage-vfm-total1 Long The total amount of VFM storage, in gigabytes (GB), installed on this CPC. The valid value should be a multiple of the value indicated on the storage-vfm-increment-size property for this CPC.
maximum-hipersockets Integer The maximum number of HiperSocket adapters that may be created for the CPC when the CPC is enabled for DPM.

This property will be omitted if dpm-enabled is false.

maximum-alternate-storage-sites Integer The maximum number of alternate storage-site instances that may be added to the FICON® configuration associated with this CPC.

This property will be omitted if dpm-enabled is false.

available-features-list Array of cpc-feature-info objects The list of optional features or behavior supported by this CPC. If the CPC has no optional features, then an empty array is provided.
maximum-partitions Integer The maximum number of partitions that this CPC supports.

This property will be omitted if dpm-enabled is false.

management-world-wide-port-name (pc) String (16) The worldwide port name that the CPC has defined to be used to discover Tape Library objects.

This value will be null if the Request Tape Library Zoning request has not been issued.

This value is only available when the dpm-fcp-tape-management feature is enabled on the target CPC.

sna-name String (1-17) The fully qualified SNA name of the Console.
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.
maximum-ism-vchids Integer

The maximum number of Internal Shared Memory (ISM) adapters that may be created for the CPC when the CPC is enabled for DPM. This property will be omitted if dpm-enabled is false.

minimum-fid-number Integer

The minimum number that can be specified for a Function ID (FID) that may be created for the CPC when the CPC is enabled for DPM. This property will be omitted if dpm-enabled is false.

maximum-fid-number Integer

The maximum number that can be specified for a Function ID (FID) that may be created for the CPC when the CPC is enabled for DPM. This property will be omitted if dpm-enabled is false.

Notes:

  1. On a Get request, this property is returned only when the associated SE version is 2.15.0 with the suitable MCL bundle, or a later SE version.
  2. On a Get request, this property is returned only when the SE version is 2.14.0 or later.
  3. This property is not supported and is always 0 when the SE version is 2.16.0 or later.
  4. This property is returned only when the SE version is 2.16.0 or later.
Table 2. ipv6-info object properties
Name Type Description
type String Enum The IPv6 scope. One of the following values:
  • "link-local"
  • "static"
  • "auto"
prefix Integer The number of leading bits of the IPv6 address that represent the network prefix
pri-ip-address String IPV6 address The primary IPv6 address
alt-ip-address String IPV6 address The alternate IPv6 address or a null object if not configured
Table 3. hardware-message object properties
Name Type Description
element-uri String/ URI The canonical URI path of the CPC hardware message. The URI is in the following form: /api/cpcs/{cpc-id}/hardware-messages/{hardware-message-id}, where {hardware-message-id} is the value of the element-id property of the hardware message.
element-id String (36) The unique identifier for the hardware message. The element-id is in the form of a UUID.
parent String/ URI The parent of a CPC hardware message is the CPC object. The parent value is the canonical URI path for the CPC.
class String The class of a hardware message object is "hardware-message".
timestamp Timestamp The timestamp represents the date and time when the hardware message was created.
service-supported Boolean Indicates whether or not this hardware message represents a problem for which service may be requested. True is returned if this hardware message supports service, or false is returned if it does not.
text String The text of the hardware message.
details Object A hardware-message-details-object if there are hardware message details, or null if there are no hardware message details.
Table 4. cpc-feature-info object properties
Name Type Description
name String Enum The name of the feature. One of:
  • "dpm-storage-management" - Indicates that the CPC supports Storage Groups and FICON storage resources. FCP and FICON storage resources are defined in Storage Groups, which are then attached to this CPC's partitions. If the CPC does not have this feature, FCP storage resources are represented by HBAs, which must be directly attached to this CPC's Partitions. This feature is applicable only for CPCs enabled for DPM.
  • "dpm-fcp-tape-management" - Indicates that the CPC supports Tape Libraries linked through FCP connections. FCP tape resources are defined in Tape Links, which are then attached to this CPC's partitions. This feature is applicable only for CPCs enabled for DPM.
  • "dpm-smcd-partition-link-management" - Indicates that the CPC supports Partition Links via SMC-D connections. This feature is applicable only for CPCs enabled for DPM.

See Features for a list of operations that are affected for each of these features.

description String A brief description of the feature.
state Boolean Indicates if the feature is currently enabled (true) or disabled (false) for this CPC.

auto-start-entry object

An auto-start-entry object specifies either a partition or a group of partitions that are automatically started when the CPC is started. Every auto-start-entry object contains the following base properties in addition to the type-specific properties:

Table 5. auto-start-entry object base properties
Name Type Description
post-start-delay Integer Amount of time, in seconds, to wait before starting the next partition or group of partitions. Must be greater than or equal to 0.
type String Enum The type of auto-start-entry. One of
  • "partition" - this entry identifies a single partition.
  • "partition-group" - this entry identifies a partition group.

An auto-start-entry object with a type value of "partition" identifies a single partition. In addition to the base properties, it contains the following type-specific properties:

Table 6. auto-start-entry object type-specific properties when type value is "partition"
Name Type Description
partition-uri String/ URI The URI of the partition to start.

An auto-start-entry object with a type value of "partition-group" identifies a group of partitions. In addition to the base properties, it contains the following type-specific properties:

Table 7. auto-start-entry object type-specific properties when type value is "partition-group"
Name Type Description
name String (1-64) The name of this partition group. This name must be unique among all partition groups of this CPC. The length and character requirements on this property are the same as those of the name property described in the Base managed object properties schema.
description String (0-1024) The Description for this partition group.
partition-uris Array of String/ URI The list of one or more partitions to start, represented by their URIs. This list is unordered. The partitions in a group can be started in any order or simultaneously by the system.