REST API - get

esx vm data sets: get

Returns information describing a data set. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Request:

HTTP request

GET https://{server}/api/esx/vm/{vm}/data-sets/{dataSet}

Path Parameters

Name	Type	Description
Required
vm	string	Identifier of the virtual machine.

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "disk_mode" : true,
    "size" : 1,
    "name" : "string",
    "host" : "NONE",
    "description" : "string",
    "guest" : "NONE",
    "used" : 1
}

Headers:

None

Type:

Name	Type	Description
bold = required
-	info	Details about the data set.
-.name	string	The name of the data set. It is recommended that this value take the form "com.company.project" to avoid conflict with other uses.. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.description	string	A description of how the data set is used by its creator. This field can contain up to 1024 bytes. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.host	string	Host access control. XXX do we want this? Does anything but FULL make any sense? Or just make it symmetric in case? Any decision should only effect docs and impl, so we should be able to change it. Possible use-cases for non-FULL: - read-only for a built-in data set (eg guest status data) - if data set creation from the GOS is ever added, full access control may be useful. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Possible Entry access modes. Warning: This enumeration is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Value is one of: NONE: No access is allowed, and the data set is not visible to a list operation. XXX does this matter? knowing a name isn't a security concern, and making Access only apply to Entries is clear and consistent. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. READ_ONLY: Only read access is allowed for data set Entries. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. READ_WRITE: Full read, write and delete access is allowed on data set Entries. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.guest	string	Guest access control. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Possible Entry access modes. Warning: This enumeration is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Value is one of: NONE: No access is allowed, and the data set is not visible to a list operation. XXX does this matter? knowing a name isn't a security concern, and making Access only apply to Entries is clear and consistent. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. READ_ONLY: Only read access is allowed for data set Entries. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. READ_WRITE: Full read, write and delete access is allowed on data set Entries. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.size	long	The total size in bytes of the Entry data that can be used by this data set. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.used	long	The total size in bytes of the Entry data in use by this data set. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.disk_mode	boolean	If set, the data set is treated like a disk on certain virtual machine operations. The data set is copied when the virtual machine is cloned or a snapshot is taken. Otherwise the data set is considered a property of the virtual machine, and is not included in a a snapshot operation or when the virtual machine is cloned. When a virtual machine is reverted to a snapshot, any data set without {@link #diskMode) set will be destroyed. Any data set with esx.vm.data_sets.info.disk_mode set will be restored to the state when the snapshot was created. XXX field name, wording and terminology needs work. 'disk' mode (data is cloned & snapshotted) vs 'VM' mode was first suggestion. Other suggestions: checkpointRequired includeInSnapshotsAndClones. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Errors:

HTTP Status Code	Type	Description
404	not_found	if the virtual machine is not found.
403	unauthorized	if the user doesn't have the required privileges.