REST API - network_mapping

vcenter ovf: network mapping params

The network_mapping_params structure specifies how source networks in the OVF package are mapped to target networks in the deployment environment. A mapping must be provided for each source network or the deployment will fail.

This is based on the ovf:NetworkSection.

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

Representation:

JSON

{
    "source_networks" : [
        {
            "name" : "string",
            "description" : "string",
            "target" : "obj-103"
        },
        {
            "name" : "string",
            "description" : "string",
            "target" : "obj-103"
        }
    ],
    "target_networks" : [
        {
            "accessible" : true,
            "name" : "string",
            "id" : "obj-103",
            "inaccessible_reasons" : [
                "NO_ASSIGN_RIGHT",
                "NO_ASSIGN_RIGHT"
            ]
        },
        {
            "accessible" : true,
            "name" : "string",
            "id" : "obj-103",
            "inaccessible_reasons" : [
                "NO_ASSIGN_RIGHT",
                "NO_ASSIGN_RIGHT"
            ]
        }
    ],
    "type" : "string"
}

Attributes:

Name	Type	Description
Optional
source_networks	source_network[]	Name of networks in OVF descriptor with descriptions. As a create parameter, this is also specifying the chosen mapping. Optional. This field is optional in the input parameters when deploying an OVF package. If unset there is no user chosen mapping to overwritten. This field will always be present in the result when retrieving information about an OVF package.
source_networks[].name	string	Name of the network. 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.
source_networks[].description	string	Description of the network. 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.
source_networks[].target	string	Identifier of the network in the deployment environment to which this network from the OVF package should be connected. Optional. This field is optional in the input parameters when deploying an OVF package. If unset there is no target assignment. This field is optional in the result when retrieving information about an OVF package. If unset there is no target assignment.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `Network`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `Network`.
target_networks	target_network[]	Name of target networks available in the deployment container, for example, virtual datacenter, cluster, host, resource pool, or virtual appliance. If the deployment target is a host, this will be the array of the networks from the host. If the deployment target is a cluster, this will be the array of the networks from all the hosts of the cluster. If the deployment target is a virtual datacenter, this will be the array of the networks from all the clusters of the virtual datacenter. If the deployment target is a resource pool or virtual appliance, this will be the array of the networks from the owner cluster of the resource pool or virtual appliance. 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_networks[].id	string	The identifier of network. 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: `Network`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `Network`.
target_networks[].accessible	boolean	Flag indicating whether or not there are sufficient privileges to assign to the network. If not, vcenter.ovf.target_network.inaccessible_reasons will indicate why. 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_networks[].inaccessible_reasons	string[]	If the network cannot be used (vcenter.ovf.target_network.accessible is false), this will describe why. If the network is accessible (vcenter.ovf.target_network.accessible is true), 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.
target_networks[].name	string	The name of the target network. 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.
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.