IscsiPortInfo

IscsiPortInfo
IscsiPortInfo

The IscsiPortInfo data object describes the Virtual NIC that are bound to an iSCSI adapter and also it describes the candidate Virtual NICs that can be bound to a given iSCSI adapter.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "vnicDevice": "string",
    "vnic": {
        "_typeName": "string",
        "device": "string",
        "key": "string",
        "portgroup": "string",
        "spec": {
            "_typeName": "string",
            "dynamicProperty": [
                {
                    "_typeName": "string",
                    "name": "string",
                    "val": {
                        "_typeName": "string"
                    }
                }
            ],
            "ip": {
                "_typeName": "string",
                "dhcp": false,
                "ipAddress": "string",
                "subnetMask": "string",
                "ipV6Config": {
                    "_typeName": "string",
                    "ipV6Address": [
                        {
                            "_typeName": "string",
                            "ipAddress": "string",
                            "prefixLength": 0,
                            "origin": "string",
                            "dadState": "string",
                            "lifetime": "string",
                            "operation": "string"
                        }
                    ],
                    "autoConfigurationEnabled": false,
                    "dhcpV6Enabled": false
                }
            },
            "mac": "string",
            "distributedVirtualPort": {
                "_typeName": "string",
                "switchUuid": "string",
                "portgroupKey": "string",
                "portKey": "string",
                "connectionCookie": 0
            },
            "portgroup": "string",
            "mtu": 0,
            "tsoEnabled": false,
            "netStackInstanceKey": "string",
            "opaqueNetwork": {
                "_typeName": "string",
                "opaqueNetworkId": "string",
                "opaqueNetworkType": "string"
            },
            "externalId": "string",
            "pinnedPnic": "string",
            "ipRouteSpec": {
                "_typeName": "string",
                "ipRouteConfig": {
                    "_typeName": "string",
                    "defaultGateway": "string",
                    "gatewayDevice": "string",
                    "ipV6DefaultGateway": "string",
                    "ipV6GatewayDevice": "string"
                }
            },
            "systemOwned": false,
            "dpuId": "string"
        },
        "port": "string",
        "owner": "string"
    },
    "pnicDevice": "string",
    "pnic": {
        "_typeName": "string",
        "key": "string",
        "device": "string",
        "pci": "string",
        "driver": "string",
        "driverVersion": "string",
        "firmwareVersion": "string",
        "linkSpeed": {
            "_typeName": "string",
            "speedMb": 0,
            "duplex": false
        },
        "validLinkSpecification": [
            {
                "_typeName": "string",
                "speedMb": 0,
                "duplex": false
            }
        ],
        "spec": {
            "_typeName": "string",
            "ip": {
                "_typeName": "string",
                "dhcp": false,
                "ipAddress": "string",
                "subnetMask": "string",
                "ipV6Config": {
                    "_typeName": "string",
                    "ipV6Address": [
                        {
                            "_typeName": "string",
                            "ipAddress": "string",
                            "prefixLength": 0,
                            "origin": "string",
                            "dadState": "string",
                            "lifetime": "string",
                            "operation": "string"
                        }
                    ],
                    "autoConfigurationEnabled": false,
                    "dhcpV6Enabled": false
                }
            },
            "linkSpeed": {
                "_typeName": "string",
                "speedMb": 0,
                "duplex": false
            },
            "enableEnhancedNetworkingStack": false,
            "ensInterruptEnabled": false
        },
        "wakeOnLanSupported": false,
        "mac": "string",
        "fcoeConfiguration": {
            "_typeName": "string",
            "priorityClass": 0,
            "sourceMac": "string",
            "vlanRange": [
                {
                    "_typeName": "string",
                    "vlanLow": 0,
                    "vlanHigh": 0
                }
            ],
            "capabilities": {
                "_typeName": "string",
                "priorityClass": false,
                "sourceMacAddress": false,
                "vlanRange": false
            },
            "fcoeActive": false
        },
        "vmDirectPathGen2Supported": false,
        "vmDirectPathGen2SupportedMode": "string",
        "resourcePoolSchedulerAllowed": false,
        "resourcePoolSchedulerDisallowedReason": [
            "string"
        ],
        "autoNegotiateSupported": false,
        "enhancedNetworkingStackSupported": false,
        "ensInterruptSupported": false,
        "rdmaDevice": "string",
        "dpuId": "string"
    },
    "switchName": "string",
    "switchUuid": "string",
    "portgroupName": "string",
    "portgroupKey": "string",
    "portKey": "string",
    "opaqueNetworkId": "string",
    "opaqueNetworkType": "string",
    "opaqueNetworkName": "string",
    "externalId": "string",
    "complianceStatus": {
        "_typeName": "string",
        "reason": [
            {
                "_typeName": "string",
                "faultCause": "MethodFault Object",
                "faultMessage": [
                    {
                        "_typeName": "string",
                        "key": "string",
                        "arg": [
                            {
                                "_typeName": "string",
                                "key": "string",
                                "value": {
                                    "_typeName": "string"
                                }
                            }
                        ],
                        "message": "string"
                    }
                ]
            }
        ]
    },
    "pathStatus": "string"
}
string
vnicDevice
Optional

Virtual NIC Name.

Contains the name of the Virtual NIC device. This may be unset in case where the bound Virtual NIC doesn't have the system object or where a candidate Physical NIC isn't associated with any Virtual NIC.

vnic
Optional

Virtual NIC Object corresponding to the vnicDevice.

May be unset if Virtual NIC object corresponding to vnicDevice doesn't exist in the system.

string
pnicDevice
Optional

Physical NIC Name.

pnic
Optional

Physical NIC Object corresponding to the pnicDevice.

May be unset if Physical NIC object corresponding to pnicDevice doesn't exist in the system or the vnicDevice doesn't have any Physical NIC associated with it.

string
switchName
Optional

Name of the virtual switch this Physical/Virtual NIC belongs.

May be unset if the vnicDevice and/or pnicDevice do not have a virtual switch associated with them.

string
switchUuid
Optional

UUID of the virtual switch this Physical/Virtual NIC belongs.

May be unset if the vnicDevice and/or pnicDevice do not have a virtual switch associated with them or the associated switch is not VDS.

string
portgroupName
Optional

Name of the portgroup to which this Virtual NIC belongs.

May be unset if the vnicDevice and/or pnicDevice do not have a Portgroup associated with them.

string
portgroupKey
Optional

Portgroup key to which this Virtual NIC belongs.

May be unset if the vnicDevice and/or pnicDevice do not have a Portgroup associated with them or the associated portgroup does is not of VDS type.

string
portKey
Optional

portkey to which this Virtual NIC belongs.

May be unset if the vnicDevice is not assigned to a specific port or the switch is not VDS.

string
opaqueNetworkId
Optional

ID of the Opaque network to which the virtual NIC is connected.

This property is set only when vnicDevice is associated with an opaque network.

string
opaqueNetworkType
Optional

Type of the Opaque network to which the virtual NIC is connected.

This property is set only when vnicDevice is associated with an opaque network.

string
opaqueNetworkName
Optional

Name of the Opaque network to which the virtual NIC is connected.

This property is set only when vnicDevice is associated with an opaque network.

string
externalId
Optional

An ID assigned to the vmkernel adapter by external management plane or controller.

This property is set only when vnicDevice is associated with an opaque network.

complianceStatus
Optional

Status indicating whether the Virtual NIC is compliant with the network policy that is required by iSCSI port binding.

May be unset in the candidate NIC list.

string
pathStatus
Optional

A status, as defined in IscsiPortInfoPathStatusEnum, indicating the existing storage paths dependency level on a given Virtual NIC.

May be unset in the candidate NIC list.