Data model - NIC element object

Edit online

The following table contains the NIC element object properties.

Table 1. Partition object - NIC element object properties
Name Qualifier Type Description of specialization
element-id — String (36) The unique identifier for the NIC within the scope of the partition.
element-uri — String/ URI The canonical URI path for the NIC is of the form /api/partitions/{partition-id}/nics/{nic-id}, where {partition-id} is the object-id of the partition, and the {nic-id} is the element-id of the NIC.
parent — String/ URI The URI path of the partition that hosts this NIC.
class — String (3) Always "nic".
name (w)(pc) String (1-64) Name of the NIC. The name must be unique among all NICs of the partition. The length and character requirements on this property are the same as those described in the Base managed object properties schema.
description (w)(pc) String (0-1024) Description of the NIC.

Default: an empty string.
device-number (w)(pc) String (4) Device number of the NIC.

The string is in the form of a 4-digit hexadecimal number. The allowed value range is from 0001-FFFF. If type is "osd" a range of 3 device numbers will be allocated. If type is "cna", the range of device numbers allocated is indicated by the function-range property.

Default: auto-generated.

Constraint: If type is "roce" or "cna", this number must be unique across the device numbers of all other NIC elements of type "roce" or "cna" and all instances of the objects listed in PCI-based device numbers associated with the partition. If type is "iqd" or "osd", this number must be unique across the device numbers of all other NIC elements of type "iqd" or "osd" and all instances of objects listed in Channel-based device numbers of the partition.
network-adapter-port-uri (w)(pc) String/ URI The canonical URI path for the associated Network Port element object.

Only present when type is "roce" or "cna".
virtual-switch-uri (w)(pc) String/ URI The canonical URI path for the associated Virtual Switch object. Only present when type is "osd" or "iqd".

Constraint: If type is "iqd" and the Partition belongs to a CPC with API feature dpm-hipersockets-partition-link-management available, this property is not writable. [Updated by feature dpm-hipersockets-partition-link-management]
type — String Enum The type of the NIC. The value of this property is derived implicitly from the backing adapter associated with this NIC on the Create NIC operation. Valid values are:
  • "roce" - RDMA over Converged Ethernet.
  • "iqd" - Internal Queued Direct.
  • "osd" - OSA Direct Express
  • "cna" - Cloud Network Adapter
ssc-management-nic (w)(pc) Boolean Indicates that this NIC should be used as a management NIC for Secure Service Container to access the web interface.

Can only be set to true if the partition's type is "ssc".

If the partition's type is "ssc", there must be at least one management NIC defined before the partition can be started.

If true, other parameters are required (at least ssc-ip-address-type) for this NIC.

If true, only OSA or HiperSockets adapters can be selected as backing adapters.

If the associated SE is version 2.13.1, the only valid port for an OSA backing adapter is port 0.
ssc-ip-address-type1 (w)(pc) String Enum Secure Service Container IP address type. Valid types are:

  • "ipv4" - Network is configured in static IPv4 mode

  • "ipv6" - Network is configured in static IPv6 mode

  • "linklocal" - Network is configured in Link Local mode
  • "dhcp" - Network is configured in DHCP mode.
ssc-ip-address1 (w)(pc) String/ IPv4 Address or String/ IPv6 Address The IP address of the Secure Service Container management web interface.
ssc-mask-prefix1 (w)(pc) String Network mask of the Secure Service Container management NIC. Either the mask is provided in bit notation, e.g. "/24" (both for IPv4 and IPv6), or in mask notation, e.g. "255.255.255.0" (IPv4 only).
vlan-id (w)(pc) Integer (1-4094) The VLAN ID associated with this NIC.

When the partition's type is "ssc", this property is allowed only if the value of ssc-management-nic is "true". It can be null.

When the partition's type is not "ssc", this property is not allowed when the type of the NIC is "roce" or "cna".
mac-address (w)(pc) String (17) The MAC address associated with this NIC. It must be unique among all the NICs created in the CPC.

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".

This value can not be set when the type of the NIC is "roce" or "cna".

Default: Auto-generated

vlan-type (w)(pc) String Enum The type of VLAN tagging to use for the VLAN associated with this NIC, or null, if the NIC is not associated with a VLAN. Valid value:
  • "enforced" - the network adapter only allows untagged packets or packets tagged for the VLAN identified by vlan-id through to the operating system running in the partition. The network device in the operating system should also be configured with the same vlan-id.

This value can not be set when the partition's type is "ssc" or when the type of the NIC is "roce" or "cna".

function-number (w)(pc) Integer The function number of the PCI function on the adapter. This property can only be set when the type of the NIC is "cna".

A value of 0 indicates a physical PCI function (PF); all other values indicate a virtual PCI function (VF).

Default: 0
function-range (w)(pc) Integer (1-128) The number of PCI functions on the NIC. This property can only be set when the type of the NIC is "cna". It controls the number of virtual PCI functions that are created. For example, if function-number is 0 and function-range is 128, that results in 1 physical PCI function and 127 virtual PCI functions.

Default: 128
1Only applicable if ssc-management-nic is true.