com.vmware.vcenter.vm.hardware package¶
Submodules¶
com.vmware.vcenter.vm.hardware.adapter_client module¶
The com.vmware.vcenter.vm.hardware.adapter_client
module provides classes
for managing the configuration and state of the virtual adapters belonging to a
virtual machine. This includes methods for reading and manipulating the
conifguration of USB adapters and host bus adapters.
Note that classes for adapters with no configurable properties or runtime state, such as IDE and PCI adapters, are omitted.
-
class
com.vmware.vcenter.vm.hardware.adapter_client.
Sata
(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterface
The
Sata
class provides methods for configuring the virtual SATA adapters of a virtual machine.- Parameters
config (
vmware.vapi.bindings.stub.StubConfiguration
) – Configuration to be used for creating the stub.
-
class
CreateSpec
(type=None, bus=None, pci_slot_number=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
The
Sata.CreateSpec
class provides a specification for the configuration of a newly-created virtual SATA adapter.Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
type (
Sata.Type
orNone
) – Adapter type. If None, a guest-specific default value will be used.bus (
long
orNone
) – SATA bus number. If None, the server will choose an available bus number; if none is available, the request will fail.pci_slot_number (
long
orNone
) – Address of the SATA adapter on the PCI bus. If None, the server will choose an available address when the virtual machine is powered on.
-
class
Info
(label=None, type=None, bus=None, pci_slot_number=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
The
Sata.Info
class contains information about a virtual SATA adapter.Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
label (
str
) – Device label.type (
Sata.Type
) – Adapter type.bus (
long
) – SATA bus number.pci_slot_number (
long
orNone
) – Address of the SATA adapter on the PCI bus. May be None if the virtual machine has never been powered on since the adapter was created.
-
RESOURCE_TYPE
= 'com.vmware.vcenter.vm.hardware.SataAdapter'¶ Resource type for the virtual SATA adapter device.
-
class
Summary
(adapter=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
The
Sata.Summary
class contains commonly used information about a Virtual SATA adapter.Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
adapter (
str
) – Identifier of the virtual SATA 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.SataAdapter
. 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.SataAdapter
.
-
class
Type
(string)¶ Bases:
vmware.vapi.bindings.enum.Enum
The
Sata.Type
class defines the valid emulation types for a virtual SATA 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 theType
instance.
-
AHCI
= Type(string='AHCI')¶ AHCI host bus adapter.
-
create
(vm, spec)¶ Adds a virtual SATA adapter to the virtual machine.
- Parameters
vm (
str
) – Virtual machine identifier. The parameter must be an identifier for the resource type:VirtualMachine
.spec (
Sata.CreateSpec
) – Specification for the new virtual SATA adapter.
- Return type
str
- Returns
Virtual SATA adapter identifier. The return value will be an identifier for the resource type:
com.vmware.vcenter.vm.hardware.SataAdapter
.- 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.Error
if the system reported that the SATA 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.NotAllowedInCurrentState
if the virtual machine is suspended- Raise
com.vmware.vapi.std.errors_client.NotFound
if the virtual machine is not found.- Raise
com.vmware.vapi.std.errors_client.UnableToAllocateResource
if there are no more available SATA buses on the virtual machine.- Raise
com.vmware.vapi.std.errors_client.ResourceInUse
if the specified SATA bus or PCI address is in use.- Raise
com.vmware.vapi.std.errors_client.InvalidArgument
if the specified SATA bus or PCI 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.
-
delete
(vm, adapter)¶ Removes a virtual SATA adapter from the virtual machine.
- Parameters
vm (
str
) – Virtual machine identifier. The parameter must be an identifier for the resource type:VirtualMachine
.adapter (
str
) – Virtual SATA adapter identifier. The parameter must be an identifier for the resource type:com.vmware.vcenter.vm.hardware.SataAdapter
.
- 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.NotAllowedInCurrentState
if the virtual machine is suspended- Raise
com.vmware.vapi.std.errors_client.NotFound
if the virtual machine or virtual SATA 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.
-
get
(vm, adapter)¶ Returns information about a virtual SATA adapter.
- Parameters
vm (
str
) – Virtual machine identifier. The parameter must be an identifier for the resource type:VirtualMachine
.adapter (
str
) – Virtual SATA adapter identifier. The parameter must be an identifier for the resource type:com.vmware.vcenter.vm.hardware.SataAdapter
.
- Return type
- Returns
Information about the specified virtual SATA 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 SATA 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.
-
list
(vm)¶ Returns commonly used information about the virtual SATA 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
ofSata.Summary
- Returns
List of commonly used information about virtual SATA 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.
-
class
com.vmware.vcenter.vm.hardware.adapter_client.
Scsi
(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterface
The
Scsi
class provides methods for configuring the virtual SCSI adapters of a virtual machine.- Parameters
config (
vmware.vapi.bindings.stub.StubConfiguration
) – Configuration to be used for creating the stub.
-
class
CreateSpec
(type=None, bus=None, pci_slot_number=None, sharing=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
The
Scsi.CreateSpec
class provides a specification for the configuration of a newly-created virtual SCSI adapter.Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
type (
Scsi.Type
orNone
) – Adapter type. If None, a guest-specific default value will be used.bus (
long
orNone
) – SCSI bus number. If None, the server will choose an available bus number; if none is available, the request will fail.pci_slot_number (
long
orNone
) – Address of the SCSI 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. If None, the server will choose an available address when the virtual machine is powered on.sharing (
Scsi.Sharing
orNone
) – Bus sharing mode. If None, the adapter will default toScsi.Sharing.NONE
.
-
class
Info
(label=None, type=None, scsi=None, pci_slot_number=None, sharing=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
The
Scsi.Info
class contains information about a virtual SCSI adapter.Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
label (
str
) – Device label.type (
Scsi.Type
) – Adapter type.scsi (
com.vmware.vcenter.vm.hardware_client.ScsiAddressInfo
) – Address of the SCSI adapter on the SCSI bus.pci_slot_number (
long
orNone
) – Address of the SCSI 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.sharing (
Scsi.Sharing
) – Bus sharing mode.
-
RESOURCE_TYPE
= 'com.vmware.vcenter.vm.hardware.ScsiAdapter'¶ Resource type for the virtual SCSI adapter device.
-
class
Sharing
(string)¶ Bases:
vmware.vapi.bindings.enum.Enum
The
Scsi.Sharing
class defines the valid bus sharing modes for a virtual SCSI 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 theSharing
instance.
-
NONE
= Sharing(string='NONE')¶ The virtual SCSI bus is not shared.
-
PHYSICAL
= Sharing(string='PHYSICAL')¶ The virtual SCSI bus is shared between two or more virtual machines residing on different physical hosts.
-
VIRTUAL
= Sharing(string='VIRTUAL')¶ The virtual SCSI bus is shared between two or more virtual machines. In this case, no physical machine is involved.
-
class
Summary
(adapter=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
The
Scsi.Summary
class contains commonly used information about a Virtual SCSI adapter.Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
adapter (
str
) – Identifier of the virtual SCSI 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.ScsiAdapter
. 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.ScsiAdapter
.
-
class
Type
(string)¶ Bases:
vmware.vapi.bindings.enum.Enum
The
Scsi.Type
class defines the valid emulation types for a virtual SCSI 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 theType
instance.
-
BUSLOGIC
= Type(string='BUSLOGIC')¶ BusLogic host bus adapter.
-
LSILOGIC
= Type(string='LSILOGIC')¶ LSI Logic host bus adapter.
-
LSILOGICSAS
= Type(string='LSILOGICSAS')¶ LSI Logic SAS 1068 host bus adapter.
-
PVSCSI
= Type(string='PVSCSI')¶ Paravirtualized host bus adapter.
-
class
UpdateSpec
(sharing=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
The
Scsi.UpdateSpec
class describes the updates to be made to the configuration of a virtual SCSI adapter.Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
sharing (
Scsi.Sharing
orNone
) –Bus sharing mode.
This attribute may only be modified if the virtual machine is not powered on. If None, the value is unchanged.
-
create
(vm, spec)¶ Adds a virtual SCSI adapter to the virtual machine.
- Parameters
vm (
str
) – Virtual machine identifier. The parameter must be an identifier for the resource type:VirtualMachine
.spec (
Scsi.CreateSpec
) – Specification for the new virtual SCSI adapter.
- Return type
str
- Returns
Virtual SCSI adapter identifier. The return value will be an identifier for the resource type:
com.vmware.vcenter.vm.hardware.ScsiAdapter
.- Raise
com.vmware.vapi.std.errors_client.Error
if the system reported that the SCSI 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.NotAllowedInCurrentState
if the virtual machine is suspended- Raise
com.vmware.vapi.std.errors_client.NotFound
if the virtual machine is not found.- Raise
com.vmware.vapi.std.errors_client.UnableToAllocateResource
if there are no more available SCSI buses on the virtual machine.- Raise
com.vmware.vapi.std.errors_client.ResourceInUse
if the specified SCSI bus is in use.- Raise
com.vmware.vapi.std.errors_client.InvalidArgument
if the specified SATA bus or PCI 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.
-
delete
(vm, adapter)¶ Removes a virtual SCSI adapter from the virtual machine.
- Parameters
vm (
str
) – Virtual machine identifier. The parameter must be an identifier for the resource type:VirtualMachine
.adapter (
str
) – Virtual SCSI adapter identifier. The parameter must be an identifier for the resource type:com.vmware.vcenter.vm.hardware.ScsiAdapter
.
- 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.NotAllowedInCurrentState
if the virtual machine is suspended- Raise
com.vmware.vapi.std.errors_client.NotFound
if the virtual machine or virtual SCSI 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.
-
get
(vm, adapter)¶ Returns information about a virtual SCSI adapter.
- Parameters
vm (
str
) – Virtual machine identifier. The parameter must be an identifier for the resource type:VirtualMachine
.adapter (
str
) – Virtual SCSI adapter identifier. The parameter must be an identifier for the resource type:com.vmware.vcenter.vm.hardware.ScsiAdapter
.
- Return type
- Returns
Information about the specified virtual SCSI 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 SCSI 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.
-
list
(vm)¶ Returns commonly used information about the virtual SCSI 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
ofScsi.Summary
- Returns
List of commonly used information about virtual SCSI 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.
-
update
(vm, adapter, spec)¶ Updates the configuration of a virtual SCSI adapter.
- Parameters
vm (
str
) – Virtual machine identifier. The parameter must be an identifier for the resource type:VirtualMachine
.adapter (
str
) – Virtual SCSI adapter identifier. The parameter must be an identifier for the resource type:com.vmware.vcenter.vm.hardware.ScsiAdapter
.spec (
Scsi.UpdateSpec
) – Specification for updating the virtual SCSI 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 SCSI adapter is not found.- Raise
com.vmware.vapi.std.errors_client.NotAllowedInCurrentState
if one or more of the attributes specified in thespec
parameter cannot be modified due to the current power state of the virtual machine or the connection state of the virtual SCSI adapter.- 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.adapter_client.
StubFactory
(stub_config)¶ Bases:
vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
- Parameters
stub_config (
vmware.vapi.bindings.stub.StubConfiguration
) – Stub config instance
com.vmware.vcenter.vm.hardware.boot_client module¶
The com.vmware.vcenter.vm.hardware.boot_client
module provides classes for
managing the virtual devices used to boot a virtual machine.
-
class
com.vmware.vcenter.vm.hardware.boot_client.
Device
(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterface
The
Device
class provides methods for configuring the device order used when booting a virtual machine.The boot order may be specified using a mixture of device classes and device instances, chosen from among the following:
Device.Type.CDROM
: Boot from a virtual CD-ROM drive; the device instance(s) will be chosen by the BIOS subsystem.Device.Type.FLOPPY
: Boot from a virtual floppy drive; the device instance(s) will be chosen by the BIOS subsystem.Device.Type.DISK
: Boot from a virtual disk device; the device instance is specified explicitly inDevice.Entry.disks
list, and multiple instances may be specified in the list.Device.Type.ETHERNET
: Boot from a virtual Ethernet adapter; the device instance is specified explicitly asDevice.Entry.nic
, and multiple adapters may be specified in the boot order list.
- Parameters
config (
vmware.vapi.bindings.stub.StubConfiguration
) – Configuration to be used for creating the stub.
-
class
Entry
(type=None, nic=None, disks=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
The
Device.Entry
class specifies a bootable virtual device class or specific bootable virtual device(s).Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
type (
Device.Type
) – Virtual device type.nic (
str
) – Virtual Ethernet device. Ethernet device to use as boot device for this entry. 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
. This attribute is optional and it is only relevant when the value oftype
isDevice.Type.ETHERNET
.disks (
list
ofstr
) – Virtual disk device. List of virtual disks in boot order. When clients pass a value of this class as a parameter, the attribute must contain identifiers 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 contain identifiers for the resource type:com.vmware.vcenter.vm.hardware.Disk
. This attribute is optional and it is only relevant when the value oftype
isDevice.Type.DISK
.
-
class
EntryCreateSpec
(type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
The class
Device.EntryCreateSpec
specifies a list of bootable virtual device classes. When a VM is being created and alist
ofDevice.EntryCreateSpec
is specified, the boot order of the specific device instances are not specified in this class. The boot order of the specific device instance will be the order in which the Ethernet and Disk devices appear in thenics
anddisks
respectively.Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
type (
Device.Type
) – Virtual Boot device type.
-
class
Type
(string)¶ Bases:
vmware.vapi.bindings.enum.Enum
The
Device.Type
class defines the valid device types that may be used as bootable devices.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 theType
instance.
-
CDROM
= Type(string='CDROM')¶ Virtual CD-ROM device.
-
DISK
= Type(string='DISK')¶ Virtual disk device.
-
ETHERNET
= Type(string='ETHERNET')¶ Virtual Ethernet adapter.
-
FLOPPY
= Type(string='FLOPPY')¶ Virtual floppy drive.
-
get
(vm)¶ Returns an ordered list of boot devices for the virtual machine. If the
list
is empty, the virtual machine uses a default boot sequence.- Parameters
vm (
str
) – Virtual machine identifier. The parameter must be an identifier for the resource type:VirtualMachine
.- Return type
list
ofDevice.Entry
- Returns
Ordered list of configured boot 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.
-
set
(vm, devices)¶ Sets the virtual devices that will be used to boot the virtual machine. The virtual machine will check the devices in order, attempting to boot from each, until the virtual machine boots successfully. If the
list
is empty, the virtual machine will use a default boot sequence. There should be no more than one instance ofDevice.Entry
for a given device type exceptDevice.Type.ETHERNET
in thelist
.- Parameters
vm (
str
) – Virtual machine identifier. The parameter must be an identifier for the resource type:VirtualMachine
.devices (
list
ofDevice.Entry
) – Ordered list of boot 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, or if any of the specified virtual devices is not found.- Raise
com.vmware.vapi.std.errors_client.InvalidArgument
if a any of the CDROM, DISK, ETHERNET, FLOPPY values appears in more than oneDevice.Entry
with the exception ofDevice.Type.ETHERNET
, which may appear multiple times if the virtual machine has been configured with multiple Ethernet adapters.- 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.boot_client.
StubFactory
(stub_config)¶ Bases:
vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
- Parameters
stub_config (
vmware.vapi.bindings.stub.StubConfiguration
) – Stub config instance