Host Vsan System Update Vsan Task

Host Vsan System Update Vsan Task

Update the VSAN service on this host according to the given host configuration specification.

Enabling and disabling the VSAN service can be achieved by using the enabled flag. Host storage settings can be specified through use of storageInfo. If this value is omitted, changes will not be made to the existing storage configuration. Host cluster settings can be specified through use of clusterInfo. If this value is omitted, changes will not be made to the existing cluster configuration. Host network settings can be specified through use of networkInfo. If this value is omitted, changes will not be made to the existing network configuration.

See also VsanHostConfigInfo, storageInfo, clusterInfo, networkInfo, QueryDisksForVsan.

Required privileges: Host.Config.Storage

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/HostVsanSystem/{moId}/UpdateVsan_Task
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 HostVsanSystem/{moId}.

string
release
Required

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


Request Body
UpdateVsanRequestType of type(s) application/json
Required
{
    "config": {
        "enabled": false,
        "hostSystem": {
            "type": "string",
            "value": "string"
        },
        "clusterInfo": {
            "uuid": "string",
            "nodeUuid": "string"
        },
        "storageInfo": {
            "autoClaimStorage": false,
            "diskMapping": [
                {
                    "_typeName": "string",
                    "ssd": {
                        "capacity": {
                            "blockSize": 0,
                            "block": 0
                        },
                        "devicePath": "string",
                        "ssd": false,
                        "localDisk": false,
                        "physicalLocation": [
                            "string"
                        ],
                        "emulatedDIXDIFEnabled": false,
                        "vsanDiskInfo": {
                            "vsanUuid": "string",
                            "formatVersion": 0
                        },
                        "scsiDiskType": "string"
                    },
                    "nonSsd": [
                        {
                            "_typeName": "string",
                            "deviceName": "string",
                            "deviceType": "string",
                            "key": "string",
                            "uuid": "string",
                            "descriptor": [
                                {
                                    "_typeName": "string",
                                    "quality": "string",
                                    "id": "string"
                                }
                            ],
                            "canonicalName": "string",
                            "displayName": "string",
                            "lunType": "string",
                            "vendor": "string",
                            "model": "string",
                            "revision": "string",
                            "scsiLevel": 0,
                            "serialNumber": "string",
                            "durableName": {
                                "namespace": "string",
                                "namespaceId": 0,
                                "data": [
                                    0
                                ]
                            },
                            "alternateName": [
                                {
                                    "_typeName": "string",
                                    "namespace": "string",
                                    "namespaceId": 0,
                                    "data": [
                                        0
                                    ]
                                }
                            ],
                            "standardInquiry": [
                                0
                            ],
                            "queueDepth": 0,
                            "operationalState": [
                                "string"
                            ],
                            "capabilities": {
                                "updateDisplayNameSupported": false
                            },
                            "vStorageSupport": "string",
                            "protocolEndpoint": false,
                            "perenniallyReserved": false,
                            "clusteredVmdkSupported": false,
                            "applicationProtocol": "string",
                            "dispersedNs": false,
                            "capacity": {
                                "blockSize": 0,
                                "block": 0
                            },
                            "devicePath": "string",
                            "ssd": false,
                            "localDisk": false,
                            "physicalLocation": [
                                "string"
                            ],
                            "emulatedDIXDIFEnabled": false,
                            "vsanDiskInfo": {
                                "vsanUuid": "string",
                                "formatVersion": 0
                            },
                            "scsiDiskType": "string"
                        }
                    ]
                }
            ],
            "diskMapInfo": [
                {
                    "_typeName": "string",
                    "mapping": {
                        "ssd": {
                            "capacity": {
                                "blockSize": 0,
                                "block": 0
                            },
                            "devicePath": "string",
                            "ssd": false,
                            "localDisk": false,
                            "physicalLocation": [
                                "string"
                            ],
                            "emulatedDIXDIFEnabled": false,
                            "vsanDiskInfo": {
                                "vsanUuid": "string",
                                "formatVersion": 0
                            },
                            "scsiDiskType": "string"
                        },
                        "nonSsd": [
                            {
                                "_typeName": "string",
                                "deviceName": "string",
                                "deviceType": "string",
                                "key": "string",
                                "uuid": "string",
                                "descriptor": [
                                    {
                                        "_typeName": "string",
                                        "quality": "string",
                                        "id": "string"
                                    }
                                ],
                                "canonicalName": "string",
                                "displayName": "string",
                                "lunType": "string",
                                "vendor": "string",
                                "model": "string",
                                "revision": "string",
                                "scsiLevel": 0,
                                "serialNumber": "string",
                                "durableName": {
                                    "namespace": "string",
                                    "namespaceId": 0,
                                    "data": [
                                        0
                                    ]
                                },
                                "alternateName": [
                                    {
                                        "_typeName": "string",
                                        "namespace": "string",
                                        "namespaceId": 0,
                                        "data": [
                                            0
                                        ]
                                    }
                                ],
                                "standardInquiry": [
                                    0
                                ],
                                "queueDepth": 0,
                                "operationalState": [
                                    "string"
                                ],
                                "capabilities": {
                                    "updateDisplayNameSupported": false
                                },
                                "vStorageSupport": "string",
                                "protocolEndpoint": false,
                                "perenniallyReserved": false,
                                "clusteredVmdkSupported": false,
                                "applicationProtocol": "string",
                                "dispersedNs": false,
                                "capacity": {
                                    "blockSize": 0,
                                    "block": 0
                                },
                                "devicePath": "string",
                                "ssd": false,
                                "localDisk": false,
                                "physicalLocation": [
                                    "string"
                                ],
                                "emulatedDIXDIFEnabled": false,
                                "vsanDiskInfo": {
                                    "vsanUuid": "string",
                                    "formatVersion": 0
                                },
                                "scsiDiskType": "string"
                            }
                        ]
                    },
                    "mounted": false
                }
            ],
            "checksumEnabled": false
        },
        "networkInfo": {
            "port": [
                {
                    "_typeName": "string",
                    "ipConfig": {
                        "upstreamIpAddress": "string",
                        "downstreamIpAddress": "string"
                    },
                    "device": "string"
                }
            ]
        },
        "faultDomainInfo": {
            "name": "string"
        },
        "vsanEsaEnabled": false
    }
}
config
Required

The VsanHostConfigInfo data object contains host-specific settings for the VSAN service.

This data object is used both for specifying settings for updating the VSAN service, and as an output datatype when retrieving current VSAN service settings.

Authentication
This operation uses the following authentication methods.
Responses
200

This method returns a Task object with which to monitor the operation.

Returns MoRefTask of type(s) application/json
This response body class contains all of the following: MoRefExtensibleManagedObject
{
    "_typeName": "string",
    "type": "string",
    "value": "string"
}