HostInternetScsiHba

HostInternetScsiHba
HostInternetScsiHba

This data object type describes the iSCSI host bus adapter interface.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "key": "string",
    "device": "string",
    "bus": 0,
    "status": "string",
    "model": "string",
    "driver": "string",
    "pci": "string",
    "storageProtocol": "string",
    "isSoftwareBased": false,
    "canBeDisabled": false,
    "networkBindingSupport": "string",
    "discoveryCapabilities": {
        "_typeName": "string",
        "iSnsDiscoverySettable": false,
        "slpDiscoverySettable": false,
        "staticTargetDiscoverySettable": false,
        "sendTargetsDiscoverySettable": false
    },
    "discoveryProperties": {
        "_typeName": "string",
        "iSnsDiscoveryEnabled": false,
        "iSnsDiscoveryMethod": "string",
        "iSnsHost": "string",
        "slpDiscoveryEnabled": false,
        "slpDiscoveryMethod": "string",
        "slpHost": "string",
        "staticTargetDiscoveryEnabled": false,
        "sendTargetsDiscoveryEnabled": false
    },
    "authenticationCapabilities": {
        "_typeName": "string",
        "chapAuthSettable": false,
        "krb5AuthSettable": false,
        "srpAuthSettable": false,
        "spkmAuthSettable": false,
        "mutualChapSettable": false,
        "targetChapSettable": false,
        "targetMutualChapSettable": false
    },
    "authenticationProperties": {
        "_typeName": "string",
        "chapAuthEnabled": false,
        "chapName": "string",
        "chapSecret": "string",
        "chapAuthenticationType": "string",
        "chapInherited": false,
        "mutualChapName": "string",
        "mutualChapSecret": "string",
        "mutualChapAuthenticationType": "string",
        "mutualChapInherited": false
    },
    "digestCapabilities": {
        "_typeName": "string",
        "headerDigestSettable": false,
        "dataDigestSettable": false,
        "targetHeaderDigestSettable": false,
        "targetDataDigestSettable": false
    },
    "digestProperties": {
        "_typeName": "string",
        "headerDigestType": "string",
        "headerDigestInherited": false,
        "dataDigestType": "string",
        "dataDigestInherited": false
    },
    "ipCapabilities": {
        "_typeName": "string",
        "addressSettable": false,
        "ipConfigurationMethodSettable": false,
        "subnetMaskSettable": false,
        "defaultGatewaySettable": false,
        "primaryDnsServerAddressSettable": false,
        "alternateDnsServerAddressSettable": false,
        "ipv6Supported": false,
        "arpRedirectSettable": false,
        "mtuSettable": false,
        "hostNameAsTargetAddress": false,
        "nameAliasSettable": false,
        "ipv4EnableSettable": false,
        "ipv6EnableSettable": false,
        "ipv6PrefixLengthSettable": false,
        "ipv6PrefixLength": 0,
        "ipv6DhcpConfigurationSettable": false,
        "ipv6LinkLocalAutoConfigurationSettable": false,
        "ipv6RouterAdvertisementConfigurationSettable": false,
        "ipv6DefaultGatewaySettable": false,
        "ipv6MaxStaticAddressesSupported": 0
    },
    "ipProperties": {
        "_typeName": "string",
        "mac": "string",
        "address": "string",
        "dhcpConfigurationEnabled": false,
        "subnetMask": "string",
        "defaultGateway": "string",
        "primaryDnsServerAddress": "string",
        "alternateDnsServerAddress": "string",
        "ipv6Address": "string",
        "ipv6SubnetMask": "string",
        "ipv6DefaultGateway": "string",
        "arpRedirectEnabled": false,
        "mtu": 0,
        "jumboFramesEnabled": false,
        "ipv4Enabled": false,
        "ipv6Enabled": false,
        "ipv6properties": {
            "_typeName": "string",
            "iscsiIpv6Address": [
                {
                    "_typeName": "string",
                    "address": "string",
                    "prefixLength": 0,
                    "origin": "string",
                    "operation": "string"
                }
            ],
            "ipv6DhcpConfigurationEnabled": false,
            "ipv6LinkLocalAutoConfigurationEnabled": false,
            "ipv6RouterAdvertisementConfigurationEnabled": false,
            "ipv6DefaultGateway": "string"
        }
    },
    "supportedAdvancedOptions": [
        {
            "_typeName": "string",
            "label": "string",
            "summary": "string",
            "key": "string",
            "optionType": {
                "_typeName": "string",
                "valueIsReadonly": false
            }
        }
    ],
    "advancedOptions": [
        {
            "_typeName": "string",
            "key": "string",
            "value": {
                "_typeName": "string"
            },
            "isInherited": false
        }
    ],
    "iScsiName": "string",
    "iScsiAlias": "string",
    "configuredSendTarget": [
        {
            "_typeName": "string",
            "address": "string",
            "port": 0,
            "authenticationProperties": {
                "_typeName": "string",
                "chapAuthEnabled": false,
                "chapName": "string",
                "chapSecret": "string",
                "chapAuthenticationType": "string",
                "chapInherited": false,
                "mutualChapName": "string",
                "mutualChapSecret": "string",
                "mutualChapAuthenticationType": "string",
                "mutualChapInherited": false
            },
            "digestProperties": {
                "_typeName": "string",
                "headerDigestType": "string",
                "headerDigestInherited": false,
                "dataDigestType": "string",
                "dataDigestInherited": false
            },
            "supportedAdvancedOptions": [
                {
                    "_typeName": "string",
                    "label": "string",
                    "summary": "string",
                    "key": "string",
                    "optionType": {
                        "_typeName": "string",
                        "valueIsReadonly": false
                    }
                }
            ],
            "advancedOptions": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    },
                    "isInherited": false
                }
            ],
            "parent": "string"
        }
    ],
    "configuredStaticTarget": [
        {
            "_typeName": "string",
            "address": "string",
            "port": 0,
            "iScsiName": "string",
            "discoveryMethod": "string",
            "authenticationProperties": {
                "_typeName": "string",
                "chapAuthEnabled": false,
                "chapName": "string",
                "chapSecret": "string",
                "chapAuthenticationType": "string",
                "chapInherited": false,
                "mutualChapName": "string",
                "mutualChapSecret": "string",
                "mutualChapAuthenticationType": "string",
                "mutualChapInherited": false
            },
            "digestProperties": {
                "_typeName": "string",
                "headerDigestType": "string",
                "headerDigestInherited": false,
                "dataDigestType": "string",
                "dataDigestInherited": false
            },
            "supportedAdvancedOptions": [
                {
                    "_typeName": "string",
                    "label": "string",
                    "summary": "string",
                    "key": "string",
                    "optionType": {
                        "_typeName": "string",
                        "valueIsReadonly": false
                    }
                }
            ],
            "advancedOptions": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    },
                    "isInherited": false
                }
            ],
            "parent": "string"
        }
    ],
    "maxSpeedMb": 0,
    "currentSpeedMb": 0
}
boolean
isSoftwareBased
Required

True if this host bus adapter is a software based initiator utilizing the hosting system's existing TCP/IP network connection

boolean
canBeDisabled
Optional

Can this adapter be disabled

networkBindingSupport
Optional

The binding mode of the adapter.

Possible values:

  • notsupported
  • optional
  • required
Possible values are : notsupported, optional, required,
discoveryCapabilities
Required

The discovery capabilities for this host bus adapter.

At least one discovery mode must always be active. Multiple modes may be active at the same time.

discoveryProperties
Required

The discovery settings for this host bus adapter.

At least one discovery mode must always be active. Multiple modes may be active at the same time.

authenticationCapabilities
Required

The authentication capabilities for this host bus adapter.

authenticationProperties
Required

The authentication settings for this host bus adapter or target.

digestCapabilities
Optional

The digest capabilities for this host bus adapter.

digestProperties
Optional

The digest settings for this host bus adapter.

ipCapabilities
Required

The IP Capabilities for the host bus adapter

ipProperties
Required

The IP properties for the host bus adapter

array of OptionDef
supportedAdvancedOptions
Optional

A list of supported key/value pair advanced options for the host bus adapter including their type information.

advancedOptions
Optional

A list of the current options settings for the host bus adapter.

string
iScsiName
Required

The iSCSI name of this host bus adapter.

string
iScsiAlias
Optional

The iSCSI alias of this host bus adapter.

configuredSendTarget
Optional

The configured iSCSI send target entries.

configuredStaticTarget
Optional

The configured iSCSI static target entries.

integer As int32 As int32
maxSpeedMb
Optional

The maximum supported link speed of the port in megabits per second.

integer As int32 As int32
currentSpeedMb
Optional

The Current operating link speed of the port in megabits per second.