REST API - datastore_disk

vcenter ovf: datastore disk group

The datastore_disk_group structure contains information about a storage disk group described in the OVF package.

This structure will always be returned when retrieving information about an OVF package. See vcenter.ovf.datastore_mapping_params.disk_groups.

A disk group is a main unit of storage on a ESXi host. Each disk group includes one SSD and one or multiple HDDs (magnetic disks).

See Import#tryDeploy, Import#deploy, deploy, and filter.

Representation:

JSON

{
    "target_profile" : "obj-103",
    "name" : "string",
    "description" : "string",
    "target_datastore" : "obj-103",
    "id" : "string",
    "target_provisioning_type" : "thin"
}

Attributes:

Name	Type	Description
Optional
id	string	Identifier of the disk group. Optional. This field must be provided in the input parameters when deploying an OVF package. This field will always be present in the result when retrieving information about an OVF package.
name	string	Short description of the disk group. Optional. This field is not used in the input parameters when deploying an OVF package. This field will always be present in the result when retrieving information about an OVF package.
description	string	Description of the disk group. Optional. This field is not used in the input parameters when deploying an OVF package. This field will always be present in the result when retrieving information about an OVF package.
target_profile	string	The identifier of the storage profile to place this disk group on. Optional. This field is optional in the input parameters when deploying an OVF package. If unset vcenter.ovf.datastore_mapping_params.target_profile will be used or the disk group will not be associated with a storage profile if vcenter.ovf.datastore_mapping_params.target_profile is unset. This field is optional in the result when retrieving information about an OVF package. If unset the disk group is not associated with a storage profile.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `StorageProfile`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `StorageProfile`.
target_datastore	string	The identifier of the datastore or datastore cluster to place this disk group on. Optional. This field is optional in the input parameters when deploying an OVF package. If unset vcenter.ovf.datastore_mapping_params.target_datastore will be used or the disk group will not be associated with a datastore or datastore cluster if vcenter.ovf.datastore_mapping_params.target_datastore is unset. This field is optional in the result when retrieving information about an OVF package. If unset the disk group is not associated with a datastore or datastore cluster.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`.
target_provisioning_type	string	The target provisioning type. Defines the virtual disk provisioning types that can be set for a disk on the target platform. Value is one of: thin: A thin provisioned virtual disk has space allocated and zeroed on demand as the space is used. thick: A thick provisioned virtual disk has all space allocated at creation time and the space is zeroed on demand as the space is used. eagerZeroedThick: An eager zeroed thick provisioned virtual disk has all space allocated and wiped clean of any previous contents on the physical media at creation time. Disks specified as eager zeroed thick may take longer time to create than disks specified with the other disk provisioning types. Optional. This field is optional in the input parameters when deploying an OVF package. If it is unset, vcenter.ovf.datastore_mapping_params.target_provisioning_type will be used. This field is optional in the result when retrieving information about an OVF package. If it is unset, vcenter.ovf.datastore_mapping_params.target_provisioning_type will be used.