Service - Datastore

Class: VMware.Hv.Datastore
See also: DatastoreClusterInfo, DatastoreId, DatastoreInfo, DatastoreRequirementSpec, DatastoreSpaceRequirement, DatastoreSpec, DesktopOrFarmDatastoreUsageInfo, HostOrClusterId
Since: Horizon View 6.0

Service Description

The object for fetching Datastores from VirtualCenter.

Methods

Methods defined in this Service
Datastore_GetDatastoreRequirements, Datastore_GetUsage, Datastore_ListDatastoreClustersByHostOrCluster, Datastore_ListDatastoresByDesktopOrFarm, Datastore_ListDatastoresByHostOrCluster

Datastore_GetDatastoreRequirements

DatastoreSpaceRequirement can be in following combinations. Datastore type returned will be:

OS: When there are no separate disks for OS and replica or persisten diskt.
OS, REPLICA: When the Pool has separate disk for replica and OS.
OS, REPLICA, PERSISTENT: When Pool has separate OS, replica and persistent disks.

Privileges

Privilege	Description
VC_CONFIG_VIEW	privilege is required for computing the space requirements.
POOL_VIEW	privilege is required for accessing Desktop or Farm mentioned via desktopId or farmId.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the Datastore used to make the method call.
spec	DatastoreRequirementSpec	DatastoreRequirementSpec

Return Value

Type	Description
DatastoreSpaceRequirement[]	Array of DatastoreSpaceRequirement

Faults

Type	Description
EntityNotFound	Thrown if any specified entity cannot be found.
InsufficientPermission	Thrown if the user does not have sufficient permission to perform the operation.
InvalidArgument	Thrown if any specified argument is invalid.
InvalidType	Thrown if the type of any specified argument is invalid.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Datastore_GetDatastoreRequirements" type="vdi:Datastore_GetDatastoreRequirementsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Datastore_GetDatastoreRequirementsResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:DatastoreSpaceRequirement" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

Datastore_GetUsage

Gets the Desktop or Farm and its usage details for a given datastore. For now, it will lists the automated Desktops and Farms only.

Privileges

Privilege	Description
POOL_VIEW	privilege on corresponding access group is required to get the usage information of a Desktop and/or Farm.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the Datastore used to make the method call.
id	DatastoreId	The resource id of the datastore.

Return Value

Type	Description
DesktopOrFarmDatastoreUsageInfo[]	An array of DesktopOrFarmUsageInfo

Faults

Type	Description
EntityNotFound	Thrown if any specified entity cannot be found.
InsufficientPermission	Thrown if the user does not have sufficient permission to perform the operation.
InvalidArgument	Thrown if any specified argument is invalid.
InvalidType	Thrown if the type of any specified argument is invalid.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Datastore_GetUsage" type="vdi:Datastore_GetUsageRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Datastore_GetUsageResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:DesktopOrFarmDatastoreUsageInfo" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

Datastore_ListDatastoreClustersByHostOrCluster

Gets a list of datastore clusters from VC for the given host or cluster that may be suitable for use in full clone desktop creation. Requires at least one of the listed privileges.

Privileges

Privilege	Description
GLOBAL_CONFIG_VIEW	privilege is required to get the list of DatastoreClusterInfo.
VC_CONFIG_VIEW	privilege is required to get the list of DatastoreClusterInfo.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the Datastore used to make the method call.
hostOrCluster	HostOrClusterId	host or cluster to list datastore clusters for

Return Value

Type	Description
DatastoreClusterInfo[]	Array of DatastoreClusterInfo

Faults

Type	Description
EntityNotFound	Thrown if any specified entity cannot be found.
InsufficientPermission	Thrown if the user does not have sufficient permission to perform the operation.
InvalidArgument	Thrown if any specified argument is invalid.
InvalidType	Thrown if the type of any specified argument is invalid.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Datastore_ListDatastoreClustersByHostOrCluster" type="vdi:Datastore_ListDatastoreClustersByHostOrClusterRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Datastore_ListDatastoreClustersByHostOrClusterResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:DatastoreClusterInfo" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

Datastore_ListDatastoresByDesktopOrFarm

Gets a list of datastores from VC for the given host or cluster that may be suitable for use during desktop/farm updates. Skips the VMs calculation for the following cases:

DesktopId provided is manual or RDS type
FarmId provided is of manual type

Requires at least one of the listed privileges.

Privileges

Privilege	Description
GLOBAL_CONFIG_VIEW	privilege is required to get the list of DatastoreInfo.
VC_CONFIG_VIEW	privilege is required to get the list of DatastoreInfo.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the Datastore used to make the method call.
spec	DatastoreSpec

Return Value

Type	Description
DatastoreInfo[]	Array of DatastoreInfo

Faults

Type	Description
EntityNotFound	Thrown if any specified entity cannot be found.
InsufficientPermission	Thrown if the user does not have sufficient permission to perform the operation.
InvalidArgument	Thrown if any specified argument is invalid.
InvalidType	Thrown if the type of any specified argument is invalid.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Datastore_ListDatastoresByDesktopOrFarm" type="vdi:Datastore_ListDatastoresByDesktopOrFarmRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Datastore_ListDatastoresByDesktopOrFarmResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:DatastoreInfo" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

Datastore_ListDatastoresByHostOrCluster

Gets a list of datastores from VC for the given host or cluster that may be suitable for use in full or linked clone desktop creation. Requires at least one of the listed privileges.

Privileges

Privilege	Description
GLOBAL_CONFIG_VIEW	privilege is required to get the list of DatastoreInfo.
VC_CONFIG_VIEW	privilege is required to get the list of DatastoreClusterInfo.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the Datastore used to make the method call.
hostOrCluster	HostOrClusterId	host or cluster to list datastores for

Return Value

Type	Description
DatastoreInfo[]	Array of DatastoreInfo

Faults

Type	Description
EntityNotFound	Thrown if any specified entity cannot be found.
InsufficientPermission	Thrown if the user does not have sufficient permission to perform the operation.
InvalidArgument	Thrown if any specified argument is invalid.
InvalidType	Thrown if the type of any specified argument is invalid.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Datastore_ListDatastoresByHostOrCluster" type="vdi:Datastore_ListDatastoresByHostOrClusterRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Datastore_ListDatastoresByHostOrClusterResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:DatastoreInfo" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

View API

Service - Datastore

Service Description

Datastore_GetDatastoreRequirements

Datastore_GetUsage

Datastore_ListDatastoreClustersByHostOrCluster

Datastore_ListDatastoresByDesktopOrFarm

Datastore_ListDatastoresByHostOrCluster