REST API - summary

vcenter datastore: summary

The summary structure contains commonly used information about a datastore.

Representations:

JSON
XML

{
    "capacity": 1,
    "datastore": "obj-103",
    "free_space": 1,
    "name": "string",
    "type": "VMFS"
}

<?xml version="1.0" ?>
<ns0:Summary xmlns:ns0="http://vmware.com/vcenter/datastore" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <free_space>1</free_space>
  <name>string</name>
  <capacity>1</capacity>
  <type>VMFS</type>
  <datastore>obj-103</datastore>
</ns0:Summary>

Attributes:

Name	Type	Description
Required
datastore	string	Identifier of the datastore. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `Datastore`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `Datastore`.
name	string	Name of the datastore.
type	string	Type (`VMFS`, `NFS`, `NFS41`, `CIFS`, `VSAN`, `VFFS`, `VVOL`) of the datatore. Defines the supported types of vCenter datastores. Value is one of: VMFS: VMware File System (ESX Server only). NFS: Network file system v3 (linux & esx servers only). NFS41: Network file system v4.1 (linux & esx servers only). CIFS: Common Internet File System. VSAN: Virtual SAN (ESX Server only). VFFS: Flash Read Cache (ESX Server only). VVOL: vSphere Virtual Volume (ESX Server only).
Optional
free_space	long	Available space of this datastore, in bytes. The server periodically updates this value. Optional. This field will be unset if the available space of this datastore is not known.
capacity	long	Capacity of this datastore, in bytes. The server periodically updates this value. Optional. This field will be unset if the capacity of this datastore is not known.