Storage Pod Batch Add Standalone Hosts Task

Storage Pod Batch Add Standalone Hosts Task

Adds a list of hosts to inventory, as standalone hosts, in a single invocation.

The operation returns a result containing a list of hosts that are successfully added.

In addition to the Host.Inventory.AddStandaloneHost privilege, the operation requires System.View privilege on the VM folder that the VMs of the host will be placed on.

Required privileges: Host.Inventory.AddStandaloneHost

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

string
release
Required

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

Request Body
BatchAddStandaloneHostsRequestType of type(s) application/json
Required

Show optional properties

{
    "addConnected": false
}
{
    "newHosts": [
        {
            "_typeName": "string",
            "hostCnxSpec": {
                "_typeName": "string",
                "hostName": "string",
                "port": 0,
                "sslThumbprint": "string",
                "userName": "string",
                "password": "string",
                "vmFolder": {
                    "_typeName": "string",
                    "type": "string",
                    "value": "string"
                },
                "force": false,
                "vimAccountName": "string",
                "vimAccountPassword": "string",
                "managementIp": "string",
                "lockdownMode": "string",
                "hostGateway": {
                    "_typeName": "string",
                    "gatewayType": "string",
                    "gatewayId": "string",
                    "trustVerificationToken": "string",
                    "hostAuthParams": [
                        {
                            "_typeName": "string",
                            "key": "string",
                            "value": "string"
                        }
                    ]
                }
            },
            "esxLicense": "string"
        }
    ],
    "compResSpec": {
        "_typeName": "string",
        "vmSwapPlacement": "string",
        "spbmEnabled": false,
        "defaultHardwareVersionKey": "string",
        "desiredSoftwareSpec": {
            "_typeName": "string",
            "baseImageSpec": {
                "_typeName": "string",
                "version": "string"
            },
            "vendorAddOnSpec": {
                "_typeName": "string",
                "name": "string",
                "version": "string"
            },
            "components": [
                {
                    "_typeName": "string",
                    "name": "string",
                    "version": "string"
                }
            ],
            "removedComponents": [
                "string"
            ]
        },
        "maximumHardwareVersionKey": "string",
        "enableConfigManager": false,
        "hostSeedSpec": {
            "_typeName": "string",
            "singleHostSpec": {
                "_typeName": "string",
                "newHostCnxSpec": {
                    "_typeName": "string",
                    "hostName": "string",
                    "port": 0,
                    "sslThumbprint": "string",
                    "userName": "string",
                    "password": "string",
                    "vmFolder": {
                        "_typeName": "string",
                        "type": "string",
                        "value": "string"
                    },
                    "force": false,
                    "vimAccountName": "string",
                    "vimAccountPassword": "string",
                    "managementIp": "string",
                    "lockdownMode": "string",
                    "hostGateway": {
                        "_typeName": "string",
                        "gatewayType": "string",
                        "gatewayId": "string",
                        "trustVerificationToken": "string",
                        "hostAuthParams": [
                            {
                                "_typeName": "string",
                                "key": "string",
                                "value": "string"
                            }
                        ]
                    }
                },
                "existingHost": {
                    "_typeName": "string",
                    "type": "string",
                    "value": "string"
                }
            }
        }
    },
    "addConnected": false
}
array of FolderNewHostSpec
newHosts
Optional

Specifies a list of host specifications for new hosts.

ComputeResourceConfigSpec
compResSpec
Optional

Changes to apply to the compute resource configuration.

boolean
addConnected
Required

Flag to specify whether or not hosts should be connected at the time they are added. A host will not be added if a connection attempt is made and fails.

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"
}

On This Page
Virtual Infrastructure Operations
POST
Storage Pod Add Standalone Host Task
POST
Storage Pod Batch Add Hosts To Cluster Task
POST
Storage Pod Batch Add Standalone Hosts Task
POST
Storage Pod Create Cluster
POST
Storage Pod Create Cluster Ex
POST
Storage Pod Create Datacenter
POST
Storage Pod Create DVS Task
POST
Storage Pod Create Folder
POST
Storage Pod Create Storage Pod
POST
Storage Pod Create VM Task
POST
Storage Pod Destroy Task
GET
Storage Pod Get Alarm Actions Enabled
GET
Storage Pod Get Available Field
GET
Storage Pod Get Child Entity
GET
Storage Pod Get Child Type
GET
Storage Pod Get Config Issue
GET
Storage Pod Get Config Status
GET
Storage Pod Get Custom Value
GET
Storage Pod Get Declared Alarm State
GET
Storage Pod Get Disabled Method
GET
Storage Pod Get Effective Role
GET
Storage Pod Get Name
GET
Storage Pod Get Namespace
GET
Storage Pod Get Overall Status
GET
Storage Pod Get Parent
GET
Storage Pod Get Permission
GET
Storage Pod Get Pod Storage Drs Entry
GET
Storage Pod Get Recent Task
GET
Storage Pod Get Summary
GET
Storage Pod Get Tag
GET
Storage Pod Get Triggered Alarm State
GET
Storage Pod Get Value
POST
Storage Pod Move Into Folder Task
POST
Storage Pod Register VM Task
POST
Storage Pod Reload
POST
Storage Pod Rename Task
POST
Storage Pod Set Custom Value
POST
Storage Pod Unregister And Destroy Task