REST API - datastore_mapping

vcenter ovf: datastore mapping params

The datastore_mapping_params structure contains information about the mapping from OVF storage groups to specific storage targets supported on the target platform.

This structure will only be used when deploying an OVF package to a resource pool, cluster or host.

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

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

Representation:

JSON

{
    "storage_profiles_enabled" : true,
    "available_disk_provisioning_types" : [
        "thin",
        "thin"
    ],
    "target_profile" : "obj-103",
    "available_storage_profiles" : [
        {
            "name" : "string",
            "id" : "obj-103"
        },
        {
            "name" : "string",
            "id" : "obj-103"
        }
    ],
    "available_datastores" : [
        {
            "accessible" : true,
            "storage_profiles" : [
                "obj-103",
                "obj-103"
            ],
            "name" : "string",
            "id" : "obj-103",
            "inaccessible_reasons" : [
                "NOT_CONNECTED",
                "NOT_CONNECTED"
            ]
        },
        {
            "accessible" : true,
            "storage_profiles" : [
                "obj-103",
                "obj-103"
            ],
            "name" : "string",
            "id" : "obj-103",
            "inaccessible_reasons" : [
                "NOT_CONNECTED",
                "NOT_CONNECTED"
            ]
        }
    ],
    "disk_groups" : [
        {
            "target_profile" : "obj-103",
            "name" : "string",
            "description" : "string",
            "target_datastore" : "obj-103",
            "id" : "string",
            "target_provisioning_type" : "thin"
        },
        {
            "target_profile" : "obj-103",
            "name" : "string",
            "description" : "string",
            "target_datastore" : "obj-103",
            "id" : "string",
            "target_provisioning_type" : "thin"
        }
    ],
    "target_datastore" : "obj-103",
    "type" : "string",
    "target_provisioning_type" : "thin"
}

Attributes:

Name	Type	Description
Optional
available_storage_profiles	storage_profile_target[]	Storage profiles available in the target platform. 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.
storage_profiles_enabled	boolean	Indicates whether or not the storage profiles are enabled for the target. Optional. This field is not used in the input parameters when deploying an OVF package. This field is optional in the result when retrieving information about an OVF package. If it is unset, the enablement status is unknown.
available_datastores	datastore_target[]	Datastores and datastore clusters available in the target platform. Datastore clusters where Storage DRS is disabled are not included in the array, instead the individual datastores of the cluster are included. 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_datastores[].id	string	The identifier of the datastore or datastore cluster. 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: `Datastore`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `Datastore`.
available_datastores[].name	string	The name of the datastore or datastore cluster. 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_datastores[].accessible	boolean	Whether the datastore is accessible. If it is inaccessible, vcenter.ovf.datastore_target.inaccessible_reasons will indicate why. A storage pod will be accessible if at least one of its datastores is accessible. 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_datastores[].inaccessible_reasons	string[]	If the datastore is inaccessible, this will describe why. For an inaccessible storage pod, the union of the reasons for its datastores is included. If the datastore is accessible, this will be empty. 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_datastores[].storage_profiles	string[]	The identifiers of the storage profiles this datastore or datastore cluster is part of. 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 contain identifiers for the resource type: `StorageProfile`. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: `StorageProfile`.
available_disk_provisioning_types	string[]	Disk provisioning types available in the target platform. 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	Identifier of the storage profile to use for the deployed virtual machine or virtual appliance. 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_datastore	string	Specifies the identifier of the datastore or datastore cluster the deployment should use. Optional. This field is optional in the input parameters when deploying an OVF package. If unset the deployment should not be associated with a datastore or datastore cluster. This field is optional in the result when retrieving information about an OVF package.If unset the deployment 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	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.datastore_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.datastore_mapping_params.available_disk_provisioning_types will be used.
disk_groups	datastore_disk_group[]	Information about disk groups. 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 and datastore. This field will always be present in the result when retrieving information about an OVF package.
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.