com.vmware.content.type package

Submodules

com.vmware.content.type.ovf_client module

class com.vmware.content.type.ovf_client.Cpu(num_cpus=None, reservation=None, limit=None, shares=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Provide the CPU information in a template VM.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

  • num_cpus (long) – number of CPUs

  • reservation (long or None) – reservation in MHz It is optional to set a CPU reservation.

  • limit (long or None) – CPU limit in MHz Is is optional to set a CPU limit.

  • shares (long or None) – CPU shares It is optional to specify CPU shares.

class com.vmware.content.type.ovf_client.Disk(name=None, disk_capacity=None, storage_policy=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Provide the disk information in a template VM.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

  • name (str) – Name of the disk

  • disk_capacity (long) – Capacity of the disk in megabytes

  • storage_policy (com.vmware.content.type.ovf.policy_client.StoragePolicy or None) –

    Storage policy of the disk.

    It is a reference to the storage policy group. It is not required that storage policy be specified.

class com.vmware.content.type.ovf_client.DiskController(name=None, type=None, sub_type=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Provide the disk controller information in a template VM.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

  • name (str) – Name of the disk controller

  • type (str or None) – Disk controller type: DiskControllerType.IDE.SATA.SCSI; It is optional to specify a disk controller type.

  • sub_type (str or None) – Disk controller sub type: DiskControllerSubType It is optional to specify a disk controller subtype.

class com.vmware.content.type.ovf_client.Drive(name=None, type=None, sub_type=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Provide the drive information in a template VM.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

  • name (str) – Name of the drive

  • type (str or None) – Drive type It is optional to specify a drive type.

  • sub_type (str or None) – Drive sub type It is optional to specify a drive subtype.

class com.vmware.content.type.ovf_client.Floppy(name=None, connected=None, type=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Provide the floppy information in a template VM.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

  • name (str) – Name of the floppy

  • connected (bool or None) – True if floppy is connected It is optional to specify if a floppy is connected.

  • type (str or None) – Floppy type It is optional to specify the type of floppy drive.

class com.vmware.content.type.ovf_client.Memory(size=None, reservation=None, limit=None, shares=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Provide the memory information in a template VM.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

  • size (long) – memory size in MB

  • reservation (long or None) – memory reservation in MB It is not required that memory reservation be specified.

  • limit (long or None) – memory limit in MB It is not required that memory limit be specified.

  • shares (long or None) – memory shares It is not required that memory shares be specified.

class com.vmware.content.type.ovf_client.Network(name=None, description=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Provide network information in a template VM.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

  • name (str) – Name of the network

  • description (str or None) – Description of the network Networks do not require a description.

class com.vmware.content.type.ovf_client.Nic(name=None, network_name=None, mac_address=None, start_connected=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Provide NIC information in a VM template

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

  • name (str) – Name of NIC

  • network_name (str or None) – Name of the network that this NIC connects to It is not required that network name be specified.

  • mac_address (str or None) – Mac address of this NIC It is not required that MAC address be specified.

  • start_connected (bool or None) – True if this nic will be connected on start. It is not required that whether the NIC is connected be specified.

class com.vmware.content.type.ovf_client.OvfTemplate(id=None, vm_count=None, version=None, library_id_parent=None, is_vapp_template=None, vm_template=None, vapp_template=None, networks=None, storage_policy_groups=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

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

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

  • id (str) – Library item id. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.content.library.Item. When methods return a value of this class as a return value, the attribute 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 (str) –

    A version number indicating the generation of the OvfTemplate

    This value is incremented every time OvfTemplate changes.

  • library_id_parent (str) – The identifier of the com.vmware.content_client.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 class as a parameter, the attribute must be an identifier for the resource type: com.vmware.content.Library. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.content.Library.

  • is_vapp_template (bool) – True if this is a vApp template, otherwise this is a VM template.

  • vm_template (VmTemplate or None) – The Vitrual Machine if this is a VM template An OVF template does not require a VM template.

  • vapp_template (VAppTemplate or None) – The root VApp template in this OVF template if this is a vApp template An OVF template does not require a vApp template.

  • networks (list of Network) – networks in this OVF template

  • storage_policy_groups (list of com.vmware.content.type.ovf.policy_client.StoragePolicyGroup or None) – Storage policy groups for disks, virtual machines and/or virtual machine collections. An OVF template does not require policies.

class com.vmware.content.type.ovf_client.StubFactory(stub_config)

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

class com.vmware.content.type.ovf_client.USBController(type=None, auto_connect=None, ehci_pci_slot_number=None, pci_slot_number=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Provide USB controller information in a template VM.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

  • type (str or None) – USBControllerType.EHCI (USB 2.0), XHCI (USB 3.0) A template is not required to specify the USB type.

  • auto_connect (bool or None) – True if the USB controller is connected automatically A template is not required to specify if auto connect.

  • ehci_pci_slot_number (long or None) – ehci.pci slot number A template is not required to specify the ehci.pci slot number.

  • pci_slot_number (long or None) – pci slot number A template is not required to specify the pci slot number.

class com.vmware.content.type.ovf_client.VAppTemplate(vapp_name=None, vm_templates=None, storage_policies=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Provide information for vApp template in an OVF template file.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

  • vapp_name (str or None) – Name of the vApp template vApp templates do not require a name.

  • vm_templates (list of VmTemplate or None) – Vitrual Machines in this vApp template vApp templates do not require a list of VM templates.

  • storage_policies (list of com.vmware.content.type.ovf.policy_client.StoragePolicy or None) – Storage policies of the vApp template. vApp templates do not require a list of storage policies.

class com.vmware.content.type.ovf_client.VideoCard(render_type=None, video_ram_size=None, graphics_memory_size=None, enable3d=None, num_displays=None, use_auto_detect=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Provide video card information in a template VM.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

  • render_type (str or None) – Render type A template is not required to specify the render type.

  • video_ram_size (long or None) – video RAM size in KB A template is not required to specify the video RAM.

  • graphics_memory_size (long or None) – graphics memory size in KB A template is not required to specify the amount of graphics memory.

  • enable3d (bool or None) – True if 3D is enabled A template is not required to specify if 3D is enabled.

  • num_displays (long or None) – number of displayes A template is not required to specify the number of displays.

  • use_auto_detect (bool or None) – True if use auto detect A template is not required to specify use auto dectect.

class com.vmware.content.type.ovf_client.VmTemplate(vm_name=None, os_type=None, os_description=None, cpu=None, memory=None, disks=None, nics=None, video_cards=None, drives=None, floppies=None, disk_controllers=None, usb_controllers=None, storage_policies=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Provide template VM information in an OVF template (see OvfTemplate#type). The template VM provide the information about the operation system, CPU, memory, disks and NICs.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

  • vm_name (str) – Name of the VM

  • os_type (str or None) – OS type of the VM A VM template is not required to specify an OS.

  • os_description (str or None) – OS description A VM template is not required to specify an OS.

  • cpu (Cpu or None) – CPU information of the VM A VM template is not required to specify a CPU.

  • memory (Memory or None) – memory information of the VM A VM template is not required to specify memory.

  • disks (list of Disk or None) – All hard disks on the VM A VM template is not required to specify a list of disks.

  • nics (list of Nic or None) – All NICs on the VM A VM template is not required to specify a list of network interfaces.

  • video_cards (list of VideoCard or None) – Video cards of the VM A VM template is not required to specify a list of video cards.

  • drives (list of Drive or None) – CD / DVD drives of the VM A VM template is not required to specify a list of drives.

  • floppies (list of Floppy or None) – floppy drives of the VM A VM template is not required to specify a list of floppy drives.

  • disk_controllers (list of DiskController or None) – Disk Controllers A VM template is not required to specify a list of disk controllers.

  • usb_controllers (list of USBController or None) – USB Controllers A VM template is not required to specify a list of USB controllers.

  • storage_policies (list of com.vmware.content.type.ovf.policy_client.StoragePolicy or None) – Storage policies of the VM. A VM template is not required to specify a list of storage policies.