Managed Object - VsanSiteMaintenanceSystem(vim.vsan.VsanSiteMaintenanceSystem)

See also: ClusterComputeResource, Task, VsanSiteMaintenanceInfo, VsanSiteMaintenancePrecheckStatus, VsanSiteMaintenanceSpec
Since: vSphere API Release 9.1.0.0

Managed Object Description

This managed object type provides the vSAN fault domain maintenance operations. Fault domain maintenance is a vSAN specific operation that allows all hosts within a fault domain to enter maintenance mode while ensuring object consistency. This managed object provides the functionalities to run precheck, enter maintenance mode and exit maintenance mode. It can be accessed through MOID of 'vsan-cluster-site-maintenance-system', through vSAN service on vCenter at cluster level.

Properties

Name	Type	Description
None

Methods

Methods defined in this Managed Object
VsanEnterSiteMaintenanceMode, VsanExitSiteMaintenanceMode, VsanGetSiteMaintenancePrecheckStatus, VsanPerformSiteMaintenancePrecheck, VsanQueryClusterSiteMaintenanceState

VsanEnterSiteMaintenanceMode(enterSiteMaintenanceMode)

Put all hosts in a fault domain into maintenance mode. This operation puts the hosts on this fault domain into the maintenance mode, and guarantees the consistencies for all objects within this fault domain. A precheck will be performed as part of this fault domain maintenance workflow. Upon success, all VMs in this fault domain will be powered off or migrated to the other fault domain.

Required Privileges: Host.Config.Storage

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanSiteMaintenanceSystem used to make the method call.
faultDomainName	xsd:string	The fault domain name to enter maintenance mode. *Since* 9.0.0.0
cluster	ManagedObjectReference to a ClusterComputeResource	The cluster containing the fault domain to enter maintenance mode. *Since* 9.0.0.0

Name

Type

Description

_this

ManagedObjectReference

A reference to the VsanSiteMaintenanceSystem used to make the method call.

faultDomainName

xsd:string

The fault domain name to enter maintenance mode.

Since 9.0.0.0

cluster

ManagedObjectReference
to a ClusterComputeResource

The cluster containing the fault domain to enter maintenance mode.

Since 9.0.0.0

Return Value

Type	Description
ManagedObjectReference to a Task	The task tracking the enter fault domain maintenance workflow.

Faults

Type	Description
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="VsanEnterSiteMaintenanceMode" type="vsan:VsanEnterSiteMaintenanceModeRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanEnterSiteMaintenanceModeResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:ManagedObjectReference"/>
                     </sequence>
                  </complexType>
               </element>

VsanExitSiteMaintenanceMode(exitSiteMaintenanceMode)

Exit the fault domain maintenance mode. This operation exits the maintenance mode for all hosts in the specified fault domain. The objects will start the data resync during the host exit maintenance workflow. When the exit maintenance mode operation is successful, users can enable the intended workloads.

Required Privileges: Host.Config.Storage

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanSiteMaintenanceSystem used to make the method call.
faultDomainName	xsd:string	The fault domain name to exit maintenance mode. *Since* 9.0.0.0
cluster	ManagedObjectReference to a ClusterComputeResource	The cluster containing the fault domain to exit maintenance mode. *Since* 9.0.0.0

Name

Type

Description

_this

ManagedObjectReference

A reference to the VsanSiteMaintenanceSystem used to make the method call.

faultDomainName

xsd:string

The fault domain name to exit maintenance mode.

Since 9.0.0.0

cluster

ManagedObjectReference
to a ClusterComputeResource

The cluster containing the fault domain to exit maintenance mode.

Since 9.0.0.0

Return Value

Type	Description
ManagedObjectReference to a Task	The task tracking the exit fault domain maintenance mode workflow.

Faults

Type	Description
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="VsanExitSiteMaintenanceMode" type="vsan:VsanExitSiteMaintenanceModeRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanExitSiteMaintenanceModeResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:ManagedObjectReference"/>
                     </sequence>
                  </complexType>
               </element>

VsanGetSiteMaintenancePrecheckStatus(getSiteMaintenancePrecheckStatus)

Retrieves the result of the latest fault domain maintenance check. If a precheck task is running, its status will be returned. Otherwise the status of the last fault domain maintenance precheck will be returned.

Required Privileges: System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanSiteMaintenanceSystem used to make the method call.
cluster	ManagedObjectReference to a ClusterComputeResource	The specified cluster to query. *Since* 9.0.0.0
faultDomainName	xsd:string	The fault domain to query. *Since* 9.0.0.0

Name

Type

Description

_this

ManagedObjectReference

A reference to the VsanSiteMaintenanceSystem used to make the method call.

cluster

ManagedObjectReference
to a ClusterComputeResource

The specified cluster to query.

Since 9.0.0.0

faultDomainName

xsd:string

The fault domain to query.

Since 9.0.0.0

Return Value

Type	Description
VsanSiteMaintenancePrecheckStatus

Faults

Type	Description
InvalidArgument
ManagedObjectNotFound	Thrown if the cluster cannot be found.
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="VsanGetSiteMaintenancePrecheckStatus" type="vsan:VsanGetSiteMaintenancePrecheckStatusRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanGetSiteMaintenancePrecheckStatusResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:VsanSiteMaintenancePrecheckStatus"/>
                     </sequence>
                  </complexType>
               </element>

VsanPerformSiteMaintenancePrecheck(performSiteMaintenancePrecheck)

Initiates a precheck to determine if the target fault domain can enter maintenance mode. The precheck performs a health check and a "what-if" query to assess the impact on cluster resources (objects, VMs) once the proposed maintenance action is executed. Only one precheck should run in a vSAN cluster at a time.

Required Privileges: System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanSiteMaintenanceSystem used to make the method call.
cluster P	ManagedObjectReference to a ClusterComputeResource	The cluster on which to run the precheck. *Since* 9.0.0.0
spec	VsanSiteMaintenanceSpec	The specification of the queried fault domain maintenance action. *Since* 9.0.0.0

Name

Type

Description

_this

ManagedObjectReference

A reference to the VsanSiteMaintenanceSystem used to make the method call.

cluster P

ManagedObjectReference
to a ClusterComputeResource

The cluster on which to run the precheck.

Since 9.0.0.0

spec

VsanSiteMaintenanceSpec

The specification of the queried fault domain maintenance action.

Since 9.0.0.0

P Required privilege: Host.Config.Maintenance

Return Value

Type	Description
ManagedObjectReference to a Task

Faults

Type	Description
InvalidArgument
ManagedObjectNotFound	Thrown if the cluster cannot be found.
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="VsanPerformSiteMaintenancePrecheck" type="vsan:VsanPerformSiteMaintenancePrecheckRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanPerformSiteMaintenancePrecheckResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:ManagedObjectReference"/>
                     </sequence>
                  </complexType>
               </element>

VsanQueryClusterSiteMaintenanceState(queryClusterSiteMaintenanceState)

Query the maintenance state of all fault domains in the specified cluster.

Required Privileges: System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanSiteMaintenanceSystem used to make the method call.
cluster P	ManagedObjectReference to a ClusterComputeResource	The target cluster to query. *Since* 9.0.0.0

Name

Type

Description

_this

ManagedObjectReference

A reference to the VsanSiteMaintenanceSystem used to make the method call.

cluster P

ManagedObjectReference
to a ClusterComputeResource

The target cluster to query.

Since 9.0.0.0

P Required privilege: System.Read

Return Value

Type	Description
VsanSiteMaintenanceInfo[]	A list of SiteMaintenanceInfo objects, each representing the maintenance state of a fault domain in the target cluster. If the target cluster is not a stretched cluster, an empty list is returned.

Faults

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

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryClusterSiteMaintenanceState" type="vsan:VsanQueryClusterSiteMaintenanceStateRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryClusterSiteMaintenanceStateResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:VsanSiteMaintenanceInfo" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

vSAN Management API

Managed Object - VsanSiteMaintenanceSystem(vim.vsan.VsanSiteMaintenanceSystem)

Managed Object Description

VsanEnterSiteMaintenanceMode(enterSiteMaintenanceMode)

VsanExitSiteMaintenanceMode(exitSiteMaintenanceMode)

VsanGetSiteMaintenancePrecheckStatus(getSiteMaintenancePrecheckStatus)

VsanPerformSiteMaintenancePrecheck(performSiteMaintenancePrecheck)

VsanQueryClusterSiteMaintenanceState(queryClusterSiteMaintenanceState)