Service - VirtualSAN

Class
VMware.Hv.VirtualSAN
See also
HostOrClusterId, VirtualCenterId, VsanDatastoreCost
Since
Horizon View 6.0


Service Description

Utility for obtaining information about Virtual SAN (VSAN) support from Virtual Center.

Methods

Methods defined in this Service
VirtualSAN_GetVsanDatastoreCostForFullClone, VirtualSAN_GetVsanDatastoreCostForInstantClone, VirtualSAN_GetVsanDatastoreCostForLinkedClone, VirtualSAN_IsSupportedByHostOrCluster, VirtualSAN_IsSupportedByVirtualCenter

VirtualSAN_GetVsanDatastoreCostForFullClone

Returns datastore cost factors for full clone pools when VSAN is used. Requires at least one of the listed privileges.

Privileges

Privilege Description
GLOBAL_CONFIG_VIEW Global configuration (read-only) is required to get VSAN data store cost.
VC_CONFIG_VIEW privilege is required to get VSAN data store cost.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualSAN used to make the method call.
virtualCenterVirtualCenterId

unique identifier for the vc
isPersistentxsd:boolean

cost factor for a persistent pool

Return Value

Type Description
VsanDatastoreCostdatastore cost factor

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



VirtualSAN_GetVsanDatastoreCostForInstantClone

Returns datastore cost factors for instant clone pools when VSAN is used. Requires at least one of the listed privileges.

Privileges

Privilege Description
GLOBAL_CONFIG_VIEW Global configuration (read-only) is required to get VSAN data store cost.
VC_CONFIG_VIEW is required to get VSAN data store cost.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualSAN used to make the method call.
virtualCenterVirtualCenterId

unique identifier for the vc
isPersistentxsd:boolean

cost factor for a persistent pool

Return Value

Type Description
VsanDatastoreCostdatastore cost factor

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



VirtualSAN_GetVsanDatastoreCostForLinkedClone

Returns datastore cost factors for linked clone pools when VSAN is used. Requires at least one of the listed privileges.

Privileges

Privilege Description
GLOBAL_CONFIG_VIEW Global configuration (read-only) is required to get VSAN data store cost.
VC_CONFIG_VIEW privilege is required to get VSAN data store cost.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualSAN used to make the method call.
virtualCenterVirtualCenterId

unique identifier for the vc
isPersistentxsd:boolean

cost factor for a persistent pool

Return Value

Type Description
VsanDatastoreCostdatastore cost factor

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



VirtualSAN_IsSupportedByHostOrCluster

Determines whether virtual SAN is supported for the given virtual center. Requires at least one of the listed privileges.

Privileges

Privilege Description
GLOBAL_CONFIG_VIEW Global configuration (read-only) is required to get whether virtual SAN is supported.
VC_CONFIG_VIEW privilege is required to get whether virtual SAN is supported.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualSAN used to make the method call.
hostOrClusterHostOrClusterId

unique identifier for the host or cluster

Return Value

Type Description
xsd:stringA code that determines whether virtual SAN is supported.
  • This property will be one of:
    Value Description
    "VSAN_VALIDATION_OK"VirtualSAN has been validated to be supported.
    "VSAN_UNSUPPORTED_VC"VirtualSAN is only supported on Virtual Center version 5.5 and greater.
    "VSAN_UNSUPPORTED_HOST_OR_CLUSTER"VirtualSAN is only supported on hosts or clusters version 5.5 and greater.
    "VSAN_NOT_CONFIGURED"VirtualSAN is only supported on Virtual Centers and hosts or clusters with at least one VSAN datastore present.

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



VirtualSAN_IsSupportedByVirtualCenter

Determines whether virtual SAN is supported for the given virtual center. Requires at least one of the listed privileges.

Privileges

Privilege Description
GLOBAL_CONFIG_VIEW Global configuration (read-only) is required to get whether virtual SAN is supported.
VC_CONFIG_VIEW privilege is required to get whether virtual SAN is supported.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualSAN used to make the method call.
virtualCenterVirtualCenterId

unique identifier for the vc.

Return Value

Type Description
xsd:stringA code that determines whether virtual SAN is supported.
  • This property will be one of:
    Value Description
    "VSAN_VALIDATION_OK"VirtualSAN has been validated to be supported.
    "VSAN_UNSUPPORTED_VC"VirtualSAN is only supported on Virtual Center version 5.5 and greater.
    "VSAN_NOT_CONFIGURED"VirtualSAN is only supported on Virtual Centers and hosts or clusters with at least one VSAN datastore present.

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition