Class specific additional properties

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

Table 1. Adapter object: class-specific properties
Name Qualifier Type Description Supported "adapter family" values
type (pc) String Enum The type of the adapter. Values:
  • "crypto" - Cryptographic adapter.
  • "fcp" - A Fibre Channel attached storage resource.
  • "hipersockets" - A HiperSockets adapter.
  • "osd" - OSA Direct Express.
  • "osm" - OSA-Express for Unified Resource Manager.
  • "osc" - OSA Integrated Console Controller.
  • "ose" - OSE for non-QDIO.
  • "roce" - RDMA over Converged Ethernet.
  • "roc2" - RDMA over Converged Ethernet version 2.
  • "zedc" - zEnterprise Data Compression.
  • "fc" - Fibre Connection attached storage resource.
  • "nvme" - Non-volatile Memory Express.
  • "cna" - Cloud Network Adapter.
  • "cl5" - Long range coupling.
  • "cs5" - Short range coupling.
  • "icp" - Internal Coupling Link.
  • "hyl" - zHyperLink Express.
  • "ism" - Internal Shared Memory.
  • "not-configured" - The adapter is not configured. Currently this applies only to adapters of adapter-family "ficon" when the dpm-enabled property of the parent CPC is true, to all adapters when the dpm-enabled property of the parent CPC is false and the CPC is not power-on reset complete, and to all adapters of adapter-family "ficon" or "osa" when the dpm-enabled property of the parent CPC is false and the adapter has no CHPIDs defined.

    This value will change when the adapter type is updated through the Change Adapter Type operation when the dpm-enabled property of the parent CPC is true, or when the dpm-enabled property of the parent CPC is false, and the CPC is power-on reset complete.

All
adapter-id String (3) ID of the adapter; three character lower-case hex string. This string is the PCHID of the physical adapter or the VCHID of the virtual HiperSockets adapter All
adapter-family String Enum The family of the card detected for this adapter at the time of its creation. Values:
  • "hipersockets" - A virtual HiperSockets card.
  • "osa" - An OSA card.
  • "ficon" - A FICON® card.
  • "roce" - An RDMA over Converged Ethernet card.
  • "crypto" - A cryptographic card.
  • "accelerator" - Adapter card which provides acceleration capability.
  • "nvme" - Non-volatile Memory Express.
  • "cna" - A Cloud Network Adapter card.
  • "coupling" - A coupling card.
  • "ism" - An Internal Shared Memory card.
  • "zhyperlink" - A zHyperLink Express.
  • "not-defined" - The adapter-family is not defined. This applies to some adapters if the dpm-enabled property of the parent CPC is false and the CPC is not powered on.
All
detected-card-type (pc) String Enum The type detected for the card with the adapter-id of this Adapter object. Values:
  • "hipersockets" - A virtual HiperSockets card
  • "osa-express-4s-1gb" - An OSA Express4S Gigabit Ethernet LX/SX.
  • "osa-express-4s-10gb" - An OSA Express4S Gigabit Ethernet LR/SR.
  • "osa-express-4s-1000base-t" - An OSA Express4S 1000BASE-T Ethernet.
  • "osa-express-5s-1gb" - An OSA Express5S Gigabit Ethernet LX/SX.
  • "osa-express-5s-10gb" - An OSA Express5S Gigabit Ethernet LR/SR.
  • "osa-express-5s-1000base-t" - An OSA Express5S 1000BASE-T Ethernet.
  • "osa-express-6s-1gb" - An OSA Express6S Gigabit Ethernet LX/SX.
  • "osa-express-6s-10gb" - An OSA Express6S Gigabit Ethernet LR/SR.
  • "osa-express-6s-1000base-t" - An OSA Express6s 1000BASE-T Ethernet.
  • "osa-express-7s-25gb" - An OSA Express7S 25 Gigabit Ethernet Short Reach
  • "10gbe-roce-express" - 10 GbE RoCE Express.
  • "roce-express-2" - A 10 GbE RoCE Express2
  • "roce-express-2-25gb" - A 25 GbE RoCE Express2
  • "crypto-express-5s" - Crypto Express5S.
  • "crypto-express-6s" - Crypto Express6S.
  • "crypto-express-7s" - Crypto Express7S.
  • "crypto-express-8s" - Crypto Express8S.
  • "ficon-express-8" - FICON Express8 10KM LX (2, 4, 8 Gbps) or FICON Express8 SX (2, 4, 8 Gbps).
  • "ficon-express-8s"- FICON Express8S 10KM LX (2, 4, 8 Gbps) or FICON Express8S SX (2, 4, 8 Gbps).
  • "ficon-express-16s"- FICON Express16S 10KM LX (4, 8, 16 Gbps) or FICON Express16S SX (4, 8, 16 Gbps).
  • "ficon-express-16s-plus" - FICON Express 16S+ LX 10KM (4, 8, 16 Gbps) or FICON Express16S+ SX (4, 8, 16 Gbps).
All
      (cont'd)
  • "ficon-express-16sa" - FICON Express 16SA LX 10KM (8, 16 GFC) or FICON Express16SA SX (8, 16 GFC)
  • "ficon-express-32s" - FICON Express32S LX (8, 16, 32 Gbps) or FICON Express32S SX (8, 16, 32 Gbps)
  • "fcp-express-32s" - FCP Express32S LX (16, 32 Gbps) or FCP Express32S SX (16, 32 Gbps)
  • "zedc-express" - zEnterprise® Data Compression (FPGA Corsa A5).
  • "nvme" - Non-volatile Memory Express.
  • "cloud-network-x5" - Cloud Network Adapter - X5.
  • "cloud-network-x6" - Cloud Network Adapter - X6.
  • "unknown" - The detected-card-type could not be determined.
 
card-location String (14 or 20) Location of the physical I/O card.
14 or 20 characters: "wwww-xxxx-J.yy" for single-port adapters, or "wwww-xxxx-J.yy-J.zz" for two-port adapters, where:
  • wwww - ID of the cage in which the card is installed.
  • xxxx - ID of the slot in the cage in which the card is installed.
  • yy - ID of the first jack/port on the card.
  • zz - ID of the second jack/port on the card.
ficon, osa, roce, crypto, accelerator, cna, nvme
port-count Integer Number of ports on the adapter. ficon, osa, roce, hipersockets, cna
network-port-uris Array of String/ URI List of network ports for this adapter. Each element in this array is the canonical URI path of a Network Port object.

The number of entries in this list matches the value of the port-count property.

osa, roce, hipersockets, cna
storage-port-uris Array of String/ URI List of storage ports for this adapter. Each element in this array is the canonical URI path of a Storage Port object.

The number of entries in this list matches the value of the port-count property.

ficon
state (pc) String Enum The current state of the adapter, which must be one of the following values:
  • "online" - The adapter is online.
  • "stand-by" - The adapter has been configured off.
  • "reserved" - The adapter has been configured into service mode.
  • "unknown" - The state of the adapter cannot be determined because of a communications issue.
All
maximum-transmission-unit-size (w)(pc) Integer Enum The maximum transmission unit size of the virtual switch. The maximum frame size is implied by this value. Values:
  • 8 - 8 KB MTU size and 16 KB maximum frame size.
  • 16 - 16 KB MTU size and 24 KB maximum frame size.
  • 32 - 32 KB MTU size and 40 KB maximum frame size.
  • 56 - 56 KB MTU size and 64 KB maximum frame size.
hipersockets
configured-capacity (pc) Integer For FCP adapters (type is "fcp"), this value is the number of host bus adapters (HBAs) that are configured, but not necessarily allocated, to the partitions assigned to the adapter.

For channel-based network adapters (type is "osd" or "hipersockets"), or for channel-based storage adapters of type "fc", this value is the number of subchannels that are configured, but not necessarily allocated, to partitions assigned to the adapter.

For Single Root I/O Virtualization (SR-IOV) adapters (type is "roce", "zedc" or "cna"), this value is the number of virtual PCI functions that are configured, but not necessarily allocated, to partitions assigned to the adapter.

For adapters with type values of "osm", or "not-configured", the value will always be 0.

configured-capacity may be larger than allowed-capacity or maximum-total-capacity, which indicates that the adapter is over-committed, and therefore, all partitions that include this adapter in their configuration cannot be active at the same time.

ficon, osa, roce, hipersockets, accelerator, cna
used-capacity (pc) Integer For FCP adapters (type is "fcp"), this value is the number of host bus adapters (HBAs) that are allocated to partitions assigned to the adapter.

For channel-based network adapters (type is "osd" or "hipersockets"), or for channel-based storage adapters of type "fc", this value is the number of subchannels that are allocated to partitions assigned to the adapter.

For Single Root I/O Virtualization (SR-IOV) adapters (type is "roce", "zedc" or "cna"), this value is the number of virtual PCI functions that are allocated to partitions assigned to the adapter.

For adapters with type value "osm" or "not-configured", the value will always be 0.

ficon, osa, roce, hipersockets, accelerator, cna
allowed-capacity (w)(pc) Integer For FCP adapters (type is "fcp"), this value is the maximum number of host bus adapters (HBAs) that may be allocated to the partitions assigned to the adapter. For FCP adapters, this property is writable and must be an integer from 0 to maximum-total-capacity.

For channel-based network adapters (type is "osd" or "hipersockets"), or for channel-based storage adapters of type "fc", this value is the maximum number of subchannels that may be allocated to partitions assigned to the adapter. For these adapters, this property is read-only and its value will be automatically defined by the system when the adapter is configured.

For Single Root I/O Virtualization (SR-IOV) adapters (type is "roce", "zedc" or "cna"), this value is the maximum number of virtual PCI functions that may be allocated to partitions assigned to the adapter. For these adapters, this property is read-only and its value will be automatically defined by the system when the adapter is configured.

For adapters with type value "osm" or "not-configured", this property is read-only and its value will always be 0.

ficon, osa, roce, hipersockets, accelerator, cna
maximum-total-capacity (pc) Integer This is the largest permitted value of allowed-capacity.

For adapters with type value "osm" or "not-configured", the value will always be 0.

ficon, osa, roce, hipersockets, accelerator, cna
channel-path-id (w)(pc) String (2) Channel path ID (CHPID) used by the adapter's partition; two character hex string. This value will be null when the value of type is "not-configured".

channel-path-id cannot be written if the adapter is configured to any partition.

ficon, osa, hipersockets
physical-channel-status (pc) String Enum Status of the physical channel. Values:
  • "operating" - The channel path is operating. Maps to status value "active".
  • "no-power" - The power is off for the hardware that supports the channel path, the channel path is not operating. Maps to status value "not-active".
  • "service" - The path is in single channel service (SCS) mode and is not in the active I/O configuration. The channel path is not operating. Maps to status value "service".
  • "stopped" - The channel path is not operating. Maps to status value "not-active".
  • "not-defined" - The channel path is not defined in the active IOCDS. The channel path is not operating. Maps to status value "not-active".
  • "definition-error" - The channel path that is specified in the active input/output configuration data set (IOCDS) does not match the characteristics of the installed channel, or the channel type is incompatible with the current storage allocation, or the level of the installed channel hardware does not support the definition in the IOCDS. The channel path is not operating. Maps to status value "exceptions".
  • "suspended" - The channel path is suspended. The channel path is not operating. Maps to status value "service".
  • "check-stopped" - The channel path is unavailable due to a permanent machine error affecting the channel hardware. The channel path is not operating. Maps to status value "exceptions".
  • "wrap-block" - A wrap block is installed on the channel path's channel interface.
    Note: Wrap blocks are used during special diagnostic tests performed on the channel. Wrap blocks must be removed before system initialization to allow the channel to initialize completely.

    The channel path is not operating. Maps to status value "exceptions".

  • "permanent-error" - The channel path is unavailable due to a permanent outboard error. The channel path is not operating. Maps to status value "exceptions".
  • "initializing" - The firmware is being loaded into the channel card and then the channel card is starting. Maps to status value "not-active".
all
     
  • "loss-of-signal" - The channel path detected a link-signal error. The level of the signal on the link is below the value specified for reliable communication. Maps to status value "exceptions".
  • "loss-of-synchronization" - The channel path detected a link-signal error. The bit synchronization with the signal was lost. The channel path is not operating. Maps to status value "exceptions".
  • "not-operational-link" - The channel path detected a link failure due to a non-operational sequence. The channel path is not operating. Maps to status value "exceptions".
  • "sequence-time-out" - The channel path detected a link failure due to a sequence timeout. The channel path is not operating. Maps to status value "exceptions".
  • "sequence-not-permitted" - The channel path detected a link failure due to an illegal sequence for a link. The channel path is not operating. Maps to status value "exception".
  • "terminal-condition" - The channel path is not available due to an interface-hung condition. This condition can occur after an interface or channel error if the control unit or device fails to disconnect from the interface when requested by the channel. The channel path is not operating. Maps to status value "exceptions".
  • "offline-signal-received" - The channel path detected an offline sequence, indicating that the sender is in offline mode and subsequent link-signal errors that are detected by the channel path are not to be reported. For an ES conversion channel, this condition can occur only when the channel is wrongly attached to another channel, switch, or control unit instead of an ESCON Converter. The channel path is not operating. Maps to status value "exceptions".
  • "fabric-login-sequence-failure" - This condition means that the channel detected a failure during the Fabric Login procedure. Maps to status value "exceptions".
  • "port-login-sequence-failure" - This condition means that the channel detected a failure during the registration procedure. In order for a FICON channel to communicate with devices on a control unit, it must perform a Port Login with that control unit. Maps to status value "exceptions".
  • "state-change-registration-failure" - This condition means that the channel detected a failure during the registration procedure. A FICON channel is required to register with the switch to receive state change notification. Maps to status value "exceptions".
 
     
  • "invalid-attachment-failure" - Occurs when the channel determines that it is connected to a switch, but the IOCDS specifies that it should be directly connected to a control unit or the contrary. Maps to status value "exceptions".
  • "test-mode" - The channel path is in test mode. The channel path is not operating. Maps to status value "not-active".
  • "bit-error-threshold-exceeded" - The number of bit errors the channel path detected while receiving or sending data is more than the threshold set for its bit error counter. The channel path is not operating. Maps to status value "exceptions".
  • "ifcc-threshold-exceeded" - The number of interface control checks (IFCCs) the channel path detected is more than the threshold set for its IFCC counter. IFCCs may continue to occur; the error logs will not be created and sent to the Support Element. Maps to status value "exceptions".
  • "io-supressed" - The channel path input/output (I/O) suppression is active. I/O suppression prevents the channel subsystem from selecting any device and fetching the first channel command word (CCW) of a channel program. The channel path is not operating. Maps to status value "not-active".
 
crypto-number (pc) Integer Identifier of the crypto adapter in the range 0-15. Crypto number must be unique to other configured crypto adapters for the CPC. crypto
crypto-type (pc) String Enum Crypto type. Values:
  • "accelerator" - Crypto Express adapter operating as an Accelerator.
  • "cca-coprocessor" - Crypto Express5S Coprocessor.
  • "ep11-coprocessor" - Crypto Express5S EP11 Coprocessor.
  • "not-configured" - Crypto type is not configured. This applies only to adapters whose parent CPC is not power-on reset complete, and the dpm-enabled property of the CPC is false. [Updated by feature adapter-network-information]
crypto
udx-loaded (pc) Boolean true if the configured crypto was UDX-loaded; false otherwise.
udx-loaded cannot be read, and a null is returned, if any of the following conditions are true:
  • The CPC that contains the cryptographic adapter is not started.
  • The adapter's status is "exceptions".
  • The adapter's status is "not-active".
  • The adapter's state is not "online".
crypto
tke-commands-enabled (w)(pc) Boolean true if the crypto permits TKE commands; false otherwise.
tke-command-enabled cannot be read or written, and a null is returned on a read, if any of the following conditions are true:
  • The CPC that contains the cryptographic adapter is not started.
  • The adapter's status is "exceptions".
  • The adapter's status is "not-active".
  • The adapter's state is not "online".
crypto
ssd-is-installed (pc) Boolean true if a solid-state drive (SSD) is installed on the adapter card; false otherwise. nvme
ssd-capacity (pc) Float The capacity in gibibytes (GiB) of the solid-state drive (SSD) installed on the adapter. The capacity is rounded to two decimal places.

A null is returned if the value of the CPC’s status property is not "operating", "service-required", "degraded", or "exceptions", if the installed SSD is defective, or if the value of the ssd-is-installed property is false.

nvme
ssd-model-number (pc) String The model number of the solid-state drive (SSD) installed on the adapter.

A null is returned if the value of the CPC’s status property is not "operating", "service-required", "degraded", or "exceptions", if the installed SSD is defective, or if the value of the ssd-is-installed property is false.

nvme
ssd-serial-number (pc) String The serial number of the solid-state drive (SSD) installed on the adapter.

A null is returned if the value of the CPC’s status property is not "operating", "service-required", "degraded", or "exceptions", if the installed SSD is defective, or if the value of the ssd-is-installed property is false.

nvme
ssd-subsystem-vendor-id (pc) Integer The PCI subsystem vendor identifier of the solid-state drive (SSD) installed on the adapter.

A null is returned if the value of the CPC’s status property is not "operating", "service-required", "degraded", or "exceptions", if the installed SSD is defective, or if the value of the ssd-is-installed property is false.

nvme
ssd-vendor-id (pc) Integer The PCI vendor identifier of the solid-state drive (SSD) installed on the adapter.

A null is returned if the value of the CPC’s status property is not "operating", "service-required", "degraded", or "exceptions", if the installed SSD is defective, or if the value of the ssd-is-installed property is false.

nvme
network-ports (p) Array of network-port-info objects An array of network-port-info objects that contain port numbers and MAC addresses, as detailed in Table 2.
Note: This property can be retrieved through the List Permitted Adapters operation, but only when the dpm-enabled property of the Adapter's parent CPC is false.

[Added by feature adapter-network-information]

osa
Table 2. network-port-info object properties [Added by feature adapter-network-information]
Name Qualifier Type Description
port-number Integer The port number.
mac-address String The MAC address associated with the port.

The MAC address is represented as six groups of two lower-case hexadecimal digits separated by colons (:). Only locally administered unicast MAC addresses are valid, e.g. "02:ff:12:34:56:78".