Vsan Vds System Vsan Vss Migrate Vds

Vsan Vds System Vsan Vss Migrate Vds

Perform a migration to convert the VDS instance in the cluster to a newly created VSS on each host.

The VSS preserves all settings of the VDS, and all consumers (vmknics, VM vNICs, pNICs) are considered as part of the migration. The VSS vSwitch and portgroup instances on the VDS are matched to each other by common name. It is expected that hosts have a uniform configuration. The VDS will be deleted if no hosts and virtual machines are connected to this VDS after the migration completes. If there are any inaccessible or orphaned VMs found, the migration will not be performed. This is a safety measure as such VMs may lose their networking. If there are any inaccessible hosts in the cluster the migration will fail as well.

This API requires DVSwitch.Delete and DVSwitch.Modify on vds, extra privilege check might be needed depends on what is being migrated.

  • Host.Inventory.EditCluster on cluster if hosts of the specified cluster to be migrated to the VDS
  • Host.Inventory.EditCluster on all the hosts specified in hosts parameter
Request
URI
POST
https://{api_host}/sdk/vim25/{release}/vsan/VsanVdsSystem/{moId}/VsanVssMigrateVds
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 VsanVdsSystem/{moId}.

string
release
Required

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

Request Body
VsanVssMigrateVdsRequestType of type(s) application/json
Required 
"VsanVssMigrateVdsRequestType Object"
cluster
Optional

Hosts of this cluster will be migrated from the specified VDS to the new VSS.

array of object
hosts
Optional

Individual hosts to be migrated from the VDS to the VSS.

vds
Required

The VDS which the hosts in the cluster are connected to.

string
vswitchName
Optional

Name of the new VSS to be migrated to.

array of string
vmnicDevices
Optional

Physical NICs that are currently unused to be attached to the new VSS.

array of object
infraVm
Optional

Infrastructure VMs that will be handled specially during migration.

Authentication
This operation uses the following authentication methods.
Responses
200

The task associated with the migration

Returns MoRefTask of type(s) application/json 
"MoRefTask Object"

500

NotFound: when specified cluster doesn't exist.

VsanFault: Any unexpected runtime error.

Returns VimFault of type(s) application/json
This response body class contains all of the following: InlineVimFault0 
"VimFault Object"

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/vsan/VsanVdsSystem/{moId}/VsanVssMigrateVds
On This Page
V San Service Api Operations
POST
Vsan Vds System Vsan Rollback Vds To Vss
POST
Vsan Vds System Vsan Vds Get Migration Plan
POST
Vsan Vds System Vsan Vds Migrate Vss
POST
Vsan Vds System Vsan Vss Migrate Vds