Host Storage System Update Internet Scsi Authentication Properties

Host Storage System Update Internet Scsi Authentication Properties

Updates the authentication properties for one or more targets or discovery addresses associated with an iSCSI host bus adapter.

Required privileges: Host.Config.Storage

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/HostStorageSystem/{moId}/UpdateInternetScsiAuthenticationProperties
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case HostStorageSystem/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.

Request Body
UpdateInternetScsiAuthenticationPropertiesRequestType of type(s) application/json
Required 
{
    "iScsiHbaDevice": "string",
    "authenticationProperties": {
        "_typeName": "string",
        "chapAuthEnabled": false,
        "chapName": "string",
        "chapSecret": "string",
        "chapAuthenticationType": "string",
        "chapInherited": false,
        "mutualChapName": "string",
        "mutualChapSecret": "string",
        "mutualChapAuthenticationType": "string",
        "mutualChapInherited": false
    },
    "targetSet": {
        "_typeName": "string",
        "staticTargets": [
            {
                "_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"
            }
        ],
        "sendTargets": [
            {
                "_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"
            }
        ]
    }
}
string
iScsiHbaDevice
Required

The device of the Internet SCSI HBA adapter. associated with the target.

HostInternetScsiHbaAuthenticationProperties
authenticationProperties
Required

The authentication settings for this host bus adapter or target.

HostInternetScsiHbaTargetSet
targetSet
Optional

A collection of one or more static targets or discovery addresses.

At least one of the arrays must be non-empty.

Authentication
This operation uses the following authentication methods.
Responses
204

No Content

Operation doesn't return any data structure

500

NotFound: if the host bus adapter could not be found.

HostConfigFault: for all other configuration failures.

Returns VimFault of type(s) application/json
This response body class contains all of the following: MethodFault 
{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

On This Page
Host Storage System Operations
POST
Host Storage System Add Internet Scsi Send Targets
POST
Host Storage System Add Internet Scsi Static Targets
POST
Host Storage System Attach Scsi Lun
POST
Host Storage System Attach Scsi Lun Ex Task
POST
Host Storage System Attach Vmfs Extent
POST
Host Storage System Change NFS User Password
POST
Host Storage System Clear NFS User
POST
Host Storage System Compute Disk Partition Info
POST
Host Storage System Compute Disk Partition Info For Resize
POST
Host Storage System Connect Nvme Controller
POST
Host Storage System Connect Nvme Controller Ex Task
POST
Host Storage System Create Nvme Over Rdma Adapter
POST
Host Storage System Create Software Adapter
POST
Host Storage System Delete Scsi Lun State
POST
Host Storage System Delete Vffs Volume State
POST
Host Storage System Delete Vmfs Volume State
POST
Host Storage System Destroy Vffs
POST
Host Storage System Detach Scsi Lun
POST
Host Storage System Detach Scsi Lun Ex Task
POST
Host Storage System Disable Multipath Path
POST
Host Storage System Disconnect Nvme Controller
POST
Host Storage System Disconnect Nvme Controller Ex Task
POST
Host Storage System Discover Fcoe Hbas
POST
Host Storage System Discover Nvme Controllers
POST
Host Storage System Enable Multipath Path
POST
Host Storage System Expand Vmfs Extent
POST
Host Storage System Extend Vffs
POST
Host Storage System Format Vffs
POST
Host Storage System Format Vmfs
GET
Host Storage System Get Available Field
GET
Host Storage System Get File System Volume Info
GET
Host Storage System Get Multipath State Info
GET
Host Storage System Get Storage Device Info
GET
Host Storage System Get System File
GET
Host Storage System Get Value
POST
Host Storage System Mark As Local Task
POST
Host Storage System Mark As Non Local Task
POST
Host Storage System Mark As Non Ssd Task
POST
Host Storage System Mark As Ssd Task
POST
Host Storage System Mark For Removal
POST
Host Storage System Mark Perennially Reserved
POST
Host Storage System Mark Perennially Reserved Ex Task
POST
Host Storage System Mount Vffs Volume
POST
Host Storage System Mount Vmfs Volume
POST
Host Storage System Mount Vmfs Volume Ex Task
POST
Host Storage System Query Available Ssds
POST
Host Storage System Query NFS User
POST
Host Storage System Query Path Selection Policy Options
POST
Host Storage System Query Storage Array Type Policy Options
POST
Host Storage System Query Unresolved Vmfs Volume
POST
Host Storage System Query Vmfs Config Option
POST
Host Storage System Refresh Storage System
POST
Host Storage System Remove Internet Scsi Send Targets
POST
Host Storage System Remove Internet Scsi Static Targets
POST
Host Storage System Remove Nvme Over Rdma Adapter
POST
Host Storage System Remove Software Adapter
POST
Host Storage System Rescan All Hba
POST
Host Storage System Rescan Hba
POST
Host Storage System Rescan Vffs
POST
Host Storage System Rescan Vmfs
POST
Host Storage System Resolve Multiple Unresolved Vmfs Volumes
POST
Host Storage System Resolve Multiple Unresolved Vmfs Volumes Ex Task
POST
Host Storage System Retrieve Disk Partition Info
POST
Host Storage System Set Custom Value
POST
Host Storage System Set Multipath Lun Policy
POST
Host Storage System Set NFS User
POST
Host Storage System Turn Disk Locator Led Off Task
POST
Host Storage System Turn Disk Locator Led On Task
POST
Host Storage System Unmap Vmfs Volume Ex Task
POST
Host Storage System Unmount Force Mounted Vmfs Volume
POST
Host Storage System Unmount Vffs Volume
POST
Host Storage System Unmount Vmfs Volume
POST
Host Storage System Unmount Vmfs Volume Ex Task
POST
Host Storage System Update Disk Partitions
POST
Host Storage System Update Hpp Multipath Lun Policy
POST
Host Storage System Update Internet Scsi Advanced Options
POST
Host Storage System Update Internet Scsi Alias
POST
Host Storage System Update Internet Scsi Authentication Properties
POST
Host Storage System Update Internet Scsi Digest Properties
POST
Host Storage System Update Internet Scsi Discovery Properties
POST
Host Storage System Update Internet Scsi IP Properties
POST
Host Storage System Update Internet Scsi Name
POST
Host Storage System Update Scsi Lun Display Name
POST
Host Storage System Update Software Internet Scsi Enabled
POST
Host Storage System Update Vmfs Unmap Bandwidth
POST
Host Storage System Update Vmfs Unmap Priority
POST
Host Storage System Upgrade Vmfs
POST
Host Storage System Upgrade Vm Layout