vm Package

vm Package

hardware_client Module

The com.vmware.vcenter.vm.hardware_client module provides classes for managing the virtual hardware configuration and state of a virtual machine. This includes methods for reading and manipulating virtual device configuration and for querying the runtime state of the devices.

class com.vmware.vcenter.vm.hardware_client.Boot(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

The Boot class provides methods for configuring the settings used when booting a virtual machine.

Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

class CreateSpec(type=None, efi_legacy_boot=None, network_protocol=None, delay=None, retry=None, retry_delay=None, enter_setup_mode=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Boot.CreateSpec class describes settings used when booting a virtual machine.

Tip

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

Parameters:

• type (Boot.Type or None) – Firmware type to be used by the virtual machine. If None, defaults to value that is recommended for the guest OS and is supported for the virtual hardware version.
• efi_legacy_boot (bool or None) – Flag indicating whether to use EFI legacy boot mode. If None, defaults to value that is recommended for the guest OS and is supported for the virtual hardware version.
• network_protocol (Boot.NetworkProtocol or None) – Protocol to use when attempting to boot the virtual machine over the network. If None, defaults to a system defined default value.
• delay (long or None) – Delay in milliseconds before beginning the firmware boot process when the virtual machine is powered on. This delay may be used to provide a time window for users to connect to the virtual machine console and enter BIOS setup mode. If None, default value is 0.
• retry (bool or None) – Flag indicating whether the virtual machine should automatically retry the boot process after a failure. If None, default value is false.
• retry_delay (long or None) – Delay in milliseconds before retrying the boot process after a failure; applicable only when Boot.Info.retry is true. If None, default value is 10000.
• enter_setup_mode (bool or None) – Flag indicating whether the firmware boot process should automatically enter setup mode the next time the virtual machine boots. Note that this flag will automatically be reset to false once the virtual machine enters setup mode. If None, the value is unchanged.

class Boot.Info(type=None, efi_legacy_boot=None, network_protocol=None, delay=None, retry=None, retry_delay=None, enter_setup_mode=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Boot.Info class contains information about the virtual machine boot process.

Tip

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

Parameters:

• type (Boot.Type) – Firmware type used by the virtual machine.
• efi_legacy_boot (bool) – Flag indicating whether to use EFI legacy boot mode. This attribute is optional and it is only relevant when the value of type is Boot.Type.EFI.
• network_protocol (Boot.NetworkProtocol) – Protocol to use when attempting to boot the virtual machine over the network. This attribute is optional and it is only relevant when the value of type is Boot.Type.EFI.
• delay (long) – Delay in milliseconds before beginning the firmware boot process when the virtual machine is powered on. This delay may be used to provide a time window for users to connect to the virtual machine console and enter BIOS setup mode.
• retry (bool) – Flag indicating whether the virtual machine will automatically retry the boot process after a failure.
• retry_delay (long) – Delay in milliseconds before retrying the boot process after a failure; applicable only when Boot.Info.retry is true.
• enter_setup_mode (bool) – Flag indicating whether the firmware boot process will automatically enter setup mode the next time the virtual machine boots. Note that this flag will automatically be reset to false once the virtual machine enters setup mode.

class Boot.NetworkProtocol(string)

Bases: vmware.vapi.bindings.enum.Enum

The Boot.NetworkProtocol class defines the valid network boot protocols supported when booting a virtual machine with Boot.Type.EFI firmware over the network.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters:string (str) – String value for the NetworkProtocol instance.

IPV4 = NetworkProtocol(string=u'IPV4')

PXE or Apple NetBoot over IPv4.

IPV6 = NetworkProtocol(string=u'IPV6')

PXE over IPv6.

class Boot.Type(string)

Bases: vmware.vapi.bindings.enum.Enum

The Boot.Type class defines the valid firmware types for a virtual machine.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters:string (str) – String value for the Type instance.

BIOS = Type(string=u'BIOS')

Basic Input/Output System (BIOS) firmware.

EFI = Type(string=u'EFI')

Extensible Firmware Interface (EFI) firmware.

class Boot.UpdateSpec(type=None, efi_legacy_boot=None, network_protocol=None, delay=None, retry=None, retry_delay=None, enter_setup_mode=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Boot.UpdateSpec class describes the updates to the settings used when booting a virtual machine.

Tip

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

Parameters:

• type (Boot.Type or None) – Firmware type to be used by the virtual machine. If None, the value is unchanged.
• efi_legacy_boot (bool or None) – Flag indicating whether to use EFI legacy boot mode. If None, the value is unchanged.
• network_protocol (Boot.NetworkProtocol or None) – Protocol to use when attempting to boot the virtual machine over the network. If None, the value is unchanged.
• delay (long or None) – Delay in milliseconds before beginning the firmware boot process when the virtual machine is powered on. This delay may be used to provide a time window for users to connect to the virtual machine console and enter BIOS setup mode. If None, the value is unchanged.
• retry (bool or None) – Flag indicating whether the virtual machine should automatically retry the boot process after a failure. If None, the value is unchanged.
• retry_delay (long or None) – Delay in milliseconds before retrying the boot process after a failure; applicable only when Boot.Info.retry is true. If None, the value is unchanged.
• enter_setup_mode (bool or None) – Flag indicating whether the firmware boot process should automatically enter setup mode the next time the virtual machine boots. Note that this flag will automatically be reset to false once the virtual machine enters setup mode. If None, the value is unchanged.

Boot.get(vm)

Returns the boot-related settings of a virtual machine.

Parameters:vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine. Return type:Boot.Info Returns:Boot-related settings of the virtual machine. Raise :com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request. Raise :com.vmware.vapi.std.errors_client.NotFound if the virtual machine is not found. Raise :com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed. Raise :com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request. Raise :com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated. Raise :com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

Boot.update(vm, spec)

Updates the boot-related settings of a virtual machine.

Parameters:

• vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
• spec (Boot.UpdateSpec) – Specification for updating the boot-related settings of the virtual machine.

Raise :

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise :

com.vmware.vapi.std.errors_client.NotFound if the virtual machine is not found.

Raise :

com.vmware.vapi.std.errors_client.InvalidArgument if one of the provided settings is not permitted; for example, specifying a negative value for delay.

Raise :

com.vmware.vapi.std.errors_client.ResourceBusy if the virtual machine is busy performing another operation.

Raise :

com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed.

Raise :

com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.

Raise :

com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.

Raise :

com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

class com.vmware.vcenter.vm.hardware_client.Cdrom(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

The Cdrom class provides methods for configuring the virtual CD-ROM devices of a virtual machine.

Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

class BackingInfo(type=None, iso_file=None, host_device=None, auto_detect=None, device_access_type=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Cdrom.BackingInfo class contains information about the physical resource backing a virtual CD-ROM device.

Tip

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

Parameters:

• type (Cdrom.BackingType) – Backing type for the virtual CD-ROM device.
• iso_file (str) – Path of the image file backing the virtual CD-ROM device. This attribute is optional and it is only relevant when the value of type is Cdrom.BackingType.ISO_FILE.
• host_device (str or None) – Name of the host device backing the virtual CD-ROM device. This attribute will be None if autoDetect is true and the virtual CD-ROM device is not connected or no suitable device is available on the host.
• auto_detect (bool) – Flag indicating whether the virtual CD-ROM device is configured to automatically detect a suitable host device. This attribute is optional and it is only relevant when the value of type is Cdrom.BackingType.HOST_DEVICE.
• device_access_type (Cdrom.DeviceAccessType) – Access type for the device backing. This attribute is optional and it is only relevant when the value of type is one of Cdrom.BackingType.HOST_DEVICE or Cdrom.BackingType.CLIENT_DEVICE.

class Cdrom.BackingSpec(type=None, iso_file=None, host_device=None, device_access_type=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Cdrom.BackingSpec class provides a specification of the physical resource backing a virtual CD-ROM device.

Tip

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

Parameters:

• type (Cdrom.BackingType) – Backing type for the virtual CD-ROM device.
• iso_file (str) – Path of the image file that should be used as the virtual CD-ROM device backing. This attribute is optional and it is only relevant when the value of type is Cdrom.BackingType.ISO_FILE.
• host_device (str or None) – Name of the device that should be used as the virtual CD-ROM device backing. If None, the virtual CD-ROM device will be configured to automatically detect a suitable host device.
• device_access_type (Cdrom.DeviceAccessType or None) – Access type for the device backing. If None, defaults to Cdrom.DeviceAccessType.EMULATION.

class Cdrom.BackingType(string)

Bases: vmware.vapi.bindings.enum.Enum

The Cdrom.BackingType class defines the valid backing types for a virtual CD-ROM device.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters:string (str) – String value for the BackingType instance.

CLIENT_DEVICE = BackingType(string=u'CLIENT_DEVICE')

Virtual CD-ROM device is backed by a device on the client that is connected to the virtual machine console.

HOST_DEVICE = BackingType(string=u'HOST_DEVICE')

Virtual CD-ROM device is backed by a device on the host where the virtual machine is running.

ISO_FILE = BackingType(string=u'ISO_FILE')

Virtual CD-ROM device is backed by an ISO file.

class Cdrom.CreateSpec(type=None, ide=None, sata=None, backing=None, start_connected=None, allow_guest_control=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Cdrom.CreateSpec class provides a specification for the configuration of a newly-created virtual CD-ROM device.

Tip

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

Parameters:

• type (Cdrom.HostBusAdapterType or None) – Type of host bus adapter to which the device should be attached. If None, guest-specific default values will be used
• ide (IdeAddressSpec or None) – Address for attaching the device to a virtual IDE adapter. If None, the server will choose an available address; if none is available, the request will fail.
• sata (SataAddressSpec or None) – Address for attaching the device to a virtual SATA adapter. If None, the server will choose an available address; if none is available, the request will fail.
• backing (Cdrom.BackingSpec or None) – Physical resource backing for the virtual CD-ROM device. If None, defaults to automatic detection of a suitable host device.
• start_connected (bool or None) – Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on. Defaults to false if None.
• allow_guest_control (bool or None) – Flag indicating whether the guest can connect and disconnect the device. Defaults to false if None.

class Cdrom.DeviceAccessType(string)

Bases: vmware.vapi.bindings.enum.Enum

The Cdrom.DeviceAccessType class defines the valid device access types for a physical device packing of a virtual CD-ROM device.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters:string (str) – String value for the DeviceAccessType instance.

EMULATION = DeviceAccessType(string=u'EMULATION')

ATAPI or SCSI device emulation.

PASSTHRU = DeviceAccessType(string=u'PASSTHRU')

Raw passthru device access.

PASSTHRU_EXCLUSIVE = DeviceAccessType(string=u'PASSTHRU_EXCLUSIVE')

Raw passthru device access, with exclusive access to the device.

class Cdrom.HostBusAdapterType(string)

Bases: vmware.vapi.bindings.enum.Enum

The Cdrom.HostBusAdapterType class defines the valid types of host bus adapters that may be used for attaching a Cdrom to a virtual machine.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters:string (str) – String value for the HostBusAdapterType instance.

IDE = HostBusAdapterType(string=u'IDE')

Cdrom is attached to an IDE adapter.

SATA = HostBusAdapterType(string=u'SATA')

Cdrom is attached to a SATA adapter.

class Cdrom.Info(type=None, label=None, ide=None, sata=None, backing=None, state=None, start_connected=None, allow_guest_control=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Cdrom.Info class contains information about a virtual CD-ROM device.

Tip

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

Parameters:

• type (Cdrom.HostBusAdapterType) – Type of host bus adapter to which the device is attached.
• label (str) – Device label.
• ide (IdeAddressInfo) – Address of device attached to a virtual IDE adapter. This attribute is optional and it is only relevant when the value of type is Cdrom.HostBusAdapterType.IDE.
• sata (SataAddressInfo) – Address of device attached to a virtual SATA adapter. This attribute is optional and it is only relevant when the value of type is Cdrom.HostBusAdapterType.SATA.
• backing (Cdrom.BackingInfo) – Physical resource backing for the virtual CD-ROM device.
• state (ConnectionState) – Connection status of the virtual device.
• start_connected (bool) – Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.
• allow_guest_control (bool) – Flag indicating whether the guest can connect and disconnect the device.

Cdrom.RESOURCE_TYPE = 'com.vmware.vcenter.vm.hardware.Cdrom'

Resource type for the virtual CD-ROM device.

class Cdrom.Summary(cdrom=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Cdrom.Summary class contains commonly used information about a virtual CD-ROM device.

Tip

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

Parameters:cdrom (str) – Identifier of the virtual CD-ROM device. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Cdrom. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Cdrom.

class Cdrom.UpdateSpec(backing=None, start_connected=None, allow_guest_control=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Cdrom.UpdateSpec class describes the updates to be made to the configuration of a virtual CD-ROM device.

Tip

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

Parameters:

• backing (Cdrom.BackingSpec or None) –

  Physical resource backing for the virtual CD-ROM device.

  This attribute may only be modified if the virtual machine is not powered on or the virtual CD-ROM device is not connected. If None, the value is unchanged.

• start_connected (bool or None) – Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on. If None, the value is unchanged.
• allow_guest_control (bool or None) – Flag indicating whether the guest can connect and disconnect the device. If None, the value is unchanged.

Cdrom.connect(vm, cdrom)

Connects a virtual CD-ROM device of a powered-on virtual machine to its backing. Connecting the virtual device makes the backing accessible from the perspective of the guest operating system.

For a powered-off virtual machine, the Cdrom.update() method may be used to configure the virtual CD-ROM device to start in the connected state when the virtual machine is powered on.

Parameters:

• vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
• cdrom (str) – Virtual CD-ROM device identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Cdrom.

Raise :

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise :

com.vmware.vapi.std.errors_client.NotFound if the virtual machine or virtual CD-ROM device is not found.

Raise :

com.vmware.vapi.std.errors_client.AlreadyInDesiredState if the virtual CD-ROM device is already connected.

Raise :

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if the virtual machine is not powered on.

Raise :

com.vmware.vapi.std.errors_client.ResourceBusy if the virtual machine is busy performing another operation.

Raise :

com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed.

Raise :

com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.

Raise :

com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.

Raise :

com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

Cdrom.create(vm, spec)

Adds a virtual CD-ROM device to the virtual machine.

Parameters:

• vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
• spec (Cdrom.CreateSpec) – Specification for the new virtual CD-ROM device.

Return type:

str

Returns:

Virtual CD-ROM device identifier. The return value will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Cdrom.

Raise :

com.vmware.vapi.std.errors_client.Error if the system reported that the CD-ROM device was created but was unable to confirm the creation because the identifier of the new device could not be determined.

Raise :

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise :

com.vmware.vapi.std.errors_client.NotFound if the virtual machine is not found.

Raise :

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if the virtual machine is suspended or if the virtual machine is powered on and virtual CD-ROM type is IDE.

Raise :

com.vmware.vapi.std.errors_client.UnableToAllocateResource if the specified storage address is unavailable; for example, if the SCSI adapter requested does not exist.

Raise :

com.vmware.vapi.std.errors_client.ResourceInUse if the specified storage address is in use.

Raise :

com.vmware.vapi.std.errors_client.InvalidArgument if the specified storage address is out of bounds.

Raise :

com.vmware.vapi.std.errors_client.ResourceBusy if the virtual machine is busy performing another operation.

Raise :

com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed.

Raise :

com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.

Raise :

com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.

Raise :

com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

Raise :

com.vmware.vapi.std.errors_client.Unsupported if the guest operating system of the virtual machine is not supported and spec includes None attributes that default to guest-specific values.

Cdrom.delete(vm, cdrom)

Removes a virtual CD-ROM device from the virtual machine.

Parameters:

• vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
• cdrom (str) – Virtual CD-ROM device identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Cdrom.

Raise :

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise :

com.vmware.vapi.std.errors_client.NotFound if the virtual machine or virtual CD-ROM device is not found.

Raise :

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if the virtual machine is suspended or if the virtual machine is powered on and virtual CD-ROM type is IDE.

Raise :

com.vmware.vapi.std.errors_client.ResourceBusy if the virtual machine is busy performing another operation.

Raise :

com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed.

Raise :

com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.

Raise :

com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.

Raise :

com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

Cdrom.disconnect(vm, cdrom)

Disconnects a virtual CD-ROM device of a powered-on virtual machine from its backing. The virtual device is still present and its backing configuration is unchanged, but from the perspective of the guest operating system, the CD-ROM device is not connected to its backing resource.

For a powered-off virtual machine, the Cdrom.update() method may be used to configure the virtual CD-ROM device to start in the disconnected state when the virtual machine is powered on.

Parameters:

• vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
• cdrom (str) – Virtual CD-ROM device identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Cdrom.

Raise :

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise :

com.vmware.vapi.std.errors_client.NotFound if the virtual machine or virtual CD-ROM device is not found.

Raise :

com.vmware.vapi.std.errors_client.AlreadyInDesiredState if the virtual CD-ROM device is already disconnected.

Raise :

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if the virtual machine is not powered on.

Raise :

com.vmware.vapi.std.errors_client.ResourceBusy if the virtual machine is busy performing another operation.

Raise :

com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed.

Raise :

com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.

Raise :

com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.

Raise :

com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

Cdrom.get(vm, cdrom)

Returns information about a virtual CD-ROM device.

Parameters:

• vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
• cdrom (str) – Virtual CD-ROM device identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Cdrom.

Return type:

Cdrom.Info

Returns:

Information about the specified virtual CD-ROM device.

Raise :

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise :

com.vmware.vapi.std.errors_client.NotFound if the virtual machine or virtual CD-ROM device is not found.

Raise :

com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed.

Raise :

com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.

Raise :

com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.

Raise :

com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

Cdrom.list(vm)

Returns commonly used information about the virtual CD-ROM devices belonging to the virtual machine.

Parameters:vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine. Return type:list of Cdrom.Summary Returns:List of commonly used information about virtual CD-ROM devices. Raise :com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request. Raise :com.vmware.vapi.std.errors_client.NotFound if the virtual machine is not found. Raise :com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed. Raise :com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request. Raise :com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated. Raise :com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

Cdrom.update(vm, cdrom, spec)

Updates the configuration of a virtual CD-ROM device.

Parameters:

• vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
• cdrom (str) – Virtual CD-ROM device identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Cdrom.
• spec (Cdrom.UpdateSpec) – Specification for updating the virtual CD-ROM device.

Raise :

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise :

com.vmware.vapi.std.errors_client.NotFound if the virtual machine or virtual CD-ROM device is not found.

Raise :

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if one or more of the attributes specified in the spec parameter cannot be modified due to the current power state of the virtual machine or the connection state of the virtual CD-ROM device.

Raise :

com.vmware.vapi.std.errors_client.ResourceBusy if the virtual machine is busy performing another operation.

Raise :

com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed.

Raise :

com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.

Raise :

com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.

Raise :

com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

class com.vmware.vcenter.vm.hardware_client.ConnectionCreateSpec(start_connected=None, allow_guest_control=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The ConnectionCreateSpec class provides a specification for the configuration of a newly-created removable device.

Tip

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

Parameters:

• start_connected (bool or None) – Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on. Defaults to false if None.
• allow_guest_control (bool or None) – Flag indicating whether the guest can connect and disconnect the device. Defaults to false if None.

class com.vmware.vcenter.vm.hardware_client.ConnectionInfo(state=None, start_connected=None, allow_guest_control=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The ConnectionInfo class provides information about the state and configuration of a removable virtual device.

Tip

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

Parameters:

• state (ConnectionState) – Connection status of the virtual device.
• start_connected (bool) – Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.
• allow_guest_control (bool) – Flag indicating whether the guest can connect and disconnect the device.

class com.vmware.vcenter.vm.hardware_client.ConnectionState(string)

Bases: vmware.vapi.bindings.enum.Enum

The ConnectionState class defines the valid states for a removable device that is configured to be connected.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters:string (str) – String value for the ConnectionState instance.

CONNECTED = ConnectionState(string=u'CONNECTED')

The device is connected and working correctly.

NOT_CONNECTED = ConnectionState(string=u'NOT_CONNECTED')

The device is not connected.

RECOVERABLE_ERROR = ConnectionState(string=u'RECOVERABLE_ERROR')

Device connection failed due to a recoverable error; for example, the virtual device backing is currently in use by another virtual machine.

UNKNOWN = ConnectionState(string=u'UNKNOWN')

The device status is unknown.

UNRECOVERABLE_ERROR = ConnectionState(string=u'UNRECOVERABLE_ERROR')

Device connection failed due to an unrecoverable error; for example, the virtual device backing does not exist.

class com.vmware.vcenter.vm.hardware_client.ConnectionUpdateSpec(start_connected=None, allow_guest_control=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The ConnectionUpdateSpec class describes the updates to be made to the configuration of a removable virtual device.

Tip

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

Parameters:

• start_connected (bool or None) – Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on. If None, the value is unchanged.
• allow_guest_control (bool or None) – Flag indicating whether the guest can connect and disconnect the device. If None, the value is unchanged.

class com.vmware.vcenter.vm.hardware_client.Cpu(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

The Cpu class provides methods for configuring the CPU settings of a virtual machine.

Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

class Info(count=None, cores_per_socket=None, hot_add_enabled=None, hot_remove_enabled=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Cpu.Info class contains CPU-related information about a virtual machine.

Tip

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

Parameters:

• count (long) – Number of CPU cores.
• cores_per_socket (long) – Number of CPU cores per socket.
• hot_add_enabled (bool) – Flag indicating whether adding CPUs while the virtual machine is running is enabled.
• hot_remove_enabled (bool) – Flag indicating whether removing CPUs while the virtual machine is running is enabled.

class Cpu.UpdateSpec(count=None, cores_per_socket=None, hot_add_enabled=None, hot_remove_enabled=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Cpu.UpdateSpec class describes the updates to be made to the CPU-related settings of a virtual machine.

Tip

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

Parameters:

• count (long or None) –

  New number of CPU cores. The number of CPU cores in the virtual machine must be a multiple of the number of cores per socket.

  The supported range of CPU counts is constrained by the configured guest operating system and virtual hardware version of the virtual machine.

  If the virtual machine is running, the number of CPU cores may only be increased if Cpu.Info.hot_add_enabled is true, and may only be decreased if Cpu.Info.hot_remove_enabled is true. If None, the value is unchanged.

• cores_per_socket (long or None) – New number of CPU cores per socket. The number of CPU cores in the virtual machine must be a multiple of the number of cores per socket. If None, the value is unchanged.
• hot_add_enabled (bool or None) –

  Flag indicating whether adding CPUs while the virtual machine is running is enabled.

  This attribute may only be modified if the virtual machine is powered off. If None, the value is unchanged.

• hot_remove_enabled (bool or None) –

  Flag indicating whether removing CPUs while the virtual machine is running is enabled.

  This attribute may only be modified if the virtual machine is powered off. If None, the value is unchanged.

Cpu.get(vm)

Returns the CPU-related settings of a virtual machine.

Parameters:vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine. Return type:Cpu.Info Returns:CPU-related settings of the virtual machine. Raise :com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request. Raise :com.vmware.vapi.std.errors_client.NotFound if the virtual machine is not found. Raise :com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed. Raise :com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request. Raise :com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated. Raise :com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

Cpu.update(vm, spec)

Updates the CPU-related settings of a virtual machine.

Parameters:

• vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
• spec (Cpu.UpdateSpec) – Specification for updating the CPU-related settings of the virtual machine.

Raise :

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise :

com.vmware.vapi.std.errors_client.NotFound if the virtual machine is not found.

Raise :

com.vmware.vapi.std.errors_client.InvalidArgument if one of the provided settings is not permitted; for example, specifying a negative value for count.

Raise :

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if hotAddEnabled or hotRemoveEnabled is specified and the virtual machine is not powered off.

Raise :

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if count is specified and is greater than count, hotAddEnabled is false, and the virtual machine is not powered off.

Raise :

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if count is specified and is less than count, hotRemoveEnabled is false, and the virtual machine is not powered off.

Raise :

com.vmware.vapi.std.errors_client.ResourceBusy if the virtual machine is busy performing another operation.

Raise :

com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed.

Raise :

com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.

Raise :

com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.

Raise :

com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

class com.vmware.vcenter.vm.hardware_client.Disk(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

The Disk class provides methods for configuring the virtual disks of a virtual machine. A virtual disk has a backing such as a VMDK file. The backing has an independent lifecycle from the virtual machine when it is detached from the virtual machine. The Disk.create() method provides the ability to create a new virtual disk. When creating a virtual disk, a new VMDK file may be created or an existing VMDK file may used as a backing. Once a VMDK file is associated with a virtual machine, its lifecycle will be bound to the virtual machine. In other words, it will be deleted when the virtual machine is deleted. The Disk.delete() method provides the ability to detach a VMDK file from the virtual machine. The Disk.delete() method does not delete the VMDK file that backs the virtual disk. Once detached, the VMDK file will not be destroyed when the virtual machine to which it was associated is deleted.

Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

class BackingInfo(type=None, vmdk_file=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Disk.BackingInfo class contains information about the physical resource backing a virtual disk.

Tip

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

Parameters:

• type (Disk.BackingType) – Backing type for the virtual disk.
• vmdk_file (str) – Path of the VMDK file backing the virtual disk. This attribute is optional and it is only relevant when the value of type is Disk.BackingType.VMDK_FILE.

class Disk.BackingSpec(type=None, vmdk_file=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Disk.BackingSpec class provides a specification of the physical resource backing a virtual disk.

Tip

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

Parameters:

• type (Disk.BackingType) – Backing type for the virtual disk.
• vmdk_file (str) – Path of the VMDK file backing the virtual disk. This attribute is optional and it is only relevant when the value of type is Disk.BackingType.VMDK_FILE.

class Disk.BackingType(string)

Bases: vmware.vapi.bindings.enum.Enum

The Disk.BackingType class defines the valid backing types for a virtual disk.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters:string (str) – String value for the BackingType instance.

VMDK_FILE = BackingType(string=u'VMDK_FILE')

Virtual disk is backed by a VMDK file.

class Disk.CreateSpec(type=None, ide=None, scsi=None, sata=None, backing=None, new_vmdk=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Disk.CreateSpec class provides a specification for the configuration of a newly-created virtual disk.

Tip

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

Parameters:

• type (Disk.HostBusAdapterType or None) – Type of host bus adapter to which the device should be attached. If None, guest-specific default values will be used
• ide (IdeAddressSpec or None) – Address for attaching the device to a virtual IDE adapter. If None, the server will choose an available address; if none is available, the request will fail.
• scsi (ScsiAddressSpec or None) – Address for attaching the device to a virtual SCSI adapter. If None, the server will choose an available address; if none is available, the request will fail.
• sata (SataAddressSpec or None) – Address for attaching the device to a virtual SATA adapter. If None, the server will choose an available address; if none is available, the request will fail.
• backing (Disk.BackingSpec or None) – Existing physical resource backing for the virtual disk. Exactly one of backing or newVmdk must be specified. If None, the virtual disk will not be connected to an existing backing.
• new_vmdk (Disk.VmdkCreateSpec or None) – Specification for creating a new VMDK backing for the virtual disk. Exactly one of backing or newVmdk must be specified. If None, a new VMDK backing will not be created.

class Disk.HostBusAdapterType(string)

Bases: vmware.vapi.bindings.enum.Enum

The Disk.HostBusAdapterType class defines the valid types of host bus adapters that may be used for attaching a virtual storage device to a virtual machine.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters:string (str) – String value for the HostBusAdapterType instance.

IDE = HostBusAdapterType(string=u'IDE')

Disk is attached to an IDE adapter.

SATA = HostBusAdapterType(string=u'SATA')

Disk is attached to a SATA adapter.

SCSI = HostBusAdapterType(string=u'SCSI')

Disk is attached to a SCSI adapter.

class Disk.Info(label=None, type=None, ide=None, scsi=None, sata=None, backing=None, capacity=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Disk.Info class contains information about a virtual disk.

Tip

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

Parameters:

• label (str) – Device label.
• type (Disk.HostBusAdapterType) – Type of host bus adapter to which the device is attached.
• ide (IdeAddressInfo) – Address of device attached to a virtual IDE adapter. Workaround for PR1459646
• scsi (ScsiAddressInfo) – Address of device attached to a virtual SCSI adapter. Workaround for PR1459646
• sata (SataAddressInfo) – Address of device attached to a virtual SATA adapter. Workaround for PR1459646
• backing (Disk.BackingInfo) – Physical resource backing for the virtual disk.
• capacity (long or None) – Capacity of the virtual disk in bytes. If None, virtual disk is inaccessible or disk capacity is 0.

Disk.RESOURCE_TYPE = 'com.vmware.vcenter.vm.hardware.Disk'

Resource type for the virtual disk.

class Disk.Summary(disk=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Disk.Summary class contains commonly used information about a virtual disk.

Tip

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

Parameters:disk (str) – Identifier of the virtual Disk. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.

class Disk.UpdateSpec(backing=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Disk.UpdateSpec class describes the updates to be made to the configuration of a virtual disk.

Tip

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

Parameters:backing (Disk.BackingSpec or None) –

Physical resource backing for the virtual disk.

This attribute may only be modified if the virtual machine is not powered on. If None, the value is unchanged.

class Disk.VmdkCreateSpec(name=None, capacity=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Disk.VmdkCreateSpec class provides a specification for creating a new VMDK file to be used as a backing for a virtual disk. The virtual disk will be stored in the same directory as the virtual machine’s configuration file.

Tip

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

Parameters:

• name (str or None) – Base name of the VMDK file. The name should not include the ‘.vmdk’ file extension. If None, a name (derived from the name of the virtual machine) will be chosen by the server.
• capacity (long or None) – Capacity of the virtual disk backing in bytes. If None, defaults to a guest-specific capacity.

Disk.create(vm, spec)

Adds a virtual disk to the virtual machine. While adding the virtual disk, a new VMDK file may be created or an existing VMDK file may be used to back the virtual disk.

Parameters:

• vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
• spec (Disk.CreateSpec) – Specification for the new virtual disk.

Return type:

str

Returns:

Virtual disk identifier. The return value will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.

Raise :

com.vmware.vapi.std.errors_client.Error if system reported that the disk device was created but was unable to confirm the creation because the identifier of the new device could not be determined.

Raise :

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise :

com.vmware.vapi.std.errors_client.NotFound if the virtual machine is not found.

Raise :

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if the virtual machine is suspended or if the virtual machine is powered on and virtual disk type is IDE.

Raise :

com.vmware.vapi.std.errors_client.UnableToAllocateResource if the specified storage address is unavailable; for example, if the SCSI adapter requested does not exist.

Raise :

com.vmware.vapi.std.errors_client.ResourceInUse if the specified storage address is in use.

Raise :

com.vmware.vapi.std.errors_client.InvalidArgument if the specified storage address is out of bounds.

Raise :

com.vmware.vapi.std.errors_client.ResourceBusy if the virtual machine is busy performing another operation.

Raise :

com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed.

Raise :

com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.

Raise :

com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.

Raise :

com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

Raise :

com.vmware.vapi.std.errors_client.Unsupported if the guest operating system of the virtual machine is not supported and spec includes None attributes that default to guest-specific values.

Disk.delete(vm, disk)

Removes a virtual disk from the virtual machine. This method does not destroy the VMDK file that backs the virtual disk. It only detaches the VMDK file from the virtual machine. Once detached, the VMDK file will not be destroyed when the virtual machine to which it was associated is deleted.

Parameters:

• vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
• disk (str) – Virtual disk identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.

Raise :

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise :

com.vmware.vapi.std.errors_client.NotFound if the virtual machine or virtual disk is not found.

Raise :

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if the virtual machine is suspended or if the virtual machine is powered on and virtual disk type is IDE.

Raise :

com.vmware.vapi.std.errors_client.ResourceBusy if the virtual machine is busy performing another operation.

Raise :

com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed.

Raise :

com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.

Raise :

com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.

Raise :

com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

Disk.get(vm, disk)

Returns information about a virtual disk.

Parameters:

• vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
• disk (str) – Virtual disk identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.

Return type:

Disk.Info

Returns:

Information about the specified virtual disk.

Raise :

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise :

com.vmware.vapi.std.errors_client.NotFound if the virtual machine or virtual disk is not found.

Raise :

com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed.

Raise :

com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.

Raise :

com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.

Raise :

com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

Disk.list(vm)

Returns commonly used information about the virtual disks belonging to the virtual machine.

Parameters:vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine. Return type:list of Disk.Summary Returns:List of commonly used information about the virtual disks. Raise :com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request. Raise :com.vmware.vapi.std.errors_client.NotFound if the virtual machine is not found. Raise :com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed. Raise :com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request. Raise :com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated. Raise :com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

Disk.update(vm, disk, spec)

Updates the configuration of a virtual disk. An update method can be used to detach the existing VMDK file and attach another VMDK file to the virtual machine.

Parameters:

• vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
• disk (str) – Virtual disk identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.
• spec (Disk.UpdateSpec) – Specification for updating the virtual disk.

Raise :

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise :

com.vmware.vapi.std.errors_client.NotFound if the virtual machine or virtual disk is not found.

Raise :

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if one or more of the attributes specified in the spec parameter cannot be modified due to the current power state of the virtual machine or the connection state of the virtual disk.

Raise :

com.vmware.vapi.std.errors_client.ResourceBusy if the virtual machine is busy performing another operation.

Raise :

com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed.

Raise :

com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.

Raise :

com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.

Raise :

com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

class com.vmware.vcenter.vm.hardware_client.Ethernet(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

The Ethernet class provides methods for configuring the virtual Ethernet adapters of a virtual machine.

Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

class BackingInfo(type=None, network=None, network_name=None, host_device=None, distributed_switch_uuid=None, distributed_port=None, connection_cookie=None, opaque_network_type=None, opaque_network_id=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Ethernet.BackingInfo class contains information about the physical resource backing a virtual Ethernet adapter.

Tip

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

Parameters:

• type (Ethernet.BackingType) – Backing type for the virtual Ethernet adapter.
• network (str or None) – Identifier of the network backing the virtual Ethernet adapter. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: Network. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: Network. If None, the identifier of the network backing could not be determined.
• network_name (str) – Name of the standard portgroup backing the virtual Ethernet adapter. This attribute is optional and it is only relevant when the value of type is Ethernet.BackingType.STANDARD_PORTGROUP.
• host_device (str) – Name of the device backing the virtual Ethernet adapter. This attribute is optional and it is only relevant when the value of type is Ethernet.BackingType.HOST_DEVICE.
• distributed_switch_uuid (str) – UUID of the distributed virtual switch that backs the virtual Ethernet adapter. This attribute is optional and it is only relevant when the value of type is Ethernet.BackingType.DISTRIBUTED_PORTGROUP.
• distributed_port (str or None) – Key of the distributed virtual port that backs the virtual Ethernet adapter. This attribute will be None if the virtual Ethernet device is not bound to a distributed virtual port; this can happen if the virtual machine is powered off or the virtual Ethernet device is not connected.
• connection_cookie (long or None) – Server-generated cookie that identifies the connection to the port. This ookie may be used to verify that the virtual machine is the rightful owner of the port. This attribute will be None if the virtual Ethernet device is not bound to a distributed virtual port; this can happen if the virtual machine is powered off or the virtual Ethernet device is not connected.
• opaque_network_type (str) – Type of the opaque network that backs the virtual Ethernet adapter. This attribute is optional and it is only relevant when the value of type is Ethernet.BackingType.OPAQUE_NETWORK.
• opaque_network_id (str) – Identifier of the opaque network that backs the virtual Ethernet adapter. This attribute is optional and it is only relevant when the value of type is Ethernet.BackingType.OPAQUE_NETWORK.

class Ethernet.BackingSpec(type=None, network=None, distributed_port=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Ethernet.BackingSpec class provides a specification of the physical resource that backs a virtual Ethernet adapter.

Tip

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

Parameters:

• type (Ethernet.BackingType) – Backing type for the virtual Ethernet adapter.
• network (str) – Identifier of the network that backs the virtual Ethernet adapter. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: Network. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: Network. This attribute is optional and it is only relevant when the value of type is one of Ethernet.BackingType.STANDARD_PORTGROUP, Ethernet.BackingType.DISTRIBUTED_PORTGROUP, or Ethernet.BackingType.OPAQUE_NETWORK.
• distributed_port (str or None) – Key of the distributed virtual port that backs the virtual Ethernet adapter. Depending on the type of the Portgroup, the port may be specified using this field. If the portgroup type is early-binding (also known as static), a port is assigned when the Ethernet adapter is configured to use the port. The port may be either automatically or specifically assigned based on the value of this attribute. If the portgroup type is ephemeral, the port is created and assigned to a virtual machine when it is powered on and the Ethernet adapter is connected. This attribute cannot be specified as no free ports exist before use. May be used to specify a port when the network specified on the network attribute is a static or early binding distributed portgroup. If None, the port will be automatically assigned to the Ethernet adapter based on the policy embodied by the portgroup type.

class Ethernet.BackingType(string)

Bases: vmware.vapi.bindings.enum.Enum

The Ethernet.BackingType class defines the valid backing types for a virtual Ethernet adapter.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters:string (str) – String value for the BackingType instance.

DISTRIBUTED_PORTGROUP = BackingType(string=u'DISTRIBUTED_PORTGROUP')

Distributed virtual switch backing.

HOST_DEVICE = BackingType(string=u'HOST_DEVICE')

Legacy host device network backing. Imported VMs may have virtual Ethernet adapters with this type of backing, but this type of backing cannot be used to create or to update a virtual Ethernet adapter.

OPAQUE_NETWORK = BackingType(string=u'OPAQUE_NETWORK')

Opaque network backing.

STANDARD_PORTGROUP = BackingType(string=u'STANDARD_PORTGROUP')

vSphere standard portgroup network backing.

class Ethernet.CreateSpec(type=None, upt_compatibility_enabled=None, mac_type=None, mac_address=None, pci_slot_number=None, wake_on_lan_enabled=None, backing=None, start_connected=None, allow_guest_control=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Ethernet.CreateSpec class provides a specification for the configuration of a newly-created virtual Ethernet adapter.

Tip

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

Parameters:

• type (Ethernet.EmulationType or None) – Ethernet adapter emulation type. If None, defaults to a guest-specific type.
• upt_compatibility_enabled (bool or None) – Flag indicating whether Universal Pass-Through (UPT) compatibility is enabled on this virtual Ethernet adapter. If None, defaults to false.
• mac_type (Ethernet.MacAddressType or None) – MAC address type. If None, defaults to Ethernet.MacAddressType.GENERATED.
• mac_address (str) – MAC address. Workaround for PR1459647
• pci_slot_number (long or None) – Address of the virtual Ethernet adapter on the PCI bus. If the PCI address is invalid, the server will change when it the VM is started or as the device is hot added. If None, the server will choose an available address when the virtual machine is powered on.
• wake_on_lan_enabled (bool or None) – Flag indicating whether wake-on-LAN is enabled on this virtual Ethernet adapter. Defaults to false if None.
• backing (Ethernet.BackingSpec or None) – Physical resource backing for the virtual Ethernet adapter. If None, the system may try to find an appropriate backing. If one is not found, the request will fail.
• start_connected (bool or None) – Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on. Defaults to false if None.
• allow_guest_control (bool or None) – Flag indicating whether the guest can connect and disconnect the device. Defaults to false if None.

class Ethernet.EmulationType(string)

Bases: vmware.vapi.bindings.enum.Enum

The Ethernet.EmulationType class defines the valid emulation types for a virtual Ethernet adapter.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters:string (str) – String value for the EmulationType instance.

E1000 = EmulationType(string=u'E1000')

E1000 ethernet adapter.

E1000E = EmulationType(string=u'E1000E')

E1000e ethernet adapter.

PCNET32 = EmulationType(string=u'PCNET32')

AMD Lance PCNet32 Ethernet adapter.

VMXNET = EmulationType(string=u'VMXNET')

VMware Vmxnet virtual Ethernet adapter.

VMXNET2 = EmulationType(string=u'VMXNET2')

VMware Vmxnet2 virtual Ethernet adapter.

VMXNET3 = EmulationType(string=u'VMXNET3')

VMware Vmxnet3 virtual Ethernet adapter.

class Ethernet.Info(label=None, type=None, upt_compatibility_enabled=None, mac_type=None, mac_address=None, pci_slot_number=None, wake_on_lan_enabled=None, backing=None, state=None, start_connected=None, allow_guest_control=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Ethernet.Info class contains information about a virtual Ethernet adapter.

Tip

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

Parameters:

• label (str) – Device label.
• type (Ethernet.EmulationType) – Ethernet adapter emulation type.
• upt_compatibility_enabled (bool) – Flag indicating whether Universal Pass-Through (UPT) compatibility is enabled on this virtual Ethernet adapter. This attribute is optional and it is only relevant when the value of type is Ethernet.EmulationType.VMXNET3.
• mac_type (Ethernet.MacAddressType) – MAC address type.
• mac_address (str or None) – MAC address. May be None if Ethernet.Info.mac_type is Ethernet.MacAddressType.MANUAL and has not been specified, or if Ethernet.Info.mac_type is Ethernet.MacAddressType.GENERATED and the virtual machine has never been powered on since the Ethernet adapter was created.
• pci_slot_number (long or None) – Address of the virtual Ethernet adapter on the PCI bus. If the PCI address is invalid, the server will change it when the VM is started or as the device is hot added. May be None if the virtual machine has never been powered on since the adapter was created.
• wake_on_lan_enabled (bool) – Flag indicating whether wake-on-LAN is enabled on this virtual Ethernet adapter.
• backing (Ethernet.BackingInfo) – Physical resource backing for the virtual Ethernet adapter.
• state (ConnectionState) – Connection status of the virtual device.
• start_connected (bool) – Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.
• allow_guest_control (bool) – Flag indicating whether the guest can connect and disconnect the device.

class Ethernet.MacAddressType(string)

Bases: vmware.vapi.bindings.enum.Enum

The Ethernet.MacAddressType class defines the valid MAC address origins for a virtual Ethernet adapter.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters:string (str) – String value for the MacAddressType instance.

ASSIGNED = MacAddressType(string=u'ASSIGNED')

MAC address is assigned by vCenter Server.

GENERATED = MacAddressType(string=u'GENERATED')

MAC address is generated automatically.

MANUAL = MacAddressType(string=u'MANUAL')

MAC address is assigned statically.

Ethernet.RESOURCE_TYPE = 'com.vmware.vcenter.vm.hardware.Ethernet'

Resource type for the virtual Ethernet adapter.

class Ethernet.Summary(nic=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Ethernet.Summary class contains commonly used information about a virtual Ethernet adapter.

Tip

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

Parameters:nic (str) – Identifier of the virtual Ethernet adapter. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Ethernet. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Ethernet.

class Ethernet.UpdateSpec(upt_compatibility_enabled=None, mac_type=None, mac_address=None, wake_on_lan_enabled=None, backing=None, start_connected=None, allow_guest_control=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Ethernet.UpdateSpec class describes the updates to be made to the configuration of a virtual Ethernet adapter.

Tip

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

Parameters:

• upt_compatibility_enabled (bool or None) –

  Flag indicating whether Universal Pass-Through (UPT) compatibility should be enabled on this virtual Ethernet adapter.

  This attribute may be modified at any time, and changes will be applied the next time the virtual machine is powered on. If None, the value is unchanged. Must be None if the emulation type of the virtual Ethernet adapter is not Ethernet.EmulationType.VMXNET3.

• mac_type (Ethernet.MacAddressType or None) –

  MAC address type.

  This attribute may be modified at any time, and changes will be applied the next time the virtual machine is powered on. If None, the value is unchanged.

• mac_address (str or None) –

  MAC address.

  This attribute may be modified at any time, and changes will be applied the next time the virtual machine is powered on. If None, the value is unchanged. Must be specified if Ethernet.UpdateSpec.mac_type is Ethernet.MacAddressType.MANUAL. Must be None if the MAC address type is not Ethernet.MacAddressType.MANUAL.

• wake_on_lan_enabled (bool or None) –

  Flag indicating whether wake-on-LAN shoud be enabled on this virtual Ethernet adapter.

  This attribute may be modified at any time, and changes will be applied the next time the virtual machine is powered on. If None, the value is unchanged.

• backing (Ethernet.BackingSpec or None) –

  Physical resource backing for the virtual Ethernet adapter.

  This attribute may be modified at any time, and changes will be applied the next time the virtual machine is powered on. If None, the value is unchanged.

• start_connected (bool or None) – Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on. If None, the value is unchanged.
• allow_guest_control (bool or None) – Flag indicating whether the guest can connect and disconnect the device. If None, the value is unchanged.

Ethernet.connect(vm, nic)

Connects a virtual Ethernet adapter of a powered-on virtual machine to its backing. Connecting the virtual device makes the backing accessible from the perspective of the guest operating system.

For a powered-off virtual machine, the Ethernet.update() method may be used to configure the virtual Ethernet adapter to start in the connected state when the virtual machine is powered on.

Parameters:

• vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
• nic (str) – Virtual Ethernet adapter identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Ethernet.

Raise :

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise :

com.vmware.vapi.std.errors_client.NotFound if the virtual machine or virtual Ethernet adapter is not found.

Raise :

com.vmware.vapi.std.errors_client.AlreadyInDesiredState if the virtual Ethernet adapter is already connected.

Raise :

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if the virtual machine is not powered on.

Raise :

com.vmware.vapi.std.errors_client.ResourceBusy if the virtual machine is busy performing another operation.

Raise :

com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed.

Raise :

com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.

Raise :

com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.

Raise :

com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

Ethernet.create(vm, spec)

Adds a virtual Ethernet adapter to the virtual machine.

Parameters:

• vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
• spec (Ethernet.CreateSpec) – Specification for the new virtual Ethernet adapter.

Return type:

str

Returns:

Virtual Ethernet adapter identifier. The return value will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Ethernet.

Raise :

com.vmware.vapi.std.errors_client.Error if the system reported that the Ethernet adapter was created but was unable to confirm the creation because the identifier of the new adapter could not be determined.

Raise :

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise :

com.vmware.vapi.std.errors_client.NotFound if the virtual machine or network backing is not found.

Raise :

com.vmware.vapi.std.errors_client.UnableToAllocateResource if the virtual machine already has the maximum number of supported Ethernet adapters.

Raise :

com.vmware.vapi.std.errors_client.InvalidArgument if the specified PCI address is out of bounds, HOST_DEVICE is specified as the type, or a backing cannot be found in the case that backing is left None.

Raise :

com.vmware.vapi.std.errors_client.ResourceBusy if the virtual machine is busy performing another operation.

Raise :

com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed.

Raise :

com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.

Raise :

com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.

Raise :

com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

Raise :

com.vmware.vapi.std.errors_client.Unsupported if the guest operating system of the virtual machine is not supported and spec includes None attributes that default to guest-specific values.

Ethernet.delete(vm, nic)

Removes a virtual Ethernet adapter from the virtual machine.

Parameters:

• vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
• nic (str) – Virtual Ethernet adapter identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Ethernet.

Raise :

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise :

com.vmware.vapi.std.errors_client.NotFound if the virtual machine or virtual Ethernet adapter is not found.

Raise :

com.vmware.vapi.std.errors_client.ResourceBusy if the virtual machine is busy performing another operation.

Raise :

com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed.

Raise :

com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.

Raise :

com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.

Raise :

com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

Ethernet.disconnect(vm, nic)

Disconnects a virtual Ethernet adapter of a powered-on virtual machine from its backing. The virtual device is still present and its backing configuration is unchanged, but from the perspective of the guest operating system, the Ethernet adapter is not connected to its backing resource.

For a powered-off virtual machine, the Ethernet.update() method may be used to configure the virtual Ethernet adapter to start in the disconnected state when the virtual machine is powered on.

Parameters:

• vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
• nic (str) – Virtual Ethernet adapter identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Ethernet.

Raise :

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise :

com.vmware.vapi.std.errors_client.NotFound if the virtual machine or virtual Ethernet adapter is not found.

Raise :

com.vmware.vapi.std.errors_client.AlreadyInDesiredState if the virtual Ethernet adapter is already disconnected.

Raise :

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if the virtual machine is not powered on.

Raise :

com.vmware.vapi.std.errors_client.ResourceBusy if the virtual machine is busy performing another operation.

Raise :

com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed.

Raise :

com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.

Raise :

com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.

Raise :

com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

Ethernet.get(vm, nic)

Returns information about a virtual Ethernet adapter.

Parameters:

• vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
• nic (str) – Virtual Ethernet adapter identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Ethernet.

Return type:

Ethernet.Info

Returns:

Information about the specified virtual Ethernet adapter.

Raise :

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise :

com.vmware.vapi.std.errors_client.NotFound if the virtual machine or virtual Ethernet adapter is not found.

Raise :

com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed.

Raise :

com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.

Raise :

com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.

Raise :

com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

Ethernet.list(vm)

Returns commonly used information about the virtual Ethernet adapters belonging to the virtual machine.

Parameters:vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine. Return type:list of Ethernet.Summary Returns:List of commonly used information about virtual Ethernet adapters. Raise :com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request. Raise :com.vmware.vapi.std.errors_client.NotFound if the virtual machine is not found. Raise :com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed. Raise :com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request. Raise :com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated. Raise :com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

Ethernet.update(vm, nic, spec)

Updates the configuration of a virtual Ethernet adapter.

Parameters:

• vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
• nic (str) – Virtual Ethernet adapter identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Ethernet.
• spec (Ethernet.UpdateSpec) – Specification for updating the virtual Ethernet adapter.

Raise :

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise :

com.vmware.vapi.std.errors_client.InvalidArgument if HOST_DEVICE is specified as the type.

Raise :

com.vmware.vapi.std.errors_client.NotFound if the virtual machine, virtual Ethernet adapter, or backing network is not found.

Raise :

com.vmware.vapi.std.errors_client.ResourceBusy if the virtual machine is busy performing another operation.

Raise :

com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed.

Raise :

com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.

Raise :

com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.

Raise :

com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

class com.vmware.vcenter.vm.hardware_client.Floppy(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

The Floppy class provides methods for configuring the virtual floppy drives of a virtual machine.

Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

class BackingInfo(type=None, image_file=None, host_device=None, auto_detect=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Floppy.BackingInfo class contains information about the physical resource backing a virtual floppy drive.

Tip

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

Parameters:

• type (Floppy.BackingType) – Backing type for the virtual floppy drive.
• image_file (str) – Path of the image file backing the virtual floppy drive. This attribute is optional and it is only relevant when the value of type is Floppy.BackingType.IMAGE_FILE.
• host_device (str or None) – Name of the host device backing the virtual floppy drive. This attribute will be None if autoDetect is true and the virtual floppy drive is not connected or no suitable device is available on the host.
• auto_detect (bool) – Flag indicating whether the virtual floppy drive is configured to automatically detect a suitable host device. This attribute is optional and it is only relevant when the value of type is Floppy.BackingType.HOST_DEVICE.

class Floppy.BackingSpec(type=None, image_file=None, host_device=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Floppy.BackingSpec class provides a specification of the physical resource backing a virtual floppy drive.

Tip

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

Parameters:

• type (Floppy.BackingType) – Backing type for the virtual floppy drive.
• image_file (str) – Path of the image file that should be used as the virtual floppy drive backing. This attribute is optional and it is only relevant when the value of type is Floppy.BackingType.IMAGE_FILE.
• host_device (str or None) – Name of the device that should be used as the virtual floppy drive backing. If None, the virtual floppy drive will be configured to automatically detect a suitable host device.

class Floppy.BackingType(string)

Bases: vmware.vapi.bindings.enum.Enum

The Floppy.BackingType class defines the valid backing types for a virtual floppy drive.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters:string (str) – String value for the BackingType instance.

CLIENT_DEVICE = BackingType(string=u'CLIENT_DEVICE')

Virtual floppy drive is backed by a device on the client that is connected to the virtual machine console.

HOST_DEVICE = BackingType(string=u'HOST_DEVICE')

Virtual floppy drive is backed by a device on the host where the virtual machine is running.

IMAGE_FILE = BackingType(string=u'IMAGE_FILE')

Virtual floppy drive is backed by an image file.

class Floppy.CreateSpec(backing=None, start_connected=None, allow_guest_control=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Floppy.CreateSpec class provides a specification for the configuration of a newly-created virtual floppy drive.

Tip

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

Parameters:

• backing (Floppy.BackingSpec or None) – Physical resource backing for the virtual floppy drive. If None, defaults to automatic detection of a suitable host device.
• start_connected (bool or None) – Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on. Defaults to false if None.
• allow_guest_control (bool or None) – Flag indicating whether the guest can connect and disconnect the device. Defaults to false if None.

class Floppy.Info(label=None, backing=None, state=None, start_connected=None, allow_guest_control=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Floppy.Info class contains information about a virtual floppy drive.

Tip

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

Parameters:

• label (str) – Device label.
• backing (Floppy.BackingInfo) – Physical resource backing for the virtual floppy drive.
• state (ConnectionState) – Connection status of the virtual device.
• start_connected (bool) – Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.
• allow_guest_control (bool) – Flag indicating whether the guest can connect and disconnect the device.

Floppy.RESOURCE_TYPE = 'com.vmware.vcenter.vm.hardware.Floppy'

Resource type for the virtual floppy drive device.

class Floppy.Summary(floppy=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Floppy.Summary class contains commonly used information about a virtual floppy drive.

Tip

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

Parameters:floppy (str) – Identifier of the virtual floppy drive. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Floppy. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Floppy.

class Floppy.UpdateSpec(backing=None, start_connected=None, allow_guest_control=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Floppy.UpdateSpec class describes the updates to be made to the configuration of a virtual floppy drive.

Tip

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

Parameters:

• backing (Floppy.BackingSpec or None) –

  Physical resource backing for the virtual floppy drive.

  This attribute may only be modified if the virtual machine is not powered on or the virtual floppy drive is not connected. If None, the value is unchanged.

• start_connected (bool or None) – Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on. If None, the value is unchanged.
• allow_guest_control (bool or None) – Flag indicating whether the guest can connect and disconnect the device. If None, the value is unchanged.

Floppy.connect(vm, floppy)

Connects a virtual floppy drive of a powered-on virtual machine to its backing. Connecting the virtual device makes the backing accessible from the perspective of the guest operating system.

For a powered-off virtual machine, the Floppy.update() method may be used to configure the virtual floppy drive to start in the connected state when the virtual machine is powered on.

Parameters:

• vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
• floppy (str) – Virtual floppy drive identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Floppy.

Raise :

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise :

com.vmware.vapi.std.errors_client.NotFound if the virtual machine or virtual floppy drive is not found.

Raise :

com.vmware.vapi.std.errors_client.AlreadyInDesiredState if the virtual floppy drive is already connected.

Raise :

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if the virtual machine is not powered on.

Raise :

com.vmware.vapi.std.errors_client.ResourceBusy if the virtual machine is busy performing another operation.

Raise :

com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed.

Raise :

com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.

Raise :

com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.

Raise :

com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

Floppy.create(vm, spec)

Adds a virtual floppy drive to the virtual machine.

Parameters:

• vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
• spec (Floppy.CreateSpec) – Specification for the new virtual floppy drive.

Return type:

str

Returns:

Virtual floppy drive identifier. The return value will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Floppy.

Raise :

com.vmware.vapi.std.errors_client.Error if the system reported that the floppy device was created but was unable to confirm the creation because the identifier of the new device could not be determined.

Raise :

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise :

com.vmware.vapi.std.errors_client.NotFound if the virtual machine is not found.

Raise :

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if the virtual machine is not powered off.

Raise :

com.vmware.vapi.std.errors_client.UnableToAllocateResource if the virtual machine already has the maximum number of supported floppy drives.

Raise :

com.vmware.vapi.std.errors_client.ResourceBusy if the virtual machine is busy performing another operation.

Raise :

com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed.

Raise :

com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.

Raise :

com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.

Raise :

com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

Floppy.delete(vm, floppy)

Removes a virtual floppy drive from the virtual machine.

Parameters:

• vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
• floppy (str) – Virtual floppy drive identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Floppy.

Raise :

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise :

com.vmware.vapi.std.errors_client.NotFound if the virtual machine or virtual floppy drive is not found.

Raise :

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if the virtual machine is not powered off.

Raise :

com.vmware.vapi.std.errors_client.ResourceBusy if the virtual machine is busy performing another operation.

Raise :

com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed.

Raise :

com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.

Raise :

com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.

Raise :

com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

Floppy.disconnect(vm, floppy)

Disconnects a virtual floppy drive of a powered-on virtual machine from its backing. The virtual device is still present and its backing configuration is unchanged, but from the perspective of the guest operating system, the floppy drive is not connected to its backing resource.

For a powered-off virtual machine, the Floppy.update() method may be used to configure the virtual floppy floppy to start in the disconnected state when the virtual machine is powered on.

Parameters:

• vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
• floppy (str) – Virtual floppy drive identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Floppy.

Raise :

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise :

com.vmware.vapi.std.errors_client.NotFound if the virtual machine or virtual floppy drive is not found.

Raise :

com.vmware.vapi.std.errors_client.AlreadyInDesiredState if the virtual floppy drive is already disconnected.

Raise :

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if the virtual machine is not powered on.

Raise :

com.vmware.vapi.std.errors_client.ResourceBusy if the virtual machine is busy performing another operation.

Raise :

com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed.

Raise :

com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.

Raise :

com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.

Raise :

com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

Floppy.get(vm, floppy)

Returns information about a virtual floppy drive.

Parameters:

• vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
• floppy (str) – Virtual floppy drive identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Floppy.

Return type:

Floppy.Info

Returns:

Information about the specified virtual floppy drive.

Raise :

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise :

com.vmware.vapi.std.errors_client.NotFound if the virtual machine or virtual floppy drive is not found.

Raise :

com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed.

Raise :

com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.

Raise :

com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.

Raise :

com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

Floppy.list(vm)

Returns commonly used information about the virtual floppy drives belonging to the virtual machine.

Parameters:vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine. Return type:list of Floppy.Summary Returns:List of commonly used information about virtual floppy drives. Raise :com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request. Raise :com.vmware.vapi.std.errors_client.NotFound if the virtual machine is not found. Raise :com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed. Raise :com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request. Raise :com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated. Raise :com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

Floppy.update(vm, floppy, spec)

Updates the configuration of a virtual floppy drive.

Parameters:

• vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
• floppy (str) – Virtual floppy drive identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Floppy.
• spec (Floppy.UpdateSpec) – Specification for updating the virtual floppy drive.

Raise :

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise :

com.vmware.vapi.std.errors_client.NotFound if the virtual machine or virtual floppy drive is not found.

Raise :

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if one or more of the attributes specified in the spec parameter cannot be modified due to the current power state of the virtual machine or the connection state of the virtual floppy drive.

Raise :

com.vmware.vapi.std.errors_client.ResourceBusy if the virtual machine is busy performing another operation.

Raise :

com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed.

Raise :

com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.

Raise :

com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.

Raise :

com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

class com.vmware.vcenter.vm.hardware_client.IdeAddressInfo(primary=None, master=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The IdeAddressInfo class contains information about the address of a virtual device that is attached to a virtual IDE adapter of a virtual machine.

Tip

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

Parameters:

• primary (bool) – Flag specifying whether the device is attached to the primary or secondary IDE adapter of the virtual machine.
• master (bool) – Flag specifying whether the device is the master or slave device on the IDE adapter.

class com.vmware.vcenter.vm.hardware_client.IdeAddressSpec(primary=None, master=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The IdeAddressSpec class contains information for specifying the address of a virtual device that is attached to a virtual IDE adapter of a virtual machine.

Tip

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

Parameters:

• primary (bool or None) – Flag specifying whether the device should be attached to the primary or secondary IDE adapter of the virtual machine. If None, the server will choose a adapter with an available connection. If no IDE connections are available, the request will be rejected.
• master (bool or None) – Flag specifying whether the device should be the master or slave device on the IDE adapter. If None, the server will choose an available connection type. If no IDE connections are available, the request will be rejected.

class com.vmware.vcenter.vm.hardware_client.Memory(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

The Memory class provides methods for configuring the memory settings of a virtual machine.

Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

class Info(size_mib=None, hot_add_enabled=None, hot_add_increment_size_mib=None, hot_add_limit_mib=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Memory.Info class contains memory-related information about a virtual machine.

Tip

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

Parameters:

• size_mib (long) – Memory size in mebibytes.
• hot_add_enabled (bool) –

  Flag indicating whether adding memory while the virtual machine is running is enabled.

  Some guest operating systems may consume more resources or perform less efficiently when they run on hardware that supports adding memory while the machine is running.

• hot_add_increment_size_mib (long or None) –

  The granularity, in mebibytes, at which memory can be added to a running virtual machine.

  When adding memory to a running virtual machine, the amount of memory added must be at least Memory.Info.hot_add_increment_size_mib and the total memory size of the virtual machine must be a multiple of {\@link>hotAddIncrementSize}. Only set when Memory.Info.hot_add_enabled is true and the virtual machine is running.

• hot_add_limit_mib (long or None) – The maximum amount of memory, in mebibytes, that can be added to a running virtual machine. Only set when Memory.Info.hot_add_enabled is true and the virtual machine is running.

class Memory.UpdateSpec(size_mib=None, hot_add_enabled=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Memory.UpdateSpec class describes the updates to be made to the memory-related settings of a virtual machine.

Tip

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

Parameters:

• size_mib (long or None) –

  New memory size in mebibytes.

  The supported range of memory sizes is constrained by the configured guest operating system and virtual hardware version of the virtual machine.

  If the virtual machine is running, this value may only be changed if Memory.Info.hot_add_enabled is true, and the new memory size must satisfy the constraints specified by Memory.Info.hot_add_increment_size_mib and Memory.Info.hot_add_limit_mib. If None, the value is unchanged.

• hot_add_enabled (bool or None) –

  Flag indicating whether adding memory while the virtual machine is running should be enabled.

  Some guest operating systems may consume more resources or perform less efficiently when they run on hardware that supports adding memory while the machine is running.

  This attribute may only be modified if the virtual machine is not powered on. If None, the value is unchanged.

Memory.get(vm)

Returns the memory-related settings of a virtual machine.

Parameters:vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine. Return type:Memory.Info Returns:Memory-related settings of the virtual machine. Raise :com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request. Raise :com.vmware.vapi.std.errors_client.NotFound if the virtual machine is not found. Raise :com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed. Raise :com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request. Raise :com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated. Raise :com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

Memory.update(vm, spec)

Updates the memory-related settings of a virtual machine.

Parameters:

• vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
• spec (Memory.UpdateSpec) – Specification for updating the memory-related settings of the virtual machine.

Raise :

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise :

com.vmware.vapi.std.errors_client.NotFound if the virtual machine is not found.

Raise :

com.vmware.vapi.std.errors_client.InvalidArgument if one of the provided settings is not permitted; for example, specifying a negative value for sizeMiB.

Raise :

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if hotAddEnabled is specified and the virtual machine is not powered off.

Raise :

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if sizeMiB is specified, hotAddEnabled is false, and the virtual machine is not powered off.

Raise :

com.vmware.vapi.std.errors_client.ResourceBusy if the virtual machine is busy performing another operation.

Raise :

com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed.

Raise :

com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.

Raise :

com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.

Raise :

com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

class com.vmware.vcenter.vm.hardware_client.Parallel(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

The Parallel class provides methods for configuring the virtual parallel ports of a virtual machine.

Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

class BackingInfo(type=None, file=None, host_device=None, auto_detect=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Parallel.BackingInfo class contains information about the physical resource backing a virtual parallel port.

Tip

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

Parameters:

• type (Parallel.BackingType) – Backing type for the virtual parallel port.
• file (str) – Path of the file backing the virtual parallel port. This attribute is optional and it is only relevant when the value of type is Parallel.BackingType.FILE.
• host_device (str or None) – Name of the device backing the virtual parallel port. This attribute will be None if autoDetect is true and the virtual parallel port is not connected or no suitable device is available on the host.
• auto_detect (bool) – Flag indicating whether the virtual parallel port is configured to automatically detect a suitable host device. This attribute is optional and it is only relevant when the value of type is Parallel.BackingType.HOST_DEVICE.

class Parallel.BackingSpec(type=None, file=None, host_device=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Parallel.BackingSpec class provides a specification of the physical resource backing a virtual parallel port.

Tip

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

Parameters:

• type (Parallel.BackingType) – Backing type for the virtual parallel port.
• file (str) – Path of the file that should be used as the virtual parallel port backing. This attribute is optional and it is only relevant when the value of type is Parallel.BackingType.FILE.
• host_device (str or None) – Name of the device that should be used as the virtual parallel port backing. If None, the virtual parallel port will be configured to automatically detect a suitable host device.

class Parallel.BackingType(string)

Bases: vmware.vapi.bindings.enum.Enum

The Parallel.BackingType class defines the valid backing types for a virtual parallel port.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters:string (str) – String value for the BackingType instance.

FILE = BackingType(string=u'FILE')

Virtual parallel port is backed by a file.

HOST_DEVICE = BackingType(string=u'HOST_DEVICE')

Virtual parallel port is backed by a device on the host where the virtual machine is running.

class Parallel.CreateSpec(backing=None, start_connected=None, allow_guest_control=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Parallel.CreateSpec class provides a specification for the configuration of a newly-created virtual parallel port.

Tip

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

Parameters:

• backing (Parallel.BackingSpec or None) – Physical resource backing for the virtual parallel port. If None, defaults to automatic detection of a suitable host device.
• start_connected (bool or None) – Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on. Defaults to false if None.
• allow_guest_control (bool or None) – Flag indicating whether the guest can connect and disconnect the device. Defaults to false if None.

class Parallel.Info(label=None, backing=None, state=None, start_connected=None, allow_guest_control=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Parallel.Info class contains information about a virtual parallel port.

Tip

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

Parameters:

• label (str) – Device label.
• backing (Parallel.BackingInfo) – Physical resource backing for the virtual parallel port.
• state (ConnectionState) – Connection status of the virtual device.
• start_connected (bool) – Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.
• allow_guest_control (bool) – Flag indicating whether the guest can connect and disconnect the device.

Parallel.RESOURCE_TYPE = 'com.vmware.vcenter.vm.hardware.ParallelPort'

Resource type for the virtual parallel port.

class Parallel.Summary(port=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Parallel.Summary class contains commonly used information about a virtual parallel port.

Tip

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

Parameters:port (str) – Identifier of the virtual parallel port. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.ParallelPort. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.ParallelPort.

class Parallel.UpdateSpec(backing=None, start_connected=None, allow_guest_control=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Parallel.UpdateSpec class describes the updates to be made to the configuration of a virtual parallel port.

Tip

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

Parameters:

• backing (Parallel.BackingSpec or None) –

  Physical resource backing for the virtual parallel port.

  This attribute may only be modified if the virtual machine is not powered on or the virtual parallel port is not connected. If None, the value is unchanged.

• start_connected (bool or None) – Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on. If None, the value is unchanged.
• allow_guest_control (bool or None) – Flag indicating whether the guest can connect and disconnect the device. If None, the value is unchanged.

Parallel.connect(vm, port)

Connects a virtual parallel port of a powered-on virtual machine to its backing. Connecting the virtual device makes the backing accessible from the perspective of the guest operating system.

For a powered-off virtual machine, the Parallel.update() method may be used to configure the virtual parallel port to start in the connected state when the virtual machine is powered on.

Parameters:

• vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
• port (str) – Virtual parallel port identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.ParallelPort.

Raise :

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise :

com.vmware.vapi.std.errors_client.NotFound if the virtual machine or virtual parallel port is not found.

Raise :

com.vmware.vapi.std.errors_client.AlreadyInDesiredState if the virtual parallel port is already connected.

Raise :

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if the virtual machine is not powered on.

Raise :

com.vmware.vapi.std.errors_client.ResourceBusy if the virtual machine is busy performing another operation.

Raise :

com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed.

Raise :

com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.

Raise :

com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.

Raise :

com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

Parallel.create(vm, spec)

Adds a virtual parallel port to the virtual machine.

Parameters:

• vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
• spec (Parallel.CreateSpec) – Specification for the new virtual parallel port.

Return type:

str

Returns:

Virtual parallel port identifier. The return value will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.ParallelPort.

Raise :

com.vmware.vapi.std.errors_client.Error if the system reported that the parallel port device was created but was unable to confirm the creation because the identifier of the new device could not be determined.

Raise :

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise :

com.vmware.vapi.std.errors_client.NotFound if the virtual machine is not found.

Raise :

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if the virtual machine is not powered off.

Raise :

com.vmware.vapi.std.errors_client.UnableToAllocateResource if the virtual machine already has the maximum number of supported parallel ports.

Raise :

com.vmware.vapi.std.errors_client.ResourceBusy if the virtual machine is busy performing another operation.

Raise :

com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed.

Raise :

com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.

Raise :

com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.

Raise :

com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

Parallel.delete(vm, port)

Removes a virtual parallel port from the virtual machine.

Parameters:

• vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
• port (str) – Virtual parallel port identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.ParallelPort.

Raise :

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise :

com.vmware.vapi.std.errors_client.NotFound if the virtual machine or virtual parallel port is not found.

Raise :

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if the virtual machine is not powered off.

Raise :

com.vmware.vapi.std.errors_client.ResourceBusy if the virtual machine is busy performing another operation.

Raise :

com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed.

Raise :

com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.

Raise :

com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.

Raise :

com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

Parallel.disconnect(vm, port)

Disconnects a virtual parallel port of a powered-on virtual machine from its backing. The virtual device is still present and its backing configuration is unchanged, but from the perspective of the guest operating system, the parallel port is not connected to its backing.

For a powered-off virtual machine, the Parallel.update() method may be used to configure the virtual parallel port to start in the disconnected state when the virtual machine is powered on.

Parameters:

• vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
• port (str) – Virtual parallel port identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.ParallelPort.

Raise :

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise :

com.vmware.vapi.std.errors_client.NotFound if the virtual machine or virtual parallel port is not found.

Raise :

com.vmware.vapi.std.errors_client.AlreadyInDesiredState if the virtual parallel port is already disconnected.

Raise :

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if the virtual machine is not powered on.

Raise :

com.vmware.vapi.std.errors_client.ResourceBusy if the virtual machine is busy performing another operation.

Raise :

com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed.

Raise :

com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.

Raise :

com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.

Raise :

com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

Parallel.get(vm, port)

Returns information about a virtual parallel port.

Parameters:

• vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
• port (str) – Virtual parallel port identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.ParallelPort.

Return type:

Parallel.Info

Returns:

Information about the specified virtual parallel port.

Raise :

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise :

com.vmware.vapi.std.errors_client.NotFound if the virtual machine or virtual parallel port is not found.

Raise :

com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed.

Raise :

com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.

Raise :

com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.

Raise :

com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

Parallel.list(vm)

Returns commonly used information about the virtual parallel ports belonging to the virtual machine.

Parameters:vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine. Return type:list of Parallel.Summary Returns:List of commonly used information about virtual parallel ports. Raise :com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request. Raise :com.vmware.vapi.std.errors_client.NotFound if the virtual machine is not found. Raise :com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed. Raise :com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request. Raise :com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated. Raise :com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

Parallel.update(vm, port, spec)

Updates the configuration of a virtual parallel port.

Parameters:

• vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
• port (str) – Virtual parallel port identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.ParallelPort.
• spec (Parallel.UpdateSpec) – Specification for updating the virtual parallel port.

Raise :

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise :

com.vmware.vapi.std.errors_client.NotFound if the virtual machine or virtual parallel port is not found.

Raise :

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if one or more of the attributes specified in the spec parameter cannot be modified due to the current power state of the virtual machine or the connection state of the virtual parallel port.

Raise :

com.vmware.vapi.std.errors_client.ResourceBusy if the virtual machine is busy performing another operation.

Raise :

com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed.

Raise :

com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.

Raise :

com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.

Raise :

com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

class com.vmware.vcenter.vm.hardware_client.SataAddressInfo(bus=None, unit=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The SataAddressInfo class contains information about the address of a virtual device that is attached to a virtual SATA adapter of a virtual machine.

Tip

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

Parameters:

• bus (long) – Bus number of the adapter to which the device is attached.
• unit (long) – Unit number of the device.

class com.vmware.vcenter.vm.hardware_client.SataAddressSpec(bus=None, unit=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The SataAddressSpec class contains information for specifying the address of a virtual device that is attached to a virtual SATA adapter of a virtual machine.

Tip

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

Parameters:

• bus (long) – Bus number of the adapter to which the device should be attached.
• unit (long or None) – Unit number of the device. If None, the server will choose an available unit number on the specified adapter. If there are no available connections on the adapter, the request will be rejected.

class com.vmware.vcenter.vm.hardware_client.ScsiAddressInfo(bus=None, unit=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The ScsiAddressInfo class contains information about the address of a virtual device that is attached to a virtual SCSI adapter of a virtual machine.

Tip

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

Parameters:

• bus (long) – Bus number of the adapter to which the device is attached.
• unit (long) – Unit number of the device.

class com.vmware.vcenter.vm.hardware_client.ScsiAddressSpec(bus=None, unit=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The ScsiAddressSpec class contains information for specifying the address of a virtual device that is attached to a virtual SCSI adapter of a virtual machine.

Tip

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

Parameters:

• bus (long) – Bus number of the adapter to which the device should be attached.
• unit (long or None) – Unit number of the device. If None, the server will choose an available unit number on the specified adapter. If there are no available connections on the adapter, the request will be rejected.

class com.vmware.vcenter.vm.hardware_client.Serial(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

The Serial class provides methods for configuring the virtual serial ports of a virtual machine.

Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

class BackingInfo(type=None, file=None, host_device=None, auto_detect=None, pipe=None, no_rx_loss=None, network_location=None, proxy=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Serial.BackingInfo class contains information about the physical resource backing a virtual serial port.

Tip

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

Parameters:

• type (Serial.BackingType) – Backing type for the virtual serial port.
• file (str) – Path of the file backing the virtual serial port. This attribute is optional and it is only relevant when the value of type is Serial.BackingType.FILE.
• host_device (str or None) – Name of the device backing the virtual serial port. This attribute will be None if autoDetect is true and the virtual serial port is not connected or no suitable device is available on the host.
• auto_detect (bool) – Flag indicating whether the virtual serial port is configured to automatically detect a suitable host device. This attribute is optional and it is only relevant when the value of type is Serial.BackingType.HOST_DEVICE.
• pipe (str) – Name of the pipe backing the virtual serial port. This attribute is optional and it is only relevant when the value of type is one of Serial.BackingType.PIPE_SERVER or Serial.BackingType.PIPE_CLIENT.
• no_rx_loss (bool) – Flag that enables optimized data transfer over the pipe. When the value is true, the host buffers data to prevent data overrun. This allows the virtual machine to read all of the data transferred over the pipe with no data loss. This attribute is optional and it is only relevant when the value of type is one of Serial.BackingType.PIPE_SERVER or Serial.BackingType.PIPE_CLIENT.
• network_location (str) –

  URI specifying the location of the network service backing the virtual serial port.

  • If Serial.BackingInfo.type is Serial.BackingType.NETWORK_SERVER, this attribute is the location used by clients to connect to this server. The hostname part of the URI should either be empty or should specify the address of the host on which the virtual machine is running.
  • If Serial.BackingInfo.type is Serial.BackingType.NETWORK_CLIENT, this attribute is the location used by the virtual machine to connect to the remote server.

  This attribute is optional and it is only relevant when the value of type is one of Serial.BackingType.NETWORK_SERVER or Serial.BackingType.NETWORK_CLIENT.

• proxy (str or None) – Proxy service that provides network access to the network backing. If set, the virtual machine initiates a connection with the proxy service and forwards the traffic to the proxy. If None, no proxy service is configured.

class Serial.BackingSpec(type=None, file=None, host_device=None, pipe=None, no_rx_loss=None, network_location=None, proxy=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Serial.BackingSpec class provides a specification of the physical resource backing a virtual serial port.

Tip

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

Parameters:

• type (Serial.BackingType) – Backing type for the virtual serial port.
• file (str) – Path of the file backing the virtual serial port. This attribute is optional and it is only relevant when the value of type is Serial.BackingType.FILE.
• host_device (str or None) – Name of the device backing the virtual serial port. If None, the virtual serial port will be configured to automatically detect a suitable host device.
• pipe (str) – Name of the pipe backing the virtual serial port. This attribute is optional and it is only relevant when the value of type is one of Serial.BackingType.PIPE_SERVER or Serial.BackingType.PIPE_CLIENT.
• no_rx_loss (bool or None) – Flag that enables optimized data transfer over the pipe. When the value is true, the host buffers data to prevent data overrun. This allows the virtual machine to read all of the data transferred over the pipe with no data loss. If None, defaults to false.
• network_location (str) –

  URI specifying the location of the network service backing the virtual serial port.

  • If Serial.BackingSpec.type is Serial.BackingType.NETWORK_SERVER, this attribute is the location used by clients to connect to this server. The hostname part of the URI should either be empty or should specify the address of the host on which the virtual machine is running.
  • If Serial.BackingSpec.type is Serial.BackingType.NETWORK_CLIENT, this attribute is the location used by the virtual machine to connect to the remote server.

  This attribute is optional and it is only relevant when the value of type is one of Serial.BackingType.NETWORK_SERVER or Serial.BackingType.NETWORK_CLIENT.

• proxy (str or None) – Proxy service that provides network access to the network backing. If set, the virtual machine initiates a connection with the proxy service and forwards the traffic to the proxy. If None, no proxy service should be used.

class Serial.BackingType(string)

Bases: vmware.vapi.bindings.enum.Enum

The Serial.BackingType class defines the valid backing types for a virtual serial port.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters:string (str) – String value for the BackingType instance.

FILE = BackingType(string=u'FILE')

Virtual serial port is backed by a file.

HOST_DEVICE = BackingType(string=u'HOST_DEVICE')

Virtual serial port is backed by a device on the host where the virtual machine is running.

NETWORK_CLIENT = BackingType(string=u'NETWORK_CLIENT')

Virtual serial port is backed by a network client. This backing may be used to create a network-accessible serial port on the virtual machine, initiating a connection to a remote system.

NETWORK_SERVER = BackingType(string=u'NETWORK_SERVER')

Virtual serial port is backed by a network server. This backing may be used to create a network-accessible serial port on the virtual machine, accepting a connection from a remote system.

PIPE_CLIENT = BackingType(string=u'PIPE_CLIENT')

Virtual serial port is backed by a named pipe client. The virtual machine will connect to the named pipe provided by a host application or another virtual machine on the same host. This is useful for capturing debugging information sent through the virtual serial port.

PIPE_SERVER = BackingType(string=u'PIPE_SERVER')

Virtual serial port is backed by a named pipe server. The virtual machine will accept a connection from a host application or another virtual machine on the same host. This is useful for capturing debugging information sent through the virtual serial port.

class Serial.CreateSpec(yield_on_poll=None, backing=None, start_connected=None, allow_guest_control=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Serial.CreateSpec class provides a specification for the configuration of a newly-created virtual serial port.

Tip

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

Parameters:

• yield_on_poll (bool or None) – CPU yield behavior. If set to true, the virtual machine will periodically relinquish the processor if its sole task is polling the virtual serial port. The amount of time it takes to regain the processor will depend on the degree of other virtual machine activity on the host. If None, defaults to false.
• backing (Serial.BackingSpec or None) – Physical resource backing for the virtual serial port. If None, defaults to automatic detection of a suitable host device.
• start_connected (bool or None) – Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on. Defaults to false if None.
• allow_guest_control (bool or None) – Flag indicating whether the guest can connect and disconnect the device. Defaults to false if None.

class Serial.Info(label=None, yield_on_poll=None, backing=None, state=None, start_connected=None, allow_guest_control=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Serial.Info class contains information about a virtual serial port.

Tip

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

Parameters:

• label (str) – Device label.
• yield_on_poll (bool) – CPU yield behavior. If set to true, the virtual machine will periodically relinquish the processor if its sole task is polling the virtual serial port. The amount of time it takes to regain the processor will depend on the degree of other virtual machine activity on the host.
• backing (Serial.BackingInfo) – Physical resource backing for the virtual serial port.
• state (ConnectionState) – Connection status of the virtual device.
• start_connected (bool) – Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.
• allow_guest_control (bool) – Flag indicating whether the guest can connect and disconnect the device.

Serial.RESOURCE_TYPE = 'com.vmware.vcenter.vm.hardware.SerialPort'

Resource type for the virtual serial port device.

class Serial.Summary(port=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Serial.Summary class contains commonly used information about a virtual serial port.

Tip

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

Parameters:port (str) – Identifier of the virtual serial port. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort.

class Serial.UpdateSpec(yield_on_poll=None, backing=None, start_connected=None, allow_guest_control=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Serial.UpdateSpec class describes the updates to be made to the configuration of a virtual serial port.

Tip

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

Parameters:

• yield_on_poll (bool or None) –

  CPU yield behavior. If set to true, the virtual machine will periodically relinquish the processor if its sole task is polling the virtual serial port. The amount of time it takes to regain the processor will depend on the degree of other virtual machine activity on the host.

  This attribute may be modified at any time, and changes applied to a connected virtual serial port take effect immediately. If None, the value is unchanged.

• backing (Serial.BackingSpec or None) –

  Physical resource backing for the virtual serial port.

  This attribute may only be modified if the virtual machine is not powered on or the virtual serial port is not connected. If None, the value is unchanged.

• start_connected (bool or None) – Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on. If None, the value is unchanged.
• allow_guest_control (bool or None) – Flag indicating whether the guest can connect and disconnect the device. If None, the value is unchanged.

Serial.connect(vm, port)

Connects a virtual serial port of a powered-on virtual machine to its backing. Connecting the virtual device makes the backing accessible from the perspective of the guest operating system.

For a powered-off virtual machine, the Serial.update() method may be used to configure the virtual serial port to start in the connected state when the virtual machine is powered on.

Parameters:

• vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
• port (str) – Virtual serial port identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort.

Raise :

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise :

com.vmware.vapi.std.errors_client.NotFound if the virtual machine or virtual serial port is not found.

Raise :

com.vmware.vapi.std.errors_client.AlreadyInDesiredState if the virtual serial port is already connected.

Raise :

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if the virtual machine is not powered on.

Raise :

com.vmware.vapi.std.errors_client.ResourceBusy if the virtual machine is busy performing another operation.

Raise :

com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed.

Raise :

com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.

Raise :

com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.

Raise :

com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

Serial.create(vm, spec)

Adds a virtual serial port to the virtual machine.

Parameters:

• vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
• spec (Serial.CreateSpec) – Specification for the new virtual serial port.

Return type:

str

Returns:

Virtual serial port identifier. The return value will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort.

Raise :

com.vmware.vapi.std.errors_client.Error if the system reported that the serial port device was created but was unable to confirm the creation because the identifier of the new device could not be determined.

Raise :

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise :

com.vmware.vapi.std.errors_client.NotFound if the virtual machine is not found.

Raise :

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if the virtual machine is not powered off.

Raise :

com.vmware.vapi.std.errors_client.UnableToAllocateResource if the virtual machine already has the maximum number of supported serial ports.

Raise :

com.vmware.vapi.std.errors_client.ResourceBusy if the virtual machine is busy performing another operation.

Raise :

com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed.

Raise :

com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.

Raise :

com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.

Raise :

com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

Serial.delete(vm, port)

Removes a virtual serial port from the virtual machine.

Parameters:

• vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
• port (str) – Virtual serial port identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort.

Raise :

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise :

com.vmware.vapi.std.errors_client.NotFound if the virtual machine or virtual serial port is not found.

Raise :

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if the virtual machine is not powered off.

Raise :

com.vmware.vapi.std.errors_client.ResourceBusy if the virtual machine is busy performing another operation.

Raise :

com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed.

Raise :

com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.

Raise :

com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.

Raise :

com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

Serial.disconnect(vm, port)

Disconnects a virtual serial port of a powered-on virtual machine from its backing. The virtual device is still present and its backing configuration is unchanged, but from the perspective of the guest operating system, the serial port is not connected to its backing.

For a powered-off virtual machine, the Serial.update() method may be used to configure the virtual serial port to start in the disconnected state when the virtual machine is powered on.

Parameters:

• vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
• port (str) – Virtual serial port identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort.

Raise :

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise :

com.vmware.vapi.std.errors_client.NotFound if the virtual machine or virtual serial port is not found.

Raise :

com.vmware.vapi.std.errors_client.AlreadyInDesiredState if the virtual serial port is already disconnected.

Raise :

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if the virtual machine is not powered on.

Raise :

com.vmware.vapi.std.errors_client.ResourceBusy if the virtual machine is busy performing another operation.

Raise :

com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed.

Raise :

com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.

Raise :

com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.

Raise :

com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

Serial.get(vm, port)

Returns information about a virtual serial port.

Parameters:

• vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
• port (str) – Virtual serial port identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort.

Return type:

Serial.Info

Returns:

Information about the specified virtual serial port.

Raise :

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise :

com.vmware.vapi.std.errors_client.NotFound if the virtual machine or virtual serial port is not found.

Raise :

com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed.

Raise :

com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.

Raise :

com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.

Raise :

com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

Serial.list(vm)

Returns commonly used information about the virtual serial ports belonging to the virtual machine.

Parameters:vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine. Return type:list of Serial.Summary Returns:List of commonly used information about virtual serial ports. Raise :com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request. Raise :com.vmware.vapi.std.errors_client.NotFound if the virtual machine is not found. Raise :com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed. Raise :com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request. Raise :com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated. Raise :com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

Serial.update(vm, port, spec)

Updates the configuration of a virtual serial port.

Parameters:

• vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
• port (str) – Virtual serial port identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort.
• spec (Serial.UpdateSpec) – Specification for updating the virtual serial port.

Raise :

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise :

com.vmware.vapi.std.errors_client.NotFound if the virtual machine or virtual serial port is not found.

Raise :

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if one or more of the attributes specified in the spec parameter cannot be modified due to the current power state of the virtual machine or the connection state of the virtual serial port.

Raise :

com.vmware.vapi.std.errors_client.ResourceBusy if the virtual machine is busy performing another operation.

Raise :

com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed.

Raise :

com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.

Raise :

com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.

Raise :

com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

Subpackages

• hardware Package
  • hardware Package
  • adapter_client Module
  • boot_client Module