<spanid="com-vmware-vcenter-vm-hardware-package"></span><h1>com.vmware.vcenter.vm.hardware package<aclass="headerlink"href="#module-com.vmware.vcenter.vm.hardware"title="Permalink to this headline">¶</a></h1>
<divclass="section"id="submodules">
<h2>Submodules<aclass="headerlink"href="#submodules"title="Permalink to this headline">¶</a></h2>
<spanid="com-vmware-vcenter-vm-hardware-adapter-client-module"></span><h2>com.vmware.vcenter.vm.hardware.adapter_client module<aclass="headerlink"href="#module-com.vmware.vcenter.vm.hardware.adapter_client"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vm.hardware.adapter_client.</code><codeclass="descname">Sata</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware.adapter_client.Sata"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
<emclass="property">class </em><codeclass="descname">CreateSpec</code><spanclass="sig-paren">(</span><em>type=None</em>, <em>bus=None</em>, <em>pci_slot_number=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware.adapter_client.Sata.CreateSpec"title="Permalink to this definition">¶</a></dt>
If None, a guest-specific default value will be used.</li>
<li><strong>bus</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – SATA bus number.
If None, the server will choose an available bus number; if none is
available, the request will fail.</li>
<li><strong>pci_slot_number</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Address of the SATA adapter on the PCI bus.
If None, the server will choose an available address when the
<emclass="property">class </em><codeclass="descname">Info</code><spanclass="sig-paren">(</span><em>label=None</em>, <em>type=None</em>, <em>bus=None</em>, <em>pci_slot_number=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware.adapter_client.Sata.Info"title="Permalink to this definition">¶</a></dt>
<li><strong>bus</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – SATA bus number.</li>
<li><strong>pci_slot_number</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Address of the SATA adapter on the PCI bus.
May be None if the virtual machine has never been powered on since
<codeclass="descname">RESOURCE_TYPE</code><emclass="property"> = 'com.vmware.vcenter.vm.hardware.SataAdapter'</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware.adapter_client.Sata.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<dd><p>Resource type for the virtual SATA adapter device.</p>
<emclass="property">class </em><codeclass="descname">Summary</code><spanclass="sig-paren">(</span><em>adapter=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware.adapter_client.Sata.Summary"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>adapter</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – 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:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vm.hardware.SataAdapter</span></code>. When methods return
a value of this class as a return value, the attribute will be an
<emclass="property">class </em><codeclass="descname">Type</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware.adapter_client.Sata.Type"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Sata.Type</span></code> class defines the valid emulation types for a virtual
SATA adapter.</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">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 <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">AHCI</code><emclass="property"> = Type(string='AHCI')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware.adapter_client.Sata.Type.AHCI"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">create</code><spanclass="sig-paren">(</span><em>vm</em>, <em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware.adapter_client.Sata.create"title="Permalink to this definition">¶</a></dt>
<dd><p>Adds a virtual SATA adapter to the virtual machine.</p>
<li><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware.adapter_client.Sata.CreateSpec"title="com.vmware.vcenter.vm.hardware.adapter_client.Sata.CreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Sata.CreateSpec</span></code></a>) – Specification for the new virtual SATA adapter.</li>
<codeclass="descname">delete</code><spanclass="sig-paren">(</span><em>vm</em>, <em>adapter</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware.adapter_client.Sata.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Removes a virtual SATA adapter from the virtual machine.</p>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>vm</em>, <em>adapter</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware.adapter_client.Sata.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about a virtual SATA adapter.</p>
<trclass="field-odd field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first">Information about the specified virtual SATA adapter.</p>
<codeclass="descname">list</code><spanclass="sig-paren">(</span><em>vm</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware.adapter_client.Sata.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns commonly used information about the virtual SATA adapters
<trclass="field-odd field"><thclass="field-name">Returns:</th><tdclass="field-body">List of commonly used information about virtual SATA adapters.</td>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vm.hardware.adapter_client.</code><codeclass="descname">Scsi</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
<emclass="property">class </em><codeclass="descname">CreateSpec</code><spanclass="sig-paren">(</span><em>type=None</em>, <em>bus=None</em>, <em>pci_slot_number=None</em>, <em>sharing=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.CreateSpec"title="Permalink to this definition">¶</a></dt>
If None, a guest-specific default value will be used.</li>
<li><strong>bus</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – SCSI bus number.
If None, the server will choose an available bus number; if none is
available, the request will fail.</li>
<li><strong>pci_slot_number</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – 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.</li>
<li><strong>sharing</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Sharing"title="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Sharing"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Scsi.Sharing</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Bus sharing mode.
If None, the adapter will default to <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Sharing.NONE"title="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Sharing.NONE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Scsi.Sharing.NONE</span></code></a>.</li>
<emclass="property">class </em><codeclass="descname">Info</code><spanclass="sig-paren">(</span><em>label=None</em>, <em>type=None</em>, <em>scsi=None</em>, <em>pci_slot_number=None</em>, <em>sharing=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Info"title="Permalink to this definition">¶</a></dt>
<li><strong>scsi</strong> (<aclass="reference internal"href="com.vmware.vcenter.vm.html#com.vmware.vcenter.vm.hardware_client.ScsiAddressInfo"title="com.vmware.vcenter.vm.hardware_client.ScsiAddressInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vm.hardware_client.ScsiAddressInfo</span></code></a>) – Address of the SCSI adapter on the SCSI bus.</li>
<li><strong>pci_slot_number</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – 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
<codeclass="descname">RESOURCE_TYPE</code><emclass="property"> = 'com.vmware.vcenter.vm.hardware.ScsiAdapter'</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<dd><p>Resource type for the virtual SCSI adapter device.</p>
<emclass="property">class </em><codeclass="descname">Sharing</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Sharing"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Scsi.Sharing</span></code> class defines the valid bus sharing modes for a
virtual SCSI adapter.</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">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 <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">NONE</code><emclass="property"> = Sharing(string='NONE')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Sharing.NONE"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">PHYSICAL</code><emclass="property"> = Sharing(string='PHYSICAL')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Sharing.PHYSICAL"title="Permalink to this definition">¶</a></dt>
<dd><p>The virtual SCSI bus is shared between two or more virtual machines
<codeclass="descname">VIRTUAL</code><emclass="property"> = Sharing(string='VIRTUAL')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Sharing.VIRTUAL"title="Permalink to this definition">¶</a></dt>
<dd><p>The virtual SCSI bus is shared between two or more virtual machines. In
<emclass="property">class </em><codeclass="descname">Summary</code><spanclass="sig-paren">(</span><em>adapter=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Summary"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descname">Type</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Type"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Scsi.Type</span></code> class defines the valid emulation types for a virtual
SCSI adapter.</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">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 <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">BUSLOGIC</code><emclass="property"> = Type(string='BUSLOGIC')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Type.BUSLOGIC"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">LSILOGIC</code><emclass="property"> = Type(string='LSILOGIC')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Type.LSILOGIC"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">LSILOGICSAS</code><emclass="property"> = Type(string='LSILOGICSAS')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Type.LSILOGICSAS"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">PVSCSI</code><emclass="property"> = Type(string='PVSCSI')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Type.PVSCSI"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descname">UpdateSpec</code><spanclass="sig-paren">(</span><em>sharing=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.UpdateSpec"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">create</code><spanclass="sig-paren">(</span><em>vm</em>, <em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.create"title="Permalink to this definition">¶</a></dt>
<dd><p>Adds a virtual SCSI adapter to the virtual machine.</p>
<codeclass="descname">delete</code><spanclass="sig-paren">(</span><em>vm</em>, <em>adapter</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Removes a virtual SCSI adapter from the virtual machine.</p>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>vm</em>, <em>adapter</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about a virtual SCSI adapter.</p>
<trclass="field-odd field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first">Information about the specified virtual SCSI adapter.</p>
<codeclass="descname">list</code><spanclass="sig-paren">(</span><em>vm</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns commonly used information about the virtual SCSI adapters
<trclass="field-odd field"><thclass="field-name">Returns:</th><tdclass="field-body">List of commonly used information about virtual SCSI adapters.</td>
<codeclass="descname">update</code><spanclass="sig-paren">(</span><em>vm</em>, <em>adapter</em>, <em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Updates the configuration of a virtual SCSI adapter.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vm.hardware.adapter_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware.adapter_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-vcenter-vm-hardware-boot-client-module"></span><h2>com.vmware.vcenter.vm.hardware.boot_client module<aclass="headerlink"href="#module-com.vmware.vcenter.vm.hardware.boot_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vm.hardware.boot_client</span></code> module provides classes for
managing the virtual devices used to boot a virtual machine.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vm.hardware.boot_client.</code><codeclass="descname">Device</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware.boot_client.Device"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Device</span></code> class provides methods for configuring the device order used
when booting a virtual machine.</p>
<p>The boot order may be specified using a mixture of device classes and
device instances, chosen from among the following:</p>
<ulclass="simple">
<li><aclass="reference internal"href="#com.vmware.vcenter.vm.hardware.boot_client.Device.Type.CDROM"title="com.vmware.vcenter.vm.hardware.boot_client.Device.Type.CDROM"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Device.Type.CDROM</span></code></a>: Boot from a virtual CD-ROM drive; the device
instance(s) will be chosen by the BIOS subsystem.</li>
<li><aclass="reference internal"href="#com.vmware.vcenter.vm.hardware.boot_client.Device.Type.FLOPPY"title="com.vmware.vcenter.vm.hardware.boot_client.Device.Type.FLOPPY"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Device.Type.FLOPPY</span></code></a>: Boot from a virtual floppy drive; the device
instance(s) will be chosen by the BIOS subsystem.</li>
<li><aclass="reference internal"href="#com.vmware.vcenter.vm.hardware.boot_client.Device.Type.DISK"title="com.vmware.vcenter.vm.hardware.boot_client.Device.Type.DISK"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Device.Type.DISK</span></code></a>: Boot from a virtual disk device; the device
instance is specified explicitly in <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Device.Entry.disks</span></code> list, and
multiple instances may be specified in the list.</li>
<li><aclass="reference internal"href="#com.vmware.vcenter.vm.hardware.boot_client.Device.Type.ETHERNET"title="com.vmware.vcenter.vm.hardware.boot_client.Device.Type.ETHERNET"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Device.Type.ETHERNET</span></code></a>: Boot from a virtual Ethernet adapter; the
device instance is specified explicitly as <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Device.Entry.nic</span></code>, and
multiple adapters may be specified in the boot order list.</li>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
<emclass="property">class </em><codeclass="descname">Entry</code><spanclass="sig-paren">(</span><em>type=None</em>, <em>nic=None</em>, <em>disks=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware.boot_client.Device.Entry"title="Permalink to this definition">¶</a></dt>
<li><strong>nic</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – 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:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vm.hardware.Ethernet</span></code>. When methods return a
value of this class as a return value, the attribute will be an
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware.boot_client.Device.Type.ETHERNET"title="com.vmware.vcenter.vm.hardware.boot_client.Device.Type.ETHERNET"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Device.Type.ETHERNET</span></code></a>.</li>
<li><strong>disks</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – 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:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>. When methods return a
value of this class as a return value, the attribute will contain
<emclass="property">class </em><codeclass="descname">EntryCreateSpec</code><spanclass="sig-paren">(</span><em>type=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware.boot_client.Device.EntryCreateSpec"title="Permalink to this definition">¶</a></dt>
<p>The class <codeclass="docutils literal notranslate"><spanclass="pre">Device.EntryCreateSpec</span></code> specifies a list of bootable virtual
device classes. When a VM is being created and a <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of
<codeclass="docutils literal notranslate"><spanclass="pre">Device.EntryCreateSpec</span></code> 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 the <codeclass="docutils literal notranslate"><spanclass="pre">nics</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">disks</span></code> respectively.</p>
<divclass="admonition tip">
<pclass="first admonition-title">Tip</p>
<pclass="last">The arguments are used to initialize data attributes with the same
<emclass="property">class </em><codeclass="descname">Type</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware.boot_client.Device.Type"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Device.Type</span></code> class defines the valid device types that may be used
as bootable devices.</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">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 <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">CDROM</code><emclass="property"> = Type(string='CDROM')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware.boot_client.Device.Type.CDROM"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DISK</code><emclass="property"> = Type(string='DISK')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware.boot_client.Device.Type.DISK"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">ETHERNET</code><emclass="property"> = Type(string='ETHERNET')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware.boot_client.Device.Type.ETHERNET"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">FLOPPY</code><emclass="property"> = Type(string='FLOPPY')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware.boot_client.Device.Type.FLOPPY"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>vm</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware.boot_client.Device.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns an ordered list of boot devices for the virtual machine. If the
<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> is empty, the virtual machine uses a default boot
<codeclass="descname">set</code><spanclass="sig-paren">(</span><em>vm</em>, <em>devices</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware.boot_client.Device.set"title="Permalink to this definition">¶</a></dt>
<dd><p>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
<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> is empty, the virtual machine will use a default boot
sequence. There should be no more than one instance of
<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware.boot_client.Device.Entry"title="com.vmware.vcenter.vm.hardware.boot_client.Device.Entry"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Device.Entry</span></code></a> for a given device type except
<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware.boot_client.Device.Type.ETHERNET"title="com.vmware.vcenter.vm.hardware.boot_client.Device.Type.ETHERNET"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Device.Type.ETHERNET</span></code></a> in the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code>.</p>
if a any of the CDROM, DISK, ETHERNET, FLOPPY values appears in
more than one <codeclass="docutils literal notranslate"><spanclass="pre">Device.Entry</span></code> with the exception of
<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware.boot_client.Device.Type.ETHERNET"title="com.vmware.vcenter.vm.hardware.boot_client.Device.Type.ETHERNET"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Device.Type.ETHERNET</span></code></a>, which may appear multiple times if
the virtual machine has been configured with multiple Ethernet
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vm.hardware.boot_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware.boot_client.StubFactory"title="Permalink to this definition">¶</a></dt>
Built with <ahref="http://sphinx-doc.org/">Sphinx</a> using a <ahref="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <ahref="https://readthedocs.org">Read the Docs</a>.
