Managed Object - VsanRemoteDatastoreSystem(vim.cluster.VsanRemoteDatastoreSystem)

See also: ClusterComputeResource, Datastore, Task, VcRemoteVsanServerClusterInfo, VsanDatastoreSourcePrecheckResult, VsanHciMeshDatastoreSource, VsanMountPrecheckResult, VsanRemoteVcInfo, VsanXVCDatastoreInfo, VsanXvcQueryResultSet, VsanXvcQuerySpec
Since: vSAN API vSAN 7.0U1

Managed Object Description

The managed object provides support for vSAN remote datastore management operations. It can be accessed with MOID of 'vsan-remote-datastore-system', through vSAN service at vCenter server side.

Properties

Name	Type	Description
None

Methods

Methods defined in this Managed Object
MountPrecheck, RemoteVcMountPrecheck, VsanCreateDatastoreSource, VsanDestroyDatastoreSource, VsanPrecheckDatastoreSource, VsanQueryDatastoreSource, VsanQueryHciMeshDatastores, VsanUpdateDatastoreSource

MountPrecheck(mountPrecheck)

Checks mount compatibility of a vSAN datastore with given vSAN cluster. Get mount pre-check results of a client cluster and remote vSAN datastore. Different types of checks are needed, see VsanMountPrecheckResult for details.

Required Privileges: Host.Config.Storage

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanRemoteDatastoreSystem used to make the method call.
cluster P	ManagedObjectReference to a ClusterComputeResource	Client cluster that triggers the mount precheck request. *Since* vSAN API vSAN 7.0U1
datastore P	ManagedObjectReference to a Datastore	The server vSAN datastore to be checked for mount. *Since* vSAN API vSAN 7.0U1
serverClusterInfo* P	VcRemoteVsanServerClusterInfo	The server cluster information of the vSAN datastore to be checked for mount. It is only needed when the server cluster is a stretched cluster. *Since* vSAN API vSAN 7.0U1

*Need not be set PRequired privilege - see tooltip for details

Return Value

Type	Description
VsanMountPrecheckResult	Pre-check results of a client cluster mounting server vSAN datastore.

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.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="MountPrecheck" type="vsan:MountPrecheckRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="MountPrecheckResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:VsanMountPrecheckResult"/>
                     </sequence>
                  </complexType>
               </element>

RemoteVcMountPrecheck(remoteVcMountPrecheck)

Checks mount compatibility of a cross VC vSAN datastore with given vSAN cluster. Get mount pre-check results of a client cluster and cross VC remote vSAN datastore. Different types of checks are needed, see VsanMountPrecheckResult for details.

Required Privileges: Host.Config.Storage
Since: vSAN API 8.0.0.2

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

cluster P

ManagedObjectReference
to a ClusterComputeResource

Client cluster that trigger the mount precheck request.

Since vSAN API 8.0.0.2

xvcDatastore P

VsanXVCDatastoreInfo

Since vSAN API 8.0.0.2

PRequired privilege - see tooltip for details

Return Value

Type	Description
VsanMountPrecheckResult	Pre-check results of a client cluster mounting cross VC vSAN datastore.

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	vSAN related faults.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="RemoteVcMountPrecheck" type="vsan:RemoteVcMountPrecheckRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="RemoteVcMountPrecheckResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:VsanMountPrecheckResult"/>
                     </sequence>
                  </complexType>
               </element>

VsanCreateDatastoreSource(createDatastoreSource)

Create a new Datastore Source.

Required Privileges: Host.Config.Storage
Since: vSAN API 8.0.0.2

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

datastoreSource P

VsanHciMeshDatastoreSource

The information of the Datastore Source to be created. If the vCenter is an ELM linked vCenter, only vcHost needs to be specified. For a standalone vCenter, the user and password needs to be specified for an user credential with the privileges to create the service account.

Since vSAN API 8.0.0.2

P Required privilege: datastoreSource

Return Value

Type	Description
ManagedObjectReference to a Task	The task for creating Datastore Source operation.

Faults

Type	Description
AlreadyExists	Thrown if the Datastore Source being created has existed.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VsanFault	Other vSAN related faults.
VsanSslVerifyCertFault	SSL verification fault for remote vCenter such as certificate not verified.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanCreateDatastoreSource" type="vsan:VsanCreateDatastoreSourceRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanCreateDatastoreSourceResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:ManagedObjectReference"/>
                     </sequence>
                  </complexType>
               </element>

VsanDestroyDatastoreSource(destroyDatastoreSource)

Destroy an existing Datastore Source configuration.

Required Privileges: Host.Config.Storage
Since: vSAN API 8.0.0.2

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

datastoreSource P

VsanHciMeshDatastoreSource

The Datastore Source to be destroyed. If the vCenter is an ELM linked vCenter, only vcHost needs to be specified. For a standalone vCenter, the user and password needs to be specified for an user credential with the privileges to delete the service account.

Since vSAN API 8.0.0.2

P Required privilege: datastoreSource

Return Value

Type	Description
ManagedObjectReference to a Task	The task for destroying Datastore Source operation.

Faults

Type	Description
NotFound	The specified Datastore Source is not found.
ResourceInUse	The specified Datastore Source still has datastores being mounted.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VsanFault	Other vSAN related faults.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanDestroyDatastoreSource" type="vsan:VsanDestroyDatastoreSourceRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanDestroyDatastoreSourceResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:ManagedObjectReference"/>
                     </sequence>
                  </complexType>
               </element>

VsanPrecheckDatastoreSource(precheckDatastoreSource)

Run prechecks for a Datastore Source. This can be used before creating, updating, destroying a Datastore Source or other places needing to verify a Datastore Source.

Required Privileges: Host.Config.Storage
Since: vSAN API 8.0.0.2

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

datastoreSource P

VsanHciMeshDatastoreSource

The information of the Datastore Source to be prechecked.

Since vSAN API 8.0.0.2

operation* P

xsd:string

The hint of the operation which the precheck is performed against, see PrecheckDatastoreSourceOperation.

Since vSAN API 8.0.0.2

*Need not be set PRequired privilege - see tooltip for details

Return Value

Type	Description
VsanDatastoreSourcePrecheckResult	Pre-check results of the specified Datastore Source.

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	Other vSAN related faults.
VsanSslVerifyCertFault	SSL verification fault for remote vCenter such as certificate not verified.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanPrecheckDatastoreSource" type="vsan:VsanPrecheckDatastoreSourceRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanPrecheckDatastoreSourceResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:VsanDatastoreSourcePrecheckResult"/>
                     </sequence>
                  </complexType>
               </element>

VsanQueryDatastoreSource(queryDatastoreSource)

Query Datastore Source information for specified remote vCenters. If no vCenter is specified, all Datastore Sources configured are returned.

Required Privileges: Host.Config.Storage
Since: vSAN API 8.0.0.2

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

vcHosts* P

xsd:string[]

The names (e.g. FQDNs) of the remote vCenters to be queried. Only those names configured through vim.cluster.VsanRemoteDatastoreSystem#CreateDatastoreSource are valid to be used.

Since vSAN API 8.0.0.2

*Need not be set P Required privilege: vcHosts

Return Value

Type	Description
VsanHciMeshDatastoreSource[]	The Datastore Sources information queried.

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	vSAN related faults.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryDatastoreSource" type="vsan:VsanQueryDatastoreSourceRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryDatastoreSourceResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:VsanHciMeshDatastoreSource" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

VsanQueryHciMeshDatastores(queryHciMeshDatastores)

This method takes a list of VsanXvcQuerySpec, then returns a list of VsanXvcQueryResultSet. Each element of returned VsanXvcQueryResultSet list maps to the query spec in the VsanXvcQuerySpec list by index. Caller can provide a proper VsanXvcQuerySpec, and specify the required properties to be returned. The full list of the properties for each kind of returned object is described in VsanXvcQueryResultSet. Optionally, user can provide a list of remote VCs' information VsanRemoteVcInfo to specify the remote VC to query. The supported objects are listed in objectModel. Each item is one datastore's info mapping to the specified properties properties in spec.

Required Privileges: System.Read
Since: vSAN API 8.0.0.2

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

querySpecs* P

VsanXvcQuerySpec[]

The spec information to specify what to be queried.

Since vSAN API 8.0.0.2

extraVcInfos* P

VsanRemoteVcInfo[]

The remote vCenter information for communication if caller needs to explicitly specify a remote vCenter as a provider vCenter which is not configured as a Datastore Source configuration. The user credential needs to be provided in the remote vCenter information, e.g., use VsanRemoteVcInfoStandalone.

Since vSAN API 8.0.0.2

*Need not be set PRequired privilege - see tooltip for details

Return Value

Type	Description
VsanXvcQueryResultSet[]	The query result information per the query specs.

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	vSAN related faults.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryHciMeshDatastores" type="vsan:VsanQueryHciMeshDatastoresRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryHciMeshDatastoresResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:VsanXvcQueryResultSet" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

VsanUpdateDatastoreSource(updateDatastoreSource)

Update the configuration of an existing Datastore Source.

Required Privileges: Host.Config.Storage
Since: vSAN API 8.0.0.2

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

datastoreSource P

VsanHciMeshDatastoreSource

The information of the Datastore Source to be updated. The updated Datastore Source is identified by the vcHost specified in the remote vCenter info of this param. If the original or updated vCenter is a standalone vCenter, the user and password needs to be specified for an user credential with the privilege to update the service account. If both original and updated vCenters are ELM vCenters only vcHost needs to be specified.

Since vSAN API 8.0.0.2

P Required privilege: datastoreSource

Return Value

Type	Description
ManagedObjectReference to a Task	The task for updating Datastore Source operation.

Faults

Type	Description
NotFound	The specified Datastore Source is not 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	Other vSAN related faults.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanUpdateDatastoreSource" type="vsan:VsanUpdateDatastoreSourceRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanUpdateDatastoreSourceResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:ManagedObjectReference"/>
                     </sequence>
                  </complexType>
               </element>