| Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
Name | Type | Description |
---|---|---|
None |
Methods
Privileges | Required on |
---|---|
Host.Config.Storage | ClusterComputeResource |
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 |
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 |
Privileges | Required on |
---|---|
System.Read | ClusterComputeResource |
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 |
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 |
Privileges | Required on |
---|---|
System.Read | ClusterComputeResource |
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 |
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 |
Privileges | Required on |
---|---|
Host.Config.Storage | ClusterComputeResource |
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 |
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 |
Privileges | Required on |
---|---|
Host.Config.Storage | ClusterComputeResource |
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 |
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 |
Privileges | Required on |
---|---|
Host.Config.Storage | ClusterComputeResource |
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 |
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 |
Privileges | Required on |
---|---|
Host.Config.Storage | ClusterComputeResource |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanFileServiceSystem used to make the method call. |
config P | VsanFileShareConfig |
The file services configuration.
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 |
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 |
Privileges | Required on |
---|---|
Global.VCServer | RootFolder |
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 |
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 |
Privileges | Required on |
---|---|
System.Read | ClusterComputeResource |
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 |
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 |
Privileges | Required on |
---|---|
System.Read | ClusterComputeResource |
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 |
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 |
Privileges | Required on |
---|---|
Global.VCServer | RootFolder |
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 |
Privileges | Required on |
---|---|
Host.Config.Storage | ClusterComputeResource |
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 |
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 |
Privileges | Required on |
---|---|
Host.Inventory.EditCluster | ClusterComputeResource |
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 |
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 |
Top of page | Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |