content type ovf: ovf template

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

Representation:

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

Attributes:

Name Type Description
Required
id string 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.

vm_count long Number of virtual machines in the the ovf template.

version string A version number indicating the generation of the OvfTemplate

This value is incremented every time OvfTemplate changes.

library_id_parent string The identifier of the content.library_model 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.

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

vm_template.vm_name string Name of the VM

vm_template.cpu.num_cpus long number of CPUs

vm_template.memory.size long memory size in MB

networks network[] networks in this OVF template

Optional
vm_template vm_template The Vitrual Machine if this is a VM template

Optional. An OVF template does not require a VM template.

vm_template.os_type string OS type of the VM

Optional. A VM template is not required to specify an OS.

vm_template.os_description string OS description

Optional. A VM template is not required to specify an OS.

vm_template.cpu cpu CPU information of the VM

Optional. A VM template is not required to specify a CPU.

vm_template.cpu.reservation long reservation in MHz

Optional. It is optional to set a CPU reservation.

vm_template.cpu.limit long CPU limit in MHz

Optional. Is is optional to set a CPU limit.

vm_template.cpu.shares long CPU shares

Optional. It is optional to specify CPU shares.

vm_template.memory memory memory information of the VM

Optional. A VM template is not required to specify memory.

vm_template.memory.reservation long memory reservation in MB

Optional. It is not required that memory reservation be specified.

vm_template.memory.limit long memory limit in MB

Optional. It is not required that memory limit be specified.

vm_template.memory.shares long memory shares

Optional. It is not required that memory shares be specified.

vm_template.disks disk[] All hard disks on the VM

Optional. A VM template is not required to specify a list of disks.

vm_template.nics nic[] All NICs on the VM

Optional. A VM template is not required to specify a list of network interfaces.

vm_template.video_cards video_card[] Video cards of the VM

Optional. A VM template is not required to specify a list of video cards.

vm_template.drives drive[] CD / DVD drives of the VM

Optional. A VM template is not required to specify a list of drives.

vm_template.floppies floppy[] floppy drives of the VM

Optional. A VM template is not required to specify a list of floppy drives.

vm_template.disk_controllers disk_controller[] Disk Controllers

Optional. A VM template is not required to specify a list of disk controllers.

vm_template.usb_controllers USB_controller[] USB Controllers

Optional. A VM template is not required to specify a list of USB controllers.

vm_template.storage_policies storage_policy[] Storage policies of the VM.

Optional. A VM template is not required to specify a list of storage policies.

vapp_template V_app_template The root VApp template in this OVF template if this is a vApp template

Optional. An OVF template does not require a vApp template.

vapp_template.vapp_name string Name of the vApp template

Optional. vApp templates do not require a name.

vapp_template.vm_templates vm_template[] Vitrual Machines in this vApp template

Optional. vApp templates do not require a list of VM templates.

vapp_template.storage_policies storage_policy[] Storage policies of the vApp template.

Optional. vApp templates do not require a list of storage policies.

storage_policy_groups storage_policy_group[] Storage policy groups for disks, virtual machines and/or virtual machine collections.

Optional. An OVF template does not require policies.