Managed Object - VsanFileServiceSystem(vim.vsan.VsanFileServiceSystem)

See also: ClusterComputeResource, FileShareQueryResult, Network, Task, VsanFileServiceDomain, VsanFileServiceDomainConfig, VsanFileServiceDomainQuerySpec, VsanFileServiceOvfSpec, VsanFileServicePreflightCheckResult, VsanFileShareConfig, VsanFileShareQuerySpec, VsanFileShareSnapshotConfig, VsanFileShareSnapshotQueryResult, VsanFileShareSnapshotQuerySpec
Since: vSAN API 7.0

Managed Object Description

This managed object type provides the file service related configuration and query APIs. It can be accessed through MOID of 'vsan-cluster-file-service-system', through vSAN service on vCenter at cluster level, or accessed through MOID of 'vsan-file-service-system' on ESXi host for the detailed operation.

Properties

Name	Type	Description
None

Methods

Methods defined in this Managed Object
VsanClusterCreateFsDomain, VsanClusterCreateShareSnapshot, VsanClusterQueryFileShares, VsanClusterQueryFsDomains, VsanClusterQueryShareSnapshots, VsanClusterReconfigureFsDomain, VsanClusterRemoveFsDomain, VsanClusterRemoveShare, VsanClusterRemoveShareSnapshot, VsanCreateFileShare, VsanDownloadFileServiceOvf, VsanFindOvfDownloadUrl, VsanPerformFileServiceEnablePreflightCheck, VsanQueryFileServiceOvfs, VsanRebalanceFileService, VsanReconfigureFileShare, VsanUpgradeFsvm

Methods defined in this Managed Object

VsanClusterCreateFsDomain, VsanClusterCreateShareSnapshot, VsanClusterQueryFileShares, VsanClusterQueryFsDomains, VsanClusterQueryShareSnapshots, VsanClusterReconfigureFsDomain, VsanClusterRemoveFsDomain, VsanClusterRemoveShare, VsanClusterRemoveShareSnapshot, VsanCreateFileShare, VsanDownloadFileServiceOvf, VsanFindOvfDownloadUrl, VsanPerformFileServiceEnablePreflightCheck, VsanQueryFileServiceOvfs, VsanRebalanceFileService, VsanReconfigureFileShare, VsanUpgradeFsvm

VsanClusterCreateFsDomain(createFileServiceDomain)

Creates a file service domain in the vSAN cluster. A vSAN file service domain is designed with the following properties:

A file service domain has a FQDN domain name (e.g., fs.mycompany.com) that client can mount.
It can join an Active Directory domain and use Kerberos for authentication and user ID mapping, or use AUTH_SYS to trust user ID sent from clients.
One more more file shares can be created in a file service domain and all these file shares have the same security/network properties of this file service domain. These file shares can be accessed from a certain network (e.g., VM Network).

In current version, only one file service domain can be created per cluster, which can be initiated when the file service is enabled.

Required Privileges: None

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

domainConfig P

VsanFileServiceDomainConfig

Domain configuration information.

Since vSAN API 7.0

cluster* P

ManagedObjectReference
to a ClusterComputeResource

The target cluster. Ignored when called on ESXi hosts.

Since vSAN API 7.0

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

Return Value

Type	Description
ManagedObjectReference to a Task	A task tracking the domain creation progress.

Faults

Type	Description
InvalidArgument	Exception for invalid input arguments, for example, if the domain name already configured in the cluster.
InvalidState	Exception when vSAN file service is not enabled in this cluster.
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="VsanClusterCreateFsDomain" type="vsan:VsanClusterCreateFsDomainRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanClusterCreateFsDomainResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:ManagedObjectReference"/>
                     </sequence>
                  </complexType>
               </element>

VsanClusterCreateShareSnapshot(createFileShareSnapshot)

Create a snapshot for a file share in this vSAN cluster.

Required Privileges: None
Since: vSAN API vSAN 7.0U2

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

config P

VsanFileShareSnapshotConfig

The snapshot configuration.

Since vSAN API vSAN 7.0U2

cluster* P

ManagedObjectReference
to a ClusterComputeResource

The target cluster. Ignored when called on ESXi hosts.

Since vSAN API vSAN 7.0U2

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

Return Value

Type	Description
ManagedObjectReference to a Task	A task tracking the snapshot creation progress.

Faults

Type	Description
InvalidArgument	Exception for invalid input arguments, for example, if the file share to create a snapshot does not exist in this cluster.
InvalidState	Exception for invalid states, for example, if vSAN file service is not enabled in this cluster.
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="VsanClusterCreateShareSnapshot" type="vsan:VsanClusterCreateShareSnapshotRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanClusterCreateShareSnapshotResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:ManagedObjectReference"/>
                     </sequence>
                  </complexType>
               </element>

VsanClusterQueryFileShares(queryFileShares)

Lists all file shares in the domain. To list all the file shares in the domain, leave both the shareUuids and shareNames field empty. Otherwise the return result will be a set of file shares matches the share UUID or share name provided in the parameters. If both fields are provided, only those file shares with both share name and share UUID matched will be returned. Note that if none of file shares matches the querySpec, the return value is None.

Required Privileges: None

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

querySpec P

VsanFileShareQuerySpec

The specifications of the file shares to be queried.

Since vSAN API 7.0

cluster* P

ManagedObjectReference
to a ClusterComputeResource

The target cluster. Ignored when called on ESXi hosts.

Since vSAN API 7.0

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

Return Value

Type	Description
FileShareQueryResult	Result of the file share query.

Faults

Type	Description
InvalidArgument	Exception for invalid input arguments, for example, if the domain does not exist in this cluster.
InvalidState	Exception when vSAN file service is not enabled in this cluster.
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="VsanClusterQueryFileShares" type="vsan:VsanClusterQueryFileSharesRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanClusterQueryFileSharesResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:FileShareQueryResult" minOccurs="0"/>
                     </sequence>
                  </complexType>
               </element>

VsanClusterQueryFsDomains(queryFileServiceDomains)

Lists all file service domains in the vSAN cluster. To list all the file service domains, leave both the uuids and names field empty. Otherwise the return result will be a set of file service domains matches the domain UUID or domain name provided in the parameters. If both fields are provided, only those file service domain with both domain name and domain UUID matched will be returned.

Required Privileges: None

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

querySpec* P

VsanFileServiceDomainQuerySpec

The specifications of the file service domains to be queried.

Since vSAN API 7.0

cluster* P

ManagedObjectReference
to a ClusterComputeResource

The target cluster. Ignored when called on ESXi hosts.

Since vSAN API 7.0

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

Return Value

Type	Description
VsanFileServiceDomain[]	List of all the domain information on this host.

Faults

Type	Description
InvalidState	Exception when the file service is not enabled in this cluster.
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="VsanClusterQueryFsDomains" type="vsan:VsanClusterQueryFsDomainsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanClusterQueryFsDomainsResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:VsanFileServiceDomain" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

VsanClusterQueryShareSnapshots(queryFileShareSnapshots)

List all the snapshots that match the query spec.

Required Privileges: None
Since: vSAN API vSAN 7.0U2

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

querySpec P

VsanFileShareSnapshotQuerySpec

The specification of the snapshots to be queried.

Since vSAN API vSAN 7.0U2

cluster* P

ManagedObjectReference
to a ClusterComputeResource

The target cluster. Ignored when called on ESXi hosts.

Since vSAN API vSAN 7.0U2

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

Return Value

Type	Description
VsanFileShareSnapshotQueryResult	Result of the snapshot query.

Faults

Type	Description
InvalidArgument	Exception for invalid input arguments, for example, if the share does not exist in this cluster.
InvalidState	Exception for invalid states, for example, if vSAN file service is not enabled in this cluster.
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="VsanClusterQueryShareSnapshots" type="vsan:VsanClusterQueryShareSnapshotsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanClusterQueryShareSnapshotsResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:VsanFileShareSnapshotQueryResult" minOccurs="0"/>
                     </sequence>
                  </complexType>
               </element>

VsanClusterReconfigureFsDomain(reconfigureFileServiceDomain)

Updates a file service domain in the vSAN cluster. As for file service domain IP configuration, it is only allowed to extend IP addresses but not to shrink IP addresses.

Required Privileges: None

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanFileServiceSystem used to make the method call.
domainUuid P	xsd:string	The UUID of the domain to be reconfigured. *Since* vSAN API 7.0
domainConfig P	VsanFileServiceDomainConfig	New configuration of the domain. Only set the fields that require reconfiguration, and leave others unset. *Since* vSAN API 7.0
cluster* P	ManagedObjectReference to a ClusterComputeResource	The target cluster. Ignored when called on ESXi hosts. *Since* vSAN API 7.0
deleteDomainConfigFields* P	xsd:string[]	The domain config fields to be deleted. For example to remove directoryServerConfig from the domainConfig provide ["directoryServerConfig"] here and keep the same unset in provided domainConfig. Do note removing directoryServerConfig is only allowed when there are no active shares. Here is the list of currently supported field: directoryServerConfig since 7.0U1 Providing any other value here will cause InvalidArgumentError fault. *Since* vSAN API 7.0

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

Return Value

Type	Description
ManagedObjectReference to a Task	A task tracking the domain reconfiguration progress.

Faults

Type	Description
InvalidArgument	Exception for invalid input arguments, for example, if the domain does not exist in this cluster.
InvalidState	Exception when vSAN file service is not enabled in this cluster.
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="VsanClusterReconfigureFsDomain" type="vsan:VsanClusterReconfigureFsDomainRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanClusterReconfigureFsDomainResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:ManagedObjectReference"/>
                     </sequence>
                  </complexType>
               </element>

VsanClusterRemoveFsDomain(removeFileServiceDomain)

Removes a file service domain in the vSAN cluster. A file service domain is not allowed to be removed if it still has any file shares.

Required Privileges: None

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

domainUuid P

xsd:string

The unique domain uuid that is configured in the directory service, for example, Active Directory (AD) from Microsoft.

Since vSAN API 7.0

cluster* P

ManagedObjectReference
to a ClusterComputeResource

The target cluster. Ignored when called on ESXi hosts.

Since vSAN API 7.0

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

Return Value

Type	Description
ManagedObjectReference to a Task	A task tracking the domain remove progress.

Faults

Type	Description
InvalidArgument	Exception for invalid input arguments, for example, if the domain does not exist in this cluster.
InvalidState	Exception when vSAN file service is not enabled in this cluster, or it still has file shares.
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="VsanClusterRemoveFsDomain" type="vsan:VsanClusterRemoveFsDomainRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanClusterRemoveFsDomainResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:ManagedObjectReference"/>
                     </sequence>
                  </complexType>
               </element>

VsanClusterRemoveShare(removeFileShare)

Removes a file share in the domain.

Required Privileges: None

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanFileServiceSystem used to make the method call.
shareUuid P	xsd:string	The UUID of the file share to be removed. *Since* vSAN API 7.0
cluster* P	ManagedObjectReference to a ClusterComputeResource	The target cluster. Ignored when called on ESXi hosts. *Since* vSAN API 7.0
force* P	xsd:boolean	The force flag is to force the removal of a vSphere managed file share, for example, the file share managed by Cloud Native Storage (CNS) service. *Since* vSAN API 7.0

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

Return Value

Type	Description
ManagedObjectReference to a Task	A task tracking the file share remove progress.

Faults

Type	Description
InvalidArgument	Exception for invalid input arguments, for example, if the file share does not exist in this cluster.
InvalidState	Exception when vSAN file service is not enabled in this cluster.
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="VsanClusterRemoveShare" type="vsan:VsanClusterRemoveShareRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanClusterRemoveShareResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:ManagedObjectReference"/>
                     </sequence>
                  </complexType>
               </element>

VsanClusterRemoveShareSnapshot(removeFileShareSnapshot)

Remove a snapshot of a file share in this vSAN cluster. Note: due to the limitation, it's not allowed to remove the latest snapshot for file service in 70U2 and an InvalidState exception will be thrown for this case.

Required Privileges: None
Since: vSAN API vSAN 7.0U2

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanFileServiceSystem used to make the method call.
shareUuid P	xsd:string	UUID of the file share to delete the snapshots. *Since* vSAN API vSAN 7.0U2
snapshotName P	xsd:string	Name of the snapshot to be deleted. *Since* vSAN API vSAN 7.0U2
cluster* P	ManagedObjectReference to a ClusterComputeResource	The target cluster. Ignored when called on ESXi hosts. *Since* vSAN API vSAN 7.0U2

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

Return Value

Type	Description
ManagedObjectReference to a Task	A task tracking the snapshot remove progress.

Faults

Type	Description
InvalidArgument	Exception for invalid input arguments, for example, if the snapshot does not exist in this cluster.
InvalidState	Exception for invalid states, for example, if vSAN file service is not enabled in this cluster.
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="VsanClusterRemoveShareSnapshot" type="vsan:VsanClusterRemoveShareSnapshotRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanClusterRemoveShareSnapshotResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:ManagedObjectReference"/>
                     </sequence>
                  </complexType>
               </element>

VsanCreateFileShare(createFileShare)

Creates a file share in this vSAN cluster.

Required Privileges: None

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

config P

VsanFileShareConfig

The file share configuration, as specified in {@vim.vsan.FileShareConfig}. Note that the backing vSAN object for the file share will be by default 1TB if the file share is thin provisioned. Otherwise the backing vSAN object is set to 255GB if quota is not set.

Since vSAN API 7.0

cluster* P

ManagedObjectReference
to a ClusterComputeResource

The target cluster. Ignored when called on ESXi hosts.

Since vSAN API 7.0

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

Return Value

Type	Description
ManagedObjectReference to a Task	A task tracking the share creation progress. The UUID of the file share will be set to the task result field if the task succeeds.

Faults

Type	Description
InvalidArgument	Exception for invalid input arguments, for example, if the domain for this new file share does not exist in this cluster.
InvalidState	Exception when vSAN file service is not enabled in this cluster.
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="VsanCreateFileShare" type="vsan:VsanCreateFileShareRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanCreateFileShareResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:ManagedObjectReference"/>
                     </sequence>
                  </complexType>
               </element>

VsanDownloadFileServiceOvf(downloadFileServiceOvf)

Downloads a file service OVF file of the specified version from VMware website and install it to the OVF repository in vCenter.

Required Privileges: Global.VCServer

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

downloadUrl P

xsd:string

URL to download the vSAN file service OVF.

Since vSAN API 7.0

P Required privilege: downloadUrl

Return Value

Type	Description
ManagedObjectReference to a Task	Task for tracking the OVF installation.

Faults

Type	Description
InvalidArgument	Exception if the OVF of the specified version does not exist as specified in the source URL.
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="VsanDownloadFileServiceOvf" type="vsan:VsanDownloadFileServiceOvfRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanDownloadFileServiceOvfResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:ManagedObjectReference"/>
                     </sequence>
                  </complexType>
               </element>

VsanFindOvfDownloadUrl(findOvfDownloadUrl)

Find a compatible vSAN File Service OVF download URL for the target cluster. This API needs internet access to fetch the latest OVF download URL for the specified cluster.

Required Privileges: None

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

cluster P

ManagedObjectReference
to a ClusterComputeResource

The target cluster to download OVF files.

Since vSAN API 7.0

P Required privilege: cluster

Return Value

Type	Description
xsd:string	The OVF download URL. Return an empty string if no proper OVF download URL could be found.

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="VsanFindOvfDownloadUrl" type="vsan:VsanFindOvfDownloadUrlRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanFindOvfDownloadUrlResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="xsd:string"/>
                     </sequence>
                  </complexType>
               </element>

VsanPerformFileServiceEnablePreflightCheck(performFileServicePreflightCheck)

Perform a upgrade preflight check on a cluster for enabling for vSAN file service. The preflight check items for enabling file service includes:

Network partition check
vSAN datastore presence to each host
The versions of the ESXi hosts match in this cluster
(Optional) Active Directory connectivity
If a DVS portgroup is passed as network, it checks if DVS version is older than 6.6

Required Privileges: None

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanFileServiceSystem used to make the method call.
cluster P	ManagedObjectReference to a ClusterComputeResource	The target cluster to enable file service. *Since* vSAN API 7.0
domainConfig* P	VsanFileServiceDomainConfig	The domain configuration. If not specified, the validation for the domain will be skipped. *Since* vSAN API 7.0
network* P	ManagedObjectReference to a Network	The network which will be used for fs containers *Since* vSAN API 7.0

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

Return Value

Type	Description
VsanFileServicePreflightCheckResult	Preflight check result.

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="VsanPerformFileServiceEnablePreflightCheck" type="vsan:VsanPerformFileServiceEnablePreflightCheckRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanPerformFileServiceEnablePreflightCheckResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:VsanFileServicePreflightCheckResult"/>
                     </sequence>
                  </complexType>
               </element>

VsanQueryFileServiceOvfs(queryFileServiceOvfs)

Lists all available vSAN File Service OVF in this vCenter.

Required Privileges: Global.VCServer

Parameters

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

Return Value

Type	Description
VsanFileServiceOvfSpec[]	List of the file services OVFs available in this vCenter.

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="VsanQueryFileServiceOvfs" type="vsan:VsanQueryFileServiceOvfsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryFileServiceOvfsResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:VsanFileServiceOvfSpec" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

VsanRebalanceFileService(rebalanceFileService)

This API is to rebalance file service in cluster.

Required Privileges: Host.Config.Storage
Since: vSAN API vSAN 7.0U1

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

cluster* P

ManagedObjectReference
to a ClusterComputeResource

The target cluster to do rebalance.

Since vSAN API vSAN 7.0U1

*Need not be set P Required privilege: cluster

Return Value

Type	Description
ManagedObjectReference to a Task	The task tracking the rebalance progress.

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="VsanRebalanceFileService" type="vsan:VsanRebalanceFileServiceRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanRebalanceFileServiceResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:ManagedObjectReference"/>
                     </sequence>
                  </complexType>
               </element>

VsanReconfigureFileShare(reconfigureFileShare)

Reconfigures a file share in this vSAN cluster. All the configurations of a vSAN file share can be reconfigured through this API, except the file service domain.

Required Privileges: None

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanFileServiceSystem used to make the method call.
shareUuid P	xsd:string	The UUID of the file share to be reconfigured. *Since* vSAN API 7.0
config P	VsanFileShareConfig	The file services configuration. Only set the fields that require reconfiguration, and leave the others unset. This API will update or create the labels specified in the config. Labels to be deleted should be specified in the 'deleteLabelKeys' parameter. Other labels will remain intact. *Since* vSAN API 7.0
cluster* P	ManagedObjectReference to a ClusterComputeResource	The target cluster. Ignored when called on ESXi hosts. *Since* vSAN API 7.0
deleteLabelKeys* P	xsd:string[]	The keys of share labels to be deleted. If a specified label key does not exist in the file share, the deletion of this label will be ignored. *Since* vSAN API 7.0
force* P	xsd:boolean	The force flag is to force the reconfiguration of a vSphere managed file share, for example, the file share managed by Cloud Native Storage (CNS) service. *Since* vSAN API 7.0

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

Return Value

Type	Description
ManagedObjectReference to a Task	A task tracking the share reconfiguring progress.

Faults

Type	Description
InvalidArgument	Exception for invalid input arguments, for example, if the file share does not exist in this cluster.
InvalidState	Exception when vSAN file service is not enabled in this cluster.
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="VsanReconfigureFileShare" type="vsan:VsanReconfigureFileShareRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanReconfigureFileShareResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:ManagedObjectReference"/>
                     </sequence>
                  </complexType>
               </element>

VsanUpgradeFsvm(upgradeFsvm)

Upgrade FSVM to latest ovf that is compatible with cluster's host version. A compatible OVF is expected be uploaded before calling this API. A preflight check will be conducted before the upgrade on the following API.

Required Privileges: None

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

cluster P

ManagedObjectReference
to a ClusterComputeResource

The target cluster in which FSVM deployed.

Since vSAN API 7.0

P Required privilege: cluster

Return Value

Type	Description
ManagedObjectReference to a Task	None

Faults

Type	Description
InvalidState	Exception if the OVF of the compatible version for the hosts cannot be found on the corresponding vCenter server, or file service is not running in a valid state.
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="VsanUpgradeFsvm" type="vsan:VsanUpgradeFsvmRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanUpgradeFsvmResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:ManagedObjectReference"/>
                     </sequence>
                  </complexType>
               </element>