REST API - storage_mapping

vcenter ovf: storage mapping params

The storage_mapping_params structure maps the OVF storage groups to specific storage profiles available on the target platform.

This structure will only be used when deploying an OVF package to a virtual datacenter.

This is information based on the vmw:StorageGroupSection and vmw:StorageSection.

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

Representation:

JSON

{
    "available_disk_provisioning_types" : [
        "thin",
        "thin"
    ],
    "target_profile" : "obj-103",
    "available_storage_profiles" : [
        {
            "name" : "string",
            "id" : "obj-103"
        },
        {
            "name" : "string",
            "id" : "obj-103"
        }
    ],
    "disk_groups" : [
        {
            "target_profile" : "obj-103",
            "name" : "string",
            "description" : "string",
            "id" : "string",
            "target_provisioning_type" : "thin"
        },
        {
            "target_profile" : "obj-103",
            "name" : "string",
            "description" : "string",
            "id" : "string",
            "target_provisioning_type" : "thin"
        }
    ],
    "type" : "string",
    "target_provisioning_type" : "thin"
}

Attributes:

Name	Type	Description
Optional
available_storage_profiles	storage_profile_target[]	Available storage profiles for the deployment. 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.
available_storage_profiles[].id	string	The identifier of the storage profile. 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.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`.
available_storage_profiles[].name	string	The name of the storage profile. 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.
available_disk_provisioning_types	string[]	Available datastores and datastore clusters for the deployment. 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 for the deployment. Optional. This field is optional in the input parameters when deploying an OVF package. If unset the deployment should not be associated with a storage profile. This field is optional in the result when retrieving information about an OVF package. If unset the deployment 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_provisioning_type	string	Specifies which disk provisioning type the deployment should use. 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 unset the first one from vcenter.ovf.storage_mapping_params.available_disk_provisioning_types will be used. This field is optional in the result when retrieving information about an OVF package. If unset the first one from vcenter.ovf.storage_mapping_params.available_disk_provisioning_types will be used.
disk_groups	storage_disk_group[]	Information about disk groups in the OVF package. Optional. This field is optional in the input parameters when deploying an OVF package. If unset, a disk group is by default deployed on the target storage profile. This field will always be present in the result when retrieving information about an OVF package.
disk_groups[].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.
disk_groups[].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.
disk_groups[].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.
disk_groups[].target_profile	string	The identifier of the storage profile on which to place this disk group. Optional. This field is optional in the input parameters when deploying an OVF package. If unset the disk group will not be associated with a storage profile. 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`.
disk_groups[].target_provisioning_type	string	The target provisioning type. It specifies which disk provisioning type the deployment should use for this disk group. 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.storage_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.storage_mapping_params.target_provisioning_type will be used.
type	string	Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters structure. 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.