TypeOvfOvfTemplate

Provides extra information about a library item of type “ovf”. An OVF library item is the basic building block for instantiating virtual machines from content library. It may contain one or multiple virtual machine templates. This structure provides a rich view of the virtual machines within the ovf container as well as information about to the ovf descriptor associated with the library item

Properties

string

id Required

Library item id. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.content.library.Item. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.content.library.Item.

boolean

is_vapp_template Required

True if this is a vApp template, otherwise this is a VM template.

string

library_id_parent Required

The identifier of the LibraryModel to which this item belongs. This is used to set the parent of the ovf template for permission propagation. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.content.Library. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.content.Library.

array of TypeOvfNetwork

networks Required

networks in this OVF template

array of TypeOvfPolicyStoragePolicyGroup

storage_policy_groups Optional

Storage policy groups for disks, virtual machines and/or virtual machine collections. An OVF template does not require policies.

TypeOvfVAppTemplate

vapp_template Optional

The root VApp template in this OVF template if this is a vApp template An OVF template does not require a vApp template.

string

version Required

A version number indicating the generation of the OvfTemplate This value is incremented every time OvfTemplate changes.

integer as int64

vm_count Required

Number of virtual machines in the the ovf template.

TypeOvfVmTemplate

vm_template Optional

The Vitrual Machine if this is a VM template An OVF template does not require a VM template.

JSON Example

Show optional properties

{
	"id": "string",
	"is_vapp_template": false,
	"library_id_parent": "string",
	"networks": [
		{
			"name": "string"
		}
	],
	"version": "string",
	"vm_count": 0
}

{
	"id": "string",
	"is_vapp_template": false,
	"library_id_parent": "string",
	"networks": [
		{
			"description": "string",
			"name": "string"
		}
	],
	"storage_policy_groups": [
		{
			"description": "string",
			"id": "string",
			"name": "string"
		}
	],
	"vapp_template": {
		"storage_policies": [
			{
				"group_id": "string"
			}
		],
		"vapp_name": "string",
		"vm_templates": [
			{
				"cpu": {
					"limit": 0,
					"num_cpus": 0,
					"reservation": 0,
					"shares": 0
				},
				"disk_controllers": [
					{
						"name": "string",
						"sub_type": "string",
						"type": "string"
					}
				],
				"disks": [
					{
						"disk_capacity": 0,
						"name": "string",
						"storage_policy": {
							"group_id": "string"
						}
					}
				],
				"drives": [
					{
						"name": "string",
						"sub_type": "string",
						"type": "string"
					}
				],
				"floppies": [
					{
						"connected": false,
						"name": "string",
						"type": "string"
					}
				],
				"memory": {
					"limit": 0,
					"reservation": 0,
					"shares": 0,
					"size": 0
				},
				"nics": [
					{
						"mac_address": "string",
						"name": "string",
						"network_name": "string",
						"start_connected": false
					}
				],
				"os_description": "string",
				"os_type": "string",
				"storage_policies": [
					{
						"group_id": "string"
					}
				],
				"usb_controllers": [
					{
						"auto_connect": false,
						"ehci_pci_slot_number": 0,
						"pci_slot_number": 0,
						"type": "string"
					}
				],
				"video_cards": [
					{
						"enable3d": false,
						"graphics_memory_size": 0,
						"num_displays": 0,
						"render_type": "string",
						"use_auto_detect": false,
						"video_ram_size": 0
					}
				],
				"vm_name": "string"
			}
		]
	},
	"version": "string",
	"vm_count": 0,
	"vm_template": {
		"cpu": {
			"limit": 0,
			"num_cpus": 0,
			"reservation": 0,
			"shares": 0
		},
		"disk_controllers": [
			{
				"name": "string",
				"sub_type": "string",
				"type": "string"
			}
		],
		"disks": [
			{
				"disk_capacity": 0,
				"name": "string",
				"storage_policy": {
					"group_id": "string"
				}
			}
		],
		"drives": [
			{
				"name": "string",
				"sub_type": "string",
				"type": "string"
			}
		],
		"floppies": [
			{
				"connected": false,
				"name": "string",
				"type": "string"
			}
		],
		"memory": {
			"limit": 0,
			"reservation": 0,
			"shares": 0,
			"size": 0
		},
		"nics": [
			{
				"mac_address": "string",
				"name": "string",
				"network_name": "string",
				"start_connected": false
			}
		],
		"os_description": "string",
		"os_type": "string",
		"storage_policies": [
			{
				"group_id": "string"
			}
		],
		"usb_controllers": [
			{
				"auto_connect": false,
				"ehci_pci_slot_number": 0,
				"pci_slot_number": 0,
				"type": "string"
			}
		],
		"video_cards": [
			{
				"enable3d": false,
				"graphics_memory_size": 0,
				"num_displays": 0,
				"render_type": "string",
				"use_auto_detect": false,
				"video_ram_size": 0
			}
		],
		"vm_name": "string"
	}
}

TypeOvfOvfTemplate

Properties

JSON Example

Was this page helpful?