Managed Object - VimHostVsanStretchedClusterSystem(vim.host.VsanStretchedClusterSystem)

See also: VimHostVSANCmmdsPreferredFaultDomainInfo, VimHostVSANStretchedClusterHostCapability, VimHostVSANStretchedClusterHostInfo
Since: vSphere API 6.0

Managed Object Description

Properties

Name	Type	Description
None

Methods

Methods defined in this Managed Object
VSANClusterGetPreferredFaultDomain, VSANHostAddUnicastAgent, VSANHostGetStretchedClusterCapability, VSANHostGetStretchedClusterInfoFromCmmds, VSANHostListUnicastAgent, VSANHostRemoveUnicastAgent, VSANWitnessJoinVsanCluster, VSANWitnessLeaveVsanCluster, VSANWitnessSetPreferredFaultDomain

VSANClusterGetPreferredFaultDomain(clusterGetPreferredFaultDomain)

ClusterGetPreferredFaultDomain - Get preferred fault domain info for a stretched cluster.

Required Privileges: System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VimHostVsanStretchedClusterSystem used to make the method call.

Return Value

Type	Description
VimHostVSANCmmdsPreferredFaultDomainInfo	VSANCmmdsPreferredFaultDomainInfo

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:vim25="urn:vim25" name="VSANClusterGetPreferredFaultDomain" type="vim25:VSANClusterGetPreferredFaultDomainRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="VSANClusterGetPreferredFaultDomainResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:VimHostVSANCmmdsPreferredFaultDomainInfo" minOccurs="0"/>
               </sequence>
            </complexType>
         </element>

VSANHostAddUnicastAgent(addUnicastAgent)

AddUnicastAgent - Add unicast agent address(witness host address) to HostSystem. When overwrite is set to true, it will simply overwrite existing unicast agent address if any. If not set, "overwrite" will take default value false.

Required Privileges: System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VimHostVsanStretchedClusterSystem used to make the method call.
witnessAddress	xsd:string
witnessPort*	xsd:int	*Since* vSphere API 6.0
overwrite*	xsd:boolean	*Since* vSphere API 6.0

*Need not be set

Return Value

Type	Description
None

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:vim25="urn:vim25" name="VSANHostAddUnicastAgent" type="vim25:VSANHostAddUnicastAgentRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="VSANHostAddUnicastAgentResponse">
            <complexType/>
         </element>

VSANHostGetStretchedClusterCapability(getStretchedClusterCapability)

GetStretchedClusterCapability - Get the capability of stretched cluster installed on the host. Currently only version "1.0" is returned. It might be changed when finalizing the versioning method.

Required Privileges: System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VimHostVsanStretchedClusterSystem used to make the method call.

Return Value

Type	Description
VimHostVSANStretchedClusterHostCapability	vim.host.VSANStretchedClusterHostCapability

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:vim25="urn:vim25" name="VSANHostGetStretchedClusterCapability" type="vim25:VSANHostGetStretchedClusterCapabilityRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="VSANHostGetStretchedClusterCapabilityResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:VimHostVSANStretchedClusterHostCapability"/>
               </sequence>
            </complexType>
         </element>

VSANHostGetStretchedClusterInfoFromCmmds(getStretchedClusterInfoFromCmmds)

GetStretchedClusterInfoFromCmmds - Get stretched cluster information by querying CMMDS on a host

Required Privileges: System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VimHostVsanStretchedClusterSystem used to make the method call.

Return Value

Type	Description
VimHostVSANStretchedClusterHostInfo[]	Array of collected stretched cluster info from CMMDS

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:vim25="urn:vim25" name="VSANHostGetStretchedClusterInfoFromCmmds" type="vim25:VSANHostGetStretchedClusterInfoFromCmmdsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="VSANHostGetStretchedClusterInfoFromCmmdsResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:VimHostVSANStretchedClusterHostInfo" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

VSANHostListUnicastAgent(listUnicastAgent)

ListUnicastAgent - List existing unicast agent configured on non-witness host

Required Privileges: System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VimHostVsanStretchedClusterSystem used to make the method call.

Return Value

Type	Description
xsd:string	string representation of unicast agent

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:vim25="urn:vim25" name="VSANHostListUnicastAgent" type="vim25:VSANHostListUnicastAgentRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="VSANHostListUnicastAgentResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="xsd:string"/>
               </sequence>
            </complexType>
         </element>

VSANHostRemoveUnicastAgent(removeUnicastAgent)

RemoveUnicastAgent - Remove unicast agent address(witness host address) from the host. If ignoreExistence is set to true, it will not throw any error when there is no such unicast agent address. If not set, it will take the default value false.

Required Privileges: System.Read

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

witnessAddress

xsd:string

ignoreExistence*

xsd:boolean

Since vSphere API 6.0

*Need not be set

Return Value

Type	Description
None

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:vim25="urn:vim25" name="VSANHostRemoveUnicastAgent" type="vim25:VSANHostRemoveUnicastAgentRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="VSANHostRemoveUnicastAgentResponse">
            <complexType/>
         </element>

VSANWitnessJoinVsanCluster(witnessJoinVsanCluster)

WitnessJoinVsanCluster - Add a host as witness node to Virtual SAN cluster. The new node must be connected and managed by current vCenter Server, and not part of current vc cluster. When disableVsanAllowed is true, and when witness host is current have Virtual SAN enabled, it will first disable the Vsan on the cluster. Otherwise it will throw exceptions. If the disableVsanAllowed is not set, it will take its default value False.

Required Privileges: System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VimHostVsanStretchedClusterSystem used to make the method call.
clusterUuid	xsd:string
preferredFd	xsd:string
disableVsanAllowed*	xsd:boolean	*Since* vSphere API 6.0

*Need not be set

Return Value

Type	Description
None

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:vim25="urn:vim25" name="VSANWitnessJoinVsanCluster" type="vim25:VSANWitnessJoinVsanClusterRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="VSANWitnessJoinVsanClusterResponse">
            <complexType/>
         </element>

VSANWitnessLeaveVsanCluster(witnessLeaveVsanCluster)

WitnessLeaveVsanCluster - Remove a host from Virtual SAN cluster.

Required Privileges: System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VimHostVsanStretchedClusterSystem used to make the method call.

Return Value

Type	Description
None

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:vim25="urn:vim25" name="VSANWitnessLeaveVsanCluster" type="vim25:VSANWitnessLeaveVsanClusterRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="VSANWitnessLeaveVsanClusterResponse">
            <complexType/>
         </element>

VSANWitnessSetPreferredFaultDomain(witnessSetPreferredFaultDomain)

WitnessSetPreferredFaultDomain - Set preferred fault domain for a stretched cluster.

Required Privileges: System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VimHostVsanStretchedClusterSystem used to make the method call.
preferredFd	xsd:string

Return Value

Type	Description
None

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:vim25="urn:vim25" name="VSANWitnessSetPreferredFaultDomain" type="vim25:VSANWitnessSetPreferredFaultDomainRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="VSANWitnessSetPreferredFaultDomainResponse">
            <complexType/>
         </element>