Host Storage System Remove Internet Scsi Send Targets

Removes Send Target entries from the host bus adapter discovery list.

The DiscoveryProperty.sendTargetsDiscoveryEnabled must be set to true. If any of the targets provided as parameters are not found in the existing list, the other targets are removed and an exception is thrown.

Required privileges: Host.Config.Storage

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/HostStorageSystem/{moId}/RemoveInternetScsiSendTargets

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.3.0 APIs.

Request Body

RemoveInternetScsiSendTargetsRequestType of type(s) application/json

Required

Show optional properties

{
    "iScsiHbaDevice": "string",
    "targets": [
        {
            "address": "string"
        }
    ]
}

{
    "iScsiHbaDevice": "string",
    "targets": [
        {
            "_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"
        }
    ],
    "force": false
}

string

iScsiHbaDevice

Required

The device of the Internet SCSI HBA adapter.

array of HostInternetScsiHbaSendTarget

targets

Required

An array of iSCSI send targets to remove.

boolean

force

Optional

flag for forced removal of iSCSI send targets. If unset, force flag will be treated as false.

Since: vSphere API Release 7.0.1.0

Authentication

This operation uses the following authentication methods.

Session

Responses

204

No Content

Operation doesn't return any data structure

500

NotFound: if at least one target was not 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

Description

Request

Path Parameters

Request Body

Authentication

Response

204 Response Body

Errors

Virtual Infrastructure Operations