vSAN Management API

			Local Methods
Managed Object Types	Data Object Types	All Properties	All Methods

Managed Object - VsanVcsaDeployerSystem(vim.host.VsanVcsaDeployerSystem)

See also

VsanPrepareVsanForVcsaSpec, VsanVcPostDeployConfigSpec, VsanVcsaDeploymentProgress

Since

vSphere API 6.5

Managed Object Description

Deployment engine that allows the deploy of VCSA (Virtual Center Service Appliance) onto a vSAN datastore. The Managed Entity can be accessed through MOID of vsan-vcsa-deployer-system at vCenter server and ESXi host side.

Properties

Name	Type	Description
None

Methods

Methods defined in this Managed Object
VsanPostConfigForVcsa, VsanPrepareVsanForVcsa, VsanVcsaGetBootstrapProgress

VsanPostConfigForVcsa(postConfigForVcsa)

Deployment engine that allows the deploy of VCSA (Virtual Center Service Appliance) onto a vSAN datastore. vSAN is bootstrapped as part of this process onto the local host as a single node vSAN cluster, VCSA is deployed onto the vSAN datastore, then vCenter is configured with a datacenter, a cluster, and the local host is added to that cluster to complete a fully configured vSAN cluster in Virtual Center.

Combined Privileges Required (on vSphere ManagedEntity):

Privileges	Required on
Host.Inventory.EditCluster	RootFolder

* The RootFolder entity in above table refers to the vCenter server itself in the vCenter UI
* The ClusterComputeResource entity in above table refers to the cluster which is being operated on

* The Required Privileges section below is not used, please ignore.

Required Privileges

Host.Inventory.EditCluster

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanVcsaDeployerSystem used to make the method call.
spec P	VsanVcPostDeployConfigSpec	Bootstrap specification Since vSphere API 6.5

P Required privilege: spec

Return Value

Type	Description
xsd:string	Unique Identifier for the background operation that can be used with VsanVcsaGetBootstrapProgress().

Faults

Type	Description
NotFound
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VsanFault

Events

Type
None

Show WSDL type definition

<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanPostConfigForVcsa" type="vsan:VsanPostConfigForVcsaRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanPostConfigForVcsaResponse"> <complexType> <sequence> <element name="returnval" type="xsd:string" minOccurs="0"/> </sequence> </complexType> </element>

VsanPrepareVsanForVcsa(prepareVsanForVcsa)

Deployment engine that allows the deploy of VCSA (Virtual Center Service Appliance) onto a vSAN datastore. vSAN is bootstrapped as part of this process onto the local host as a single node vSAN cluster, VCSA is deployed onto the vSAN datastore, then vCenter is configured with a datacenter, a cluster, and the local host is added to that cluster to complete a fully configured vSAN cluster in Virtual Center. Note: Must be called on an ESXi host

Required Privileges

VirtualMachine.Inventory.Create

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanVcsaDeployerSystem used to make the method call.
spec P	VsanPrepareVsanForVcsaSpec	Bootstrap specification Since vSphere API 6.5

P Required privilege: spec

Return Value

Type	Description
xsd:string	Unique Identifier for the background operation that can be used with VsanVcsaGetBootstrapProgress().

Faults

Type	Description
NotFound
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VsanFault

Events

Type
None

Show WSDL type definition

<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanPrepareVsanForVcsa" type="vsan:VsanPrepareVsanForVcsaRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanPrepareVsanForVcsaResponse"> <complexType> <sequence> <element name="returnval" type="xsd:string" minOccurs="0"/> </sequence> </complexType> </element>

VsanVcsaGetBootstrapProgress(vcsaGetBootstrapProgress)

Fetch the detailed progress of a running or recently completed VCSA deployment task.

Combined Privileges Required (on vSphere ManagedEntity):

Privileges	Required on
System.Read	RootFolder

* The RootFolder entity in above table refers to the vCenter server itself in the vCenter UI
* The ClusterComputeResource entity in above table refers to the cluster which is being operated on

* The Required Privileges section below is not used, please ignore.

Required Privileges

System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanVcsaDeployerSystem used to make the method call.
taskId P	xsd:string[]	List of unique task identifier returned by VsanPostConfigForVcsa() Since vSphere API 6.5

P Required privilege: taskId

Return Value

Type	Description
VsanVcsaDeploymentProgress[]	Detailed progress report for each requested task

Faults

Type	Description
NotFound
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VsanFault

Events

Type
None

Show WSDL type definition

<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVcsaGetBootstrapProgress" type="vsan:VsanVcsaGetBootstrapProgressRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVcsaGetBootstrapProgressResponse"> <complexType> <sequence> <element name="returnval" type="vsan:VsanVcsaDeploymentProgress" maxOccurs="unbounded"/> </sequence> </complexType> </element>

Top of page			Local Methods
Managed Object Types	Data Object Types	All Properties	All Methods