Library_Subscriptions_CreateSpecPlacement

The Subscriptions.CreateSpecPlacement structure defines the placement information for the subscribed library's virtual machine template library items. Storage location of the virtual machine template items is defined by the subscribed library's storage backing. This placement information needs to be compatible with the subscribed library's storage backing. The Subscriptions.CreateSpecPlacement structure is only applicable for the virtual machine template library items of the subscribed library.

JSON Example

{
    "folder": "string",
    "cluster": "string",
    "resource_pool": "string",
    "host": "string",
    "network": "string"
}

string

folder

Required

Virtual machine folder into which the virtual machine template should be placed. This field is currently required. In future, if this is unset, the system will attempt to choose a suitable folder for the virtual machine template; if a folder cannot be chosen, publishing a virtual machine template item will fail. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: Folder:VCenter. When operations return a value of this structure as a result, the field will be an identifier for the resource type: Folder:VCenter.

string

cluster

Optional

Cluster onto which the virtual machine template should be placed. If Subscriptions.CreateSpecPlacement.cluster and Subscriptions.CreateSpecPlacement.resource-pool are both specified, Subscriptions.CreateSpecPlacement.resource-pool must belong to Subscriptions.CreateSpecPlacement.cluster. If Subscriptions.CreateSpecPlacement.cluster and Subscriptions.CreateSpecPlacement.host are both specified, Subscriptions.CreateSpecPlacement.host must be a member of Subscriptions.CreateSpecPlacement.cluster. If Subscriptions.CreateSpecPlacement.resource-pool or Subscriptions.CreateSpecPlacement.host is specified, it is recommended that this field be unset. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: ClusterComputeResource:VCenter. When operations return a value of this structure as a result, the field will be an identifier for the resource type: ClusterComputeResource:VCenter.

string

resource_pool

Required

Resource pool into which the virtual machine template should be placed. If Subscriptions.CreateSpecPlacement.host and Subscriptions.CreateSpecPlacement.resource-pool are both specified, Subscriptions.CreateSpecPlacement.resource-pool must belong to Subscriptions.CreateSpecPlacement.host. If Subscriptions.CreateSpecPlacement.cluster and Subscriptions.CreateSpecPlacement.resource-pool are both specified, Subscriptions.CreateSpecPlacement.resource-pool must belong to Subscriptions.CreateSpecPlacement.cluster. This field is currently required. In future, if this is unset, the system will attempt to choose a suitable resource pool for the virtual machine template; if a resource pool cannot be chosen, publish of virtual machine template item will fail. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: ResourcePool:VCenter. When operations return a value of this structure as a result, the field will be an identifier for the resource type: ResourcePool:VCenter.

string

host

Optional

Host onto which the virtual machine template should be placed. If Subscriptions.CreateSpecPlacement.host and Subscriptions.CreateSpecPlacement.resource-pool are both specified, Subscriptions.CreateSpecPlacement.resource-pool must belong to Subscriptions.CreateSpecPlacement.host. If Subscriptions.CreateSpecPlacement.host and Subscriptions.CreateSpecPlacement.cluster are both specified, Subscriptions.CreateSpecPlacement.host must be a member of Subscriptions.CreateSpecPlacement.cluster. If this is unset, the system will attempt to choose a suitable host for the virtual machine template; if a host cannot be chosen, publishing the virtual machine template item will fail. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: HostSystem:VCenter. When operations return a value of this structure as a result, the field will be an identifier for the resource type: HostSystem:VCenter.

string

network

Optional

Network that backs the virtual Ethernet adapters in the virtual machine template. If unset, the virtual Ethernet adapters will not be backed by a network. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: Network:VCenter. When operations return a value of this structure as a result, the field will be an identifier for the resource type: Network:VCenter.