Data Object - DatastoreSummary

Property of
Datastore, HostDatastoreConnectInfo, VirtualMachineDatastoreInfo
Extends
DynamicData
See also
Datastore

Data Object Description

Summary information about the datastore. The status fields and managed object reference is not set when an object of this type is created. These fields and references are typically set later when these objects are associated with a host.

Properties

Name Type Description
accessiblexsd:boolean

The connectivity status of this datastore. If this is set to false, meaning the datastore is not accessible, this datastore's capacity and freespace properties cannot be validated. Furthermore, if this property is set to false, some of the properties in this summary and in DatastoreInfo should not be used. Refer to the documentation for the property of your interest. For datastores accessed from multiple hosts, vCenter Server reports accessible as an aggregated value of the properties reported in MountInfo. For instance, if a datastore is accessible through a subset of hosts, then the value of accessible will be reported as true by vCenter Server. And the reason for a daastore being inaccessible from a host will be reported in inaccessibleReason
capacityxsd:long

Maximum capacity of this datastore, in bytes. This value is updated periodically by the server. It can be explicitly refreshed with the Refresh operation. This property is guaranteed to be valid only if accessible is true.
datastore*ManagedObjectReference
to a Datastore

The reference to the managed object.
freeSpacexsd:long

Available space of this datastore, in bytes. The server periodically updates this value. It can be explicitly refreshed with the Refresh operation. This property is guaranteed to be valid only if accessible is true.
maintenanceMode*xsd:string

The current maintenance mode state of the datastore. The set of possible values is described in DatastoreSummaryMaintenanceModeState.

Since vSphere API 5.0
multipleHostAccess*xsd:boolean

More than one host in the datacenter has been configured with access to the datastore. This is only provided by VirtualCenter.
namexsd:string

The name of the datastore.
typexsd:string

Type of file system volume, such as VMFS or NFS.
See type

uncommitted*xsd:long

Total additional storage space, in bytes, potentially used by all virtual machines on this datastore. The server periodically updates this value. It can be explicitly refreshed with the RefreshDatastoreStorageInfo operation. This property is valid only if accessible is true.

Since vSphere API 4.0
urlxsd:string

The unique locator for the datastore. This property is guaranteed to be valid only if accessible is true.
Properties inherited from DynamicData
dynamicProperty, dynamicType
*Need not be set
Show WSDL type definition