<spanid="com-vmware-vcenter-vm-package"></span><h1>com.vmware.vcenter.vm package<aclass="headerlink"href="#module-com.vmware.vcenter.vm"title="Permalink to this headline">¶</a></h1>
<divclass="section"id="subpackages">
<h2>Subpackages<aclass="headerlink"href="#subpackages"title="Permalink to this headline">¶</a></h2>
<spanid="com-vmware-vcenter-vm-compute-client-module"></span><h2>com.vmware.vcenter.vm.compute_client module<aclass="headerlink"href="#module-com.vmware.vcenter.vm.compute_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vm.compute_client</span></code> module provides classes for
quering the status of compute policies on virtual machines.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vm.compute_client.</code><codeclass="descname">Policies</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.compute_client.Policies"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">Info</code><spanclass="sig-paren">(</span><em>status=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.compute_client.Policies.Info"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>status</strong> (<aclass="reference internal"href="com.vmware.vcenter.compute.html#com.vmware.vcenter.compute.policies_client.Status.Compliance"title="com.vmware.vcenter.compute.policies_client.Status.Compliance"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.compute.policies_client.Status.Compliance</span></code></a>) – The compliance status of the policy on a specified object.
<strong>Warning:</strong> This attribute is available as technical preview. It
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>vm</em>, <em>policy</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.compute_client.Policies.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about the compliance of a virtual machine with a
compute policy. <strong>Warning:</strong> This method is available as technical
preview. It may be changed in a future release.</p>
<li><strong>vm</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the virtual machine to query the status for.
The parameter must be an identifier for the resource type:
<li><strong>policy</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the policy to query the status for.
The parameter must be an identifier for the resource type:
<trclass="field-odd field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first">Information about the compliance of the specified virtual machine
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vm.compute_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.compute_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-vcenter-vm-guest-client-module"></span><h2>com.vmware.vcenter.vm.guest_client module<aclass="headerlink"href="#module-com.vmware.vcenter.vm.guest_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vm.guest_client</span></code> module provides classes for dealing
with the guest operating system. This includes information about the state of
local file systems and network interfaces and methods to manipulate the guest
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vm.guest_client.</code><codeclass="descname">Identity</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Identity"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">Info</code><spanclass="sig-paren">(</span><em>name=None</em>, <em>family=None</em>, <em>full_name=None</em>, <em>host_name=None</em>, <em>ip_address=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Identity.Info"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>name</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.vm_client.GuestOS"title="com.vmware.vcenter.vm_client.GuestOS"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vm_client.GuestOS</span></code></a>) – Guest operating system identifier (short name). This attribute was
added in vSphere API 6.7</li>
<li><strong>family</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.vm_client.GuestOSFamily"title="com.vmware.vcenter.vm_client.GuestOSFamily"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vm_client.GuestOSFamily</span></code></a>) – Guest operating system family. This attribute was added in vSphere
API 6.7</li>
<li><strong>full_name</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Guest operating system full name. This attribute was added in
vSphere API 6.7</li>
<li><strong>host_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Hostname of the guest operating system. This attribute was added in
vSphere API 6.7</li>
<li><strong>ip_address</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – IP address assigned by the guest operating system. This attribute
was added in vSphere API 6.7
If None the guest does not have an IP address.</li>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>vm</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Identity.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Return information about the guest. This method was added in vSphere
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vm.guest_client.</code><codeclass="descname">LocalFilesystem</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.LocalFilesystem"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">Info</code><spanclass="sig-paren">(</span><em>capacity=None</em>, <em>free_space=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.LocalFilesystem.Info"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>capacity</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Total capacity of the file system, in bytes. This attribute was
added in vSphere API 6.7</li>
<li><strong>free_space</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Free space on the file system, in bytes. This attribute was added
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>vm</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.LocalFilesystem.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns details of the local file systems in the guest operating
system. This method was added in vSphere API 6.7</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vm.guest_client.</code><codeclass="descname">Power</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Power"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">Info</code><spanclass="sig-paren">(</span><em>state=None</em>, <em>operations_ready=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Power.Info"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>state</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.guest_client.Power.State"title="com.vmware.vcenter.vm.guest_client.Power.State"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Power.State</span></code></a>) – The power state of the guest operating system. This attribute was
added in vSphere API 6.7</li>
<li><strong>operations_ready</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag indicating if the virtual machine is ready to process soft
power operations. This attribute was added in vSphere API 6.7</li>
<emclass="property">class </em><codeclass="descname">State</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Power.State"title="Permalink to this definition">¶</a></dt>
<p>Possible guest power states. This enumeration was added in vSphere API 6.7</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">NOT_RUNNING</code><emclass="property"> = State(string='NOT_RUNNING')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Power.State.NOT_RUNNING"title="Permalink to this definition">¶</a></dt>
<dd><p>The guest OS is not running. This class attribute was added in vSphere API
<codeclass="descname">RESETTING</code><emclass="property"> = State(string='RESETTING')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Power.State.RESETTING"title="Permalink to this definition">¶</a></dt>
<dd><p>The guest OS is resetting. This class attribute was added in vSphere API
<codeclass="descname">RUNNING</code><emclass="property"> = State(string='RUNNING')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Power.State.RUNNING"title="Permalink to this definition">¶</a></dt>
<dd><p>The guest OS is running. This class attribute was added in vSphere API 6.7</p>
<codeclass="descname">SHUTTING_DOWN</code><emclass="property"> = State(string='SHUTTING_DOWN')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Power.State.SHUTTING_DOWN"title="Permalink to this definition">¶</a></dt>
<dd><p>The guest OS is shutting down. This class attribute was added in vSphere
<codeclass="descname">STANDBY</code><emclass="property"> = State(string='STANDBY')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Power.State.STANDBY"title="Permalink to this definition">¶</a></dt>
<dd><p>The guest OS is in standby. This class attribute was added in vSphere API
<codeclass="descname">UNAVAILABLE</code><emclass="property"> = State(string='UNAVAILABLE')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Power.State.UNAVAILABLE"title="Permalink to this definition">¶</a></dt>
<dd><p>The guest OS power state is unknown. This class attribute was added in
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>vm</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Power.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about the guest operating system power state. This
<codeclass="descname">reboot</code><spanclass="sig-paren">(</span><em>vm</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Power.reboot"title="Permalink to this definition">¶</a></dt>
<dd><p>Issues a request to the guest operating system asking it to perform a
reboot. This request returns immediately and does not wait for the
guest operating system to complete the operation. This method was added
<codeclass="descname">shutdown</code><spanclass="sig-paren">(</span><em>vm</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Power.shutdown"title="Permalink to this definition">¶</a></dt>
<dd><p>Issues a request to the guest operating system asking it to perform a
clean shutdown of all services. This request returns immediately and
does not wait for the guest operating system to complete the operation.
<codeclass="descname">standby</code><spanclass="sig-paren">(</span><em>vm</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Power.standby"title="Permalink to this definition">¶</a></dt>
<dd><p>Issues a request to the guest operating system asking it to perform a
suspend operation. This method was added in vSphere API 6.7</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vm.guest_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.guest_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-vcenter-vm-hardware-client-module"></span><h2>com.vmware.vcenter.vm.hardware_client module<aclass="headerlink"href="#module-com.vmware.vcenter.vm.hardware_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vm.hardware_client</span></code> 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.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vm.hardware_client.</code><codeclass="descname">Boot</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Boot"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>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Boot.Type"title="com.vmware.vcenter.vm.hardware_client.Boot.Type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Boot.Type</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – 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.</li>
<li><strong>efi_legacy_boot</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – 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.</li>
<li><strong>network_protocol</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Boot.NetworkProtocol"title="com.vmware.vcenter.vm.hardware_client.Boot.NetworkProtocol"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Boot.NetworkProtocol</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Protocol to use when attempting to boot the virtual machine over
the network.
If None, defaults to a system defined default value.</li>
<li><strong>delay</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – 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.</li>
<li><strong>retry</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating whether the virtual machine should automatically
retry the boot process after a failure.
If None, default value is false.</li>
<li><strong>retry_delay</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Delay in milliseconds before retrying the boot process after a
failure; applicable only when <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Boot.Info.retry</span></code> is true.
If None, default value is 10000.</li>
<li><strong>enter_setup_mode</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – 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
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Boot.Type"title="com.vmware.vcenter.vm.hardware_client.Boot.Type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Boot.Type</span></code></a>) – Firmware type used by the virtual machine.</li>
<li><strong>efi_legacy_boot</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag indicating whether to use EFI legacy boot mode.
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_client.Boot.Type.EFI"title="com.vmware.vcenter.vm.hardware_client.Boot.Type.EFI"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Boot.Type.EFI</span></code></a>.</li>
<li><strong>network_protocol</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Boot.NetworkProtocol"title="com.vmware.vcenter.vm.hardware_client.Boot.NetworkProtocol"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Boot.NetworkProtocol</span></code></a>) – 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 <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Boot.Type.EFI"title="com.vmware.vcenter.vm.hardware_client.Boot.Type.EFI"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Boot.Type.EFI</span></code></a>.</li>
<li><strong>delay</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – 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.</li>
<li><strong>retry</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag indicating whether the virtual machine will automatically
retry the boot process after a failure.</li>
<li><strong>retry_delay</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Delay in milliseconds before retrying the boot process after a
failure; applicable only when <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Boot.Info.retry</span></code> is true.</li>
<li><strong>enter_setup_mode</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – 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
<emclass="property">class </em><codeclass="descname">NetworkProtocol</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Boot.NetworkProtocol"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Boot.NetworkProtocol</span></code> class defines the valid network boot protocols
supported when booting a virtual machine with <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Boot.Type.EFI"title="com.vmware.vcenter.vm.hardware_client.Boot.Type.EFI"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Boot.Type.EFI</span></code></a>
firmware over the network.</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">IPV4</code><emclass="property"> = NetworkProtocol(string='IPV4')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Boot.NetworkProtocol.IPV4"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">IPV6</code><emclass="property"> = NetworkProtocol(string='IPV6')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Boot.NetworkProtocol.IPV6"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_client.Boot.Type"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Boot.Type</span></code> class defines the valid firmware types for a virtual
machine.</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">BIOS</code><emclass="property"> = Type(string='BIOS')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Boot.Type.BIOS"title="Permalink to this definition">¶</a></dt>
<dd><p>Basic Input/Output System (BIOS) firmware.</p>
<codeclass="descname">EFI</code><emclass="property"> = Type(string='EFI')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Boot.Type.EFI"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Boot.Type"title="com.vmware.vcenter.vm.hardware_client.Boot.Type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Boot.Type</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Firmware type to be used by the virtual machine.
If None, the value is unchanged.</li>
<li><strong>efi_legacy_boot</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating whether to use EFI legacy boot mode.
If None, the value is unchanged.</li>
<li><strong>network_protocol</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Boot.NetworkProtocol"title="com.vmware.vcenter.vm.hardware_client.Boot.NetworkProtocol"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Boot.NetworkProtocol</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Protocol to use when attempting to boot the virtual machine over
the network.
If None, the value is unchanged.</li>
<li><strong>delay</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – 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.</li>
<li><strong>retry</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating whether the virtual machine should automatically
retry the boot process after a failure.
If None, the value is unchanged.</li>
<li><strong>retry_delay</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Delay in milliseconds before retrying the boot process after a
failure; applicable only when <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Boot.Info.retry</span></code> is true.
If None, the value is unchanged.</li>
<li><strong>enter_setup_mode</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – 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
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>vm</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Boot.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the boot-related settings of a virtual machine.</p>
<codeclass="descname">update</code><spanclass="sig-paren">(</span><em>vm</em>, <em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Boot.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Updates the boot-related settings of a virtual machine.</p>
<li><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Boot.UpdateSpec"title="com.vmware.vcenter.vm.hardware_client.Boot.UpdateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Boot.UpdateSpec</span></code></a>) – Specification for updating the boot-related settings of the virtual
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vm.hardware_client.</code><codeclass="descname">Cdrom</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom"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">BackingInfo</code><spanclass="sig-paren">(</span><em>type=None</em>, <em>iso_file=None</em>, <em>host_device=None</em>, <em>auto_detect=None</em>, <em>device_access_type=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingInfo"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType"title="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cdrom.BackingType</span></code></a>) – Backing type for the virtual CD-ROM device.</li>
<li><strong>iso_file</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Path of the image file backing the virtual CD-ROM device.
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_client.Cdrom.BackingType.ISO_FILE"title="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType.ISO_FILE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cdrom.BackingType.ISO_FILE</span></code></a>.</li>
<li><strong>host_device</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name of the host device backing the virtual CD-ROM device.
This attribute will be None if <codeclass="docutils literal notranslate"><spanclass="pre">autoDetect</span></code> is true and the
virtual CD-ROM device is not connected or no suitable device is
available on the host.</li>
<li><strong>auto_detect</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – 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 <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType.HOST_DEVICE"title="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType.HOST_DEVICE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cdrom.BackingType.HOST_DEVICE</span></code></a>.</li>
<li><strong>device_access_type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.DeviceAccessType"title="com.vmware.vcenter.vm.hardware_client.Cdrom.DeviceAccessType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cdrom.DeviceAccessType</span></code></a>) – Access type for the device backing.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is one of <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType.HOST_DEVICE"title="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType.HOST_DEVICE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cdrom.BackingType.HOST_DEVICE</span></code></a> or
<emclass="property">class </em><codeclass="descname">BackingSpec</code><spanclass="sig-paren">(</span><em>type=None</em>, <em>iso_file=None</em>, <em>host_device=None</em>, <em>device_access_type=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingSpec"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType"title="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cdrom.BackingType</span></code></a>) – Backing type for the virtual CD-ROM device.</li>
<li><strong>iso_file</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – 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 <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType.ISO_FILE"title="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType.ISO_FILE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cdrom.BackingType.ISO_FILE</span></code></a>.</li>
<li><strong>host_device</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – 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.</li>
<li><strong>device_access_type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.DeviceAccessType"title="com.vmware.vcenter.vm.hardware_client.Cdrom.DeviceAccessType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cdrom.DeviceAccessType</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Access type for the device backing.
If None, defaults to <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.DeviceAccessType.EMULATION"title="com.vmware.vcenter.vm.hardware_client.Cdrom.DeviceAccessType.EMULATION"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cdrom.DeviceAccessType.EMULATION</span></code></a>.</li>
<emclass="property">class </em><codeclass="descname">BackingType</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cdrom.BackingType</span></code> class defines the valid backing types for a
virtual CD-ROM device.</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">CLIENT_DEVICE</code><emclass="property"> = BackingType(string='CLIENT_DEVICE')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType.CLIENT_DEVICE"title="Permalink to this definition">¶</a></dt>
<dd><p>Virtual CD-ROM device is backed by a device on the client that is connected
<codeclass="descname">HOST_DEVICE</code><emclass="property"> = BackingType(string='HOST_DEVICE')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType.HOST_DEVICE"title="Permalink to this definition">¶</a></dt>
<dd><p>Virtual CD-ROM device is backed by a device on the host where the virtual
<codeclass="descname">ISO_FILE</code><emclass="property"> = BackingType(string='ISO_FILE')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType.ISO_FILE"title="Permalink to this definition">¶</a></dt>
<dd><p>Virtual CD-ROM device is backed by an ISO file.</p>
<emclass="property">class </em><codeclass="descname">CreateSpec</code><spanclass="sig-paren">(</span><em>type=None</em>, <em>ide=None</em>, <em>sata=None</em>, <em>backing=None</em>, <em>start_connected=None</em>, <em>allow_guest_control=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.CreateSpec"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.HostBusAdapterType"title="com.vmware.vcenter.vm.hardware_client.Cdrom.HostBusAdapterType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cdrom.HostBusAdapterType</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Type of host bus adapter to which the device should be attached.
If None, guest-specific default values will be used</li>
<li><strong>ide</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.IdeAddressSpec"title="com.vmware.vcenter.vm.hardware_client.IdeAddressSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">IdeAddressSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – 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.</li>
<li><strong>sata</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.SataAddressSpec"title="com.vmware.vcenter.vm.hardware_client.SataAddressSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SataAddressSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – 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.</li>
<li><strong>backing</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingSpec"title="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cdrom.BackingSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Physical resource backing for the virtual CD-ROM device.
If None, defaults to automatic detection of a suitable host device.</li>
<li><strong>start_connected</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating whether the virtual device should be connected
whenever the virtual machine is powered on.
Defaults to false if None.</li>
<li><strong>allow_guest_control</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating whether the guest can connect and disconnect the
<emclass="property">class </em><codeclass="descname">DeviceAccessType</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.DeviceAccessType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cdrom.DeviceAccessType</span></code> class defines the valid device access types
for a physical device packing of a virtual CD-ROM device.</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">EMULATION</code><emclass="property"> = DeviceAccessType(string='EMULATION')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.DeviceAccessType.EMULATION"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">PASSTHRU</code><emclass="property"> = DeviceAccessType(string='PASSTHRU')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.DeviceAccessType.PASSTHRU"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">PASSTHRU_EXCLUSIVE</code><emclass="property"> = DeviceAccessType(string='PASSTHRU_EXCLUSIVE')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.DeviceAccessType.PASSTHRU_EXCLUSIVE"title="Permalink to this definition">¶</a></dt>
<dd><p>Raw passthru device access, with exclusive access to the device.</p>
<emclass="property">class </em><codeclass="descname">HostBusAdapterType</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.HostBusAdapterType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cdrom.HostBusAdapterType</span></code> class defines the valid types of host bus
adapters that may be used for attaching a Cdrom to a virtual machine.</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">IDE</code><emclass="property"> = HostBusAdapterType(string='IDE')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.HostBusAdapterType.IDE"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">SATA</code><emclass="property"> = HostBusAdapterType(string='SATA')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.HostBusAdapterType.SATA"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.HostBusAdapterType"title="com.vmware.vcenter.vm.hardware_client.Cdrom.HostBusAdapterType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cdrom.HostBusAdapterType</span></code></a>) – Type of host bus adapter to which the device is attached.</li>
<li><strong>ide</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.IdeAddressInfo"title="com.vmware.vcenter.vm.hardware_client.IdeAddressInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">IdeAddressInfo</span></code></a>) – Address of device attached to a virtual IDE adapter.
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_client.Cdrom.HostBusAdapterType.IDE"title="com.vmware.vcenter.vm.hardware_client.Cdrom.HostBusAdapterType.IDE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cdrom.HostBusAdapterType.IDE</span></code></a>.</li>
<li><strong>sata</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.SataAddressInfo"title="com.vmware.vcenter.vm.hardware_client.SataAddressInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SataAddressInfo</span></code></a>) – Address of device attached to a virtual SATA adapter.
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_client.Cdrom.HostBusAdapterType.SATA"title="com.vmware.vcenter.vm.hardware_client.Cdrom.HostBusAdapterType.SATA"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cdrom.HostBusAdapterType.SATA</span></code></a>.</li>
<li><strong>backing</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingInfo"title="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cdrom.BackingInfo</span></code></a>) – Physical resource backing for the virtual CD-ROM device.</li>
<li><strong>state</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.ConnectionState"title="com.vmware.vcenter.vm.hardware_client.ConnectionState"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ConnectionState</span></code></a>) – Connection status of the virtual device.</li>
<li><strong>start_connected</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag indicating whether the virtual device should be connected
whenever the virtual machine is powered on.</li>
<li><strong>allow_guest_control</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag indicating whether the guest can connect and disconnect the
<codeclass="descname">RESOURCE_TYPE</code><emclass="property"> = 'com.vmware.vcenter.vm.hardware.Cdrom'</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<dd><p>Resource type for the virtual CD-ROM device.</p>
<emclass="property">class </em><codeclass="descname">Summary</code><spanclass="sig-paren">(</span><em>cdrom=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.Summary"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descname">UpdateSpec</code><spanclass="sig-paren">(</span><em>backing=None</em>, <em>start_connected=None</em>, <em>allow_guest_control=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.UpdateSpec"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>backing</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingSpec"title="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cdrom.BackingSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Physical resource backing for the virtual CD-ROM device.</p>
<p>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.</p>
</li>
<li><strong>start_connected</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating whether the virtual device should be connected
whenever the virtual machine is powered on.
If None, the value is unchanged.</li>
<li><strong>allow_guest_control</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating whether the guest can connect and disconnect the
<codeclass="descname">connect</code><spanclass="sig-paren">(</span><em>vm</em>, <em>cdrom</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.connect"title="Permalink to this definition">¶</a></dt>
<dd><p>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.</p>
<p>For a powered-off virtual machine, the <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.update"title="com.vmware.vcenter.vm.hardware_client.Cdrom.update"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Cdrom.update()</span></code></a> method may
be used to configure the virtual CD-ROM device to start in the
connected state when the virtual machine is powered on.</p>
<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_client.Cdrom.create"title="Permalink to this definition">¶</a></dt>
<dd><p>Adds a virtual CD-ROM device to the virtual machine.</p>
<codeclass="descname">delete</code><spanclass="sig-paren">(</span><em>vm</em>, <em>cdrom</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Removes a virtual CD-ROM device from the virtual machine.</p>
<codeclass="descname">disconnect</code><spanclass="sig-paren">(</span><em>vm</em>, <em>cdrom</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.disconnect"title="Permalink to this definition">¶</a></dt>
<dd><p>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.</p>
<p>For a powered-off virtual machine, the <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.update"title="com.vmware.vcenter.vm.hardware_client.Cdrom.update"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Cdrom.update()</span></code></a> method may
be used to configure the virtual CD-ROM device to start in the
disconnected state when the virtual machine is powered on.</p>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>vm</em>, <em>cdrom</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about a virtual CD-ROM device.</p>
<trclass="field-odd field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first">Information about the specified virtual CD-ROM device.</p>
<codeclass="descname">list</code><spanclass="sig-paren">(</span><em>vm</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns commonly used information about the virtual CD-ROM devices
<trclass="field-odd field"><thclass="field-name">Returns:</th><tdclass="field-body">List of commonly used information about virtual CD-ROM devices.</td>
<codeclass="descname">update</code><spanclass="sig-paren">(</span><em>vm</em>, <em>cdrom</em>, <em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Updates the configuration of a virtual CD-ROM device.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vm.hardware_client.</code><codeclass="descname">ConnectionCreateSpec</code><spanclass="sig-paren">(</span><em>start_connected=None</em>, <em>allow_guest_control=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.ConnectionCreateSpec"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>start_connected</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating whether the virtual device should be connected
whenever the virtual machine is powered on.
Defaults to false if None.</li>
<li><strong>allow_guest_control</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating whether the guest can connect and disconnect the
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vm.hardware_client.</code><codeclass="descname">ConnectionInfo</code><spanclass="sig-paren">(</span><em>state=None</em>, <em>start_connected=None</em>, <em>allow_guest_control=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.ConnectionInfo"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>state</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.ConnectionState"title="com.vmware.vcenter.vm.hardware_client.ConnectionState"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ConnectionState</span></code></a>) – Connection status of the virtual device.</li>
<li><strong>start_connected</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag indicating whether the virtual device should be connected
whenever the virtual machine is powered on.</li>
<li><strong>allow_guest_control</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag indicating whether the guest can connect and disconnect the
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vm.hardware_client.</code><codeclass="descname">ConnectionState</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.ConnectionState"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ConnectionState</span></code> class defines the valid states for a removable
device that is configured to be connected.</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">CONNECTED</code><emclass="property"> = ConnectionState(string='CONNECTED')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.ConnectionState.CONNECTED"title="Permalink to this definition">¶</a></dt>
<dd><p>The device is connected and working correctly.</p>
<codeclass="descname">NOT_CONNECTED</code><emclass="property"> = ConnectionState(string='NOT_CONNECTED')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.ConnectionState.NOT_CONNECTED"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">RECOVERABLE_ERROR</code><emclass="property"> = ConnectionState(string='RECOVERABLE_ERROR')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.ConnectionState.RECOVERABLE_ERROR"title="Permalink to this definition">¶</a></dt>
<dd><p>Device connection failed due to a recoverable error; for example, the
virtual device backing is currently in use by another virtual machine.</p>
<codeclass="descname">UNKNOWN</code><emclass="property"> = ConnectionState(string='UNKNOWN')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.ConnectionState.UNKNOWN"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">UNRECOVERABLE_ERROR</code><emclass="property"> = ConnectionState(string='UNRECOVERABLE_ERROR')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.ConnectionState.UNRECOVERABLE_ERROR"title="Permalink to this definition">¶</a></dt>
<dd><p>Device connection failed due to an unrecoverable error; for example, the
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vm.hardware_client.</code><codeclass="descname">ConnectionUpdateSpec</code><spanclass="sig-paren">(</span><em>start_connected=None</em>, <em>allow_guest_control=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.ConnectionUpdateSpec"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>start_connected</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating whether the virtual device should be connected
whenever the virtual machine is powered on.
If None, the value is unchanged.</li>
<li><strong>allow_guest_control</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating whether the guest can connect and disconnect the
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vm.hardware_client.</code><codeclass="descname">Cpu</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cpu"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">Info</code><spanclass="sig-paren">(</span><em>count=None</em>, <em>cores_per_socket=None</em>, <em>hot_add_enabled=None</em>, <em>hot_remove_enabled=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cpu.Info"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Number of CPU cores.</li>
<li><strong>cores_per_socket</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Number of CPU cores per socket.</li>
<li><strong>hot_add_enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag indicating whether adding CPUs while the virtual machine is
running is enabled.</li>
<li><strong>hot_remove_enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag indicating whether removing CPUs while the virtual machine is
<emclass="property">class </em><codeclass="descname">UpdateSpec</code><spanclass="sig-paren">(</span><em>count=None</em>, <em>cores_per_socket=None</em>, <em>hot_add_enabled=None</em>, <em>hot_remove_enabled=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cpu.UpdateSpec"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>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.</p>
<p>The supported range of CPU counts is constrained by the configured
guest operating system and virtual hardware version of the virtual
machine.</p>
<p>If the virtual machine is running, the number of CPU cores may only
be increased if <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cpu.Info.hot_add_enabled</span></code> is true, and may
only be decreased if <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cpu.Info.hot_remove_enabled</span></code> is true.
If None, the value is unchanged.</p>
</li>
<li><strong>cores_per_socket</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – 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.</li>
<li><strong>hot_add_enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Flag indicating whether adding CPUs while the virtual machine is
running is enabled.</p>
<p>This attribute may only be modified if the virtual machine is
powered off.
If None, the value is unchanged.</p>
</li>
<li><strong>hot_remove_enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Flag indicating whether removing CPUs while the virtual machine is
running is enabled.</p>
<p>This attribute may only be modified if the virtual machine is
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>vm</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cpu.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the CPU-related settings of a virtual machine.</p>
<codeclass="descname">update</code><spanclass="sig-paren">(</span><em>vm</em>, <em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cpu.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Updates the CPU-related settings of a virtual machine.</p>
<li><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Cpu.UpdateSpec"title="com.vmware.vcenter.vm.hardware_client.Cpu.UpdateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cpu.UpdateSpec</span></code></a>) – Specification for updating the CPU-related settings of the virtual
if <codeclass="docutils literal notranslate"><spanclass="pre">hotAddEnabled</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">hotRemoveEnabled</span></code> is specified and the
if <codeclass="docutils literal notranslate"><spanclass="pre">count</span></code> is specified and is greater than <codeclass="docutils literal notranslate"><spanclass="pre">count</span></code>,
<codeclass="docutils literal notranslate"><spanclass="pre">hotAddEnabled</span></code> is false, and the virtual machine is not powered
if <codeclass="docutils literal notranslate"><spanclass="pre">count</span></code> is specified and is less than <codeclass="docutils literal notranslate"><spanclass="pre">count</span></code>,
<codeclass="docutils literal notranslate"><spanclass="pre">hotRemoveEnabled</span></code> is false, and the virtual machine is not
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vm.hardware_client.</code><codeclass="descname">Disk</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Disk"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Disk</span></code> 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 <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Disk.create"title="com.vmware.vcenter.vm.hardware_client.Disk.create"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Disk.create()</span></code></a> 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 <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Disk.delete"title="com.vmware.vcenter.vm.hardware_client.Disk.delete"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Disk.delete()</span></code></a> method
provides the ability to detach a VMDK file from the virtual machine. The
<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Disk.delete"title="com.vmware.vcenter.vm.hardware_client.Disk.delete"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Disk.delete()</span></code></a> 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.</p>
<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">BackingInfo</code><spanclass="sig-paren">(</span><em>type=None</em>, <em>vmdk_file=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Disk.BackingInfo"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Disk.BackingType"title="com.vmware.vcenter.vm.hardware_client.Disk.BackingType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Disk.BackingType</span></code></a>) – Backing type for the virtual disk.</li>
<li><strong>vmdk_file</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Path of the VMDK file backing the virtual disk.
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_client.Disk.BackingType.VMDK_FILE"title="com.vmware.vcenter.vm.hardware_client.Disk.BackingType.VMDK_FILE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Disk.BackingType.VMDK_FILE</span></code></a>.</li>
<emclass="property">class </em><codeclass="descname">BackingSpec</code><spanclass="sig-paren">(</span><em>type=None</em>, <em>vmdk_file=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Disk.BackingSpec"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Disk.BackingType"title="com.vmware.vcenter.vm.hardware_client.Disk.BackingType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Disk.BackingType</span></code></a>) – Backing type for the virtual disk.</li>
<li><strong>vmdk_file</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Path of the VMDK file backing the virtual disk.
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_client.Disk.BackingType.VMDK_FILE"title="com.vmware.vcenter.vm.hardware_client.Disk.BackingType.VMDK_FILE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Disk.BackingType.VMDK_FILE</span></code></a>.</li>
<emclass="property">class </em><codeclass="descname">BackingType</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Disk.BackingType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Disk.BackingType</span></code> class defines the valid backing types for a
virtual disk.</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">VMDK_FILE</code><emclass="property"> = BackingType(string='VMDK_FILE')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Disk.BackingType.VMDK_FILE"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descname">CreateSpec</code><spanclass="sig-paren">(</span><em>type=None</em>, <em>ide=None</em>, <em>scsi=None</em>, <em>sata=None</em>, <em>backing=None</em>, <em>new_vmdk=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Disk.CreateSpec"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Disk.HostBusAdapterType"title="com.vmware.vcenter.vm.hardware_client.Disk.HostBusAdapterType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Disk.HostBusAdapterType</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Type of host bus adapter to which the device should be attached.
If None, guest-specific default values will be used</li>
<li><strong>ide</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.IdeAddressSpec"title="com.vmware.vcenter.vm.hardware_client.IdeAddressSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">IdeAddressSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – 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.</li>
<li><strong>scsi</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.ScsiAddressSpec"title="com.vmware.vcenter.vm.hardware_client.ScsiAddressSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ScsiAddressSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – 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.</li>
<li><strong>sata</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.SataAddressSpec"title="com.vmware.vcenter.vm.hardware_client.SataAddressSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SataAddressSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – 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.</li>
<li><strong>backing</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Disk.BackingSpec"title="com.vmware.vcenter.vm.hardware_client.Disk.BackingSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Disk.BackingSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Existing physical resource backing for the virtual disk. Exactly
one of <codeclass="docutils literal notranslate"><spanclass="pre">backing</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">newVmdk</span></code> must be specified.
If None, the virtual disk will not be connected to an existing
backing.</li>
<li><strong>new_vmdk</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Disk.VmdkCreateSpec"title="com.vmware.vcenter.vm.hardware_client.Disk.VmdkCreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Disk.VmdkCreateSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specification for creating a new VMDK backing for the virtual disk.
Exactly one of <codeclass="docutils literal notranslate"><spanclass="pre">backing</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">newVmdk</span></code> must be specified.
If None, a new VMDK backing will not be created.</li>
<emclass="property">class </em><codeclass="descname">HostBusAdapterType</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Disk.HostBusAdapterType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Disk.HostBusAdapterType</span></code> class defines the valid types of host bus
adapters that may be used for attaching a virtual storage device to a
virtual machine.</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">IDE</code><emclass="property"> = HostBusAdapterType(string='IDE')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Disk.HostBusAdapterType.IDE"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">SATA</code><emclass="property"> = HostBusAdapterType(string='SATA')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Disk.HostBusAdapterType.SATA"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">SCSI</code><emclass="property"> = HostBusAdapterType(string='SCSI')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Disk.HostBusAdapterType.SCSI"title="Permalink to this definition">¶</a></dt>
<li><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Disk.HostBusAdapterType"title="com.vmware.vcenter.vm.hardware_client.Disk.HostBusAdapterType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Disk.HostBusAdapterType</span></code></a>) – Type of host bus adapter to which the device is attached.</li>
<li><strong>ide</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.IdeAddressInfo"title="com.vmware.vcenter.vm.hardware_client.IdeAddressInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">IdeAddressInfo</span></code></a>) – Address of device attached to a virtual IDE adapter.
Workaround for PR1459646</li>
<li><strong>scsi</strong> (<aclass="reference internal"href="#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">ScsiAddressInfo</span></code></a>) – Address of device attached to a virtual SCSI adapter.
Workaround for PR1459646</li>
<li><strong>sata</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.SataAddressInfo"title="com.vmware.vcenter.vm.hardware_client.SataAddressInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SataAddressInfo</span></code></a>) – Address of device attached to a virtual SATA adapter.
Workaround for PR1459646</li>
<li><strong>backing</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Disk.BackingInfo"title="com.vmware.vcenter.vm.hardware_client.Disk.BackingInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Disk.BackingInfo</span></code></a>) – Physical resource backing for the virtual disk.</li>
<li><strong>capacity</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Capacity of the virtual disk in bytes.
If None, virtual disk is inaccessible or disk capacity is 0.</li>
<codeclass="descname">RESOURCE_TYPE</code><emclass="property"> = 'com.vmware.vcenter.vm.hardware.Disk'</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Disk.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descname">StoragePolicySpec</code><spanclass="sig-paren">(</span><em>policy=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Disk.StoragePolicySpec"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>policy</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the storage policy which should be associated with
the VMDK file. This attribute was added in vSphere API 6.7
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.StoragePolicy</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">Summary</code><spanclass="sig-paren">(</span><em>disk=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Disk.Summary"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descname">UpdateSpec</code><spanclass="sig-paren">(</span><em>backing=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Disk.UpdateSpec"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descname">VmdkCreateSpec</code><spanclass="sig-paren">(</span><em>name=None</em>, <em>capacity=None</em>, <em>storage_policy=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Disk.VmdkCreateSpec"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – 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.</li>
<li><strong>capacity</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Capacity of the virtual disk backing in bytes.
If None, defaults to a guest-specific capacity.</li>
<li><strong>storage_policy</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Disk.StoragePolicySpec"title="com.vmware.vcenter.vm.hardware_client.Disk.StoragePolicySpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Disk.StoragePolicySpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The <codeclass="docutils literal notranslate"><spanclass="pre">Disk.StoragePolicySpec</span></code> class contains information about the
storage policy that is to be associated the with VMDK file. This
attribute was added in vSphere API 6.7
If None the default storage policy of the target datastore (if
applicable) is applied. Currently a default storage policy is only
supported by object based datastores : VVol & vSAN. For non- object
datastores, if None then no storage policy would be associated with
<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_client.Disk.create"title="Permalink to this definition">¶</a></dt>
<dd><p>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
<li><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Disk.CreateSpec"title="com.vmware.vcenter.vm.hardware_client.Disk.CreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Disk.CreateSpec</span></code></a>) – Specification for the new virtual disk.</li>
<codeclass="descname">delete</code><spanclass="sig-paren">(</span><em>vm</em>, <em>disk</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Disk.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>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
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>vm</em>, <em>disk</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Disk.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about a virtual disk.</p>
<codeclass="descname">list</code><spanclass="sig-paren">(</span><em>vm</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Disk.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns commonly used information about the virtual disks belonging to
<codeclass="descname">update</code><spanclass="sig-paren">(</span><em>vm</em>, <em>disk</em>, <em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Disk.update"title="Permalink to this definition">¶</a></dt>
<dd><p>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
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vm.hardware_client.</code><codeclass="descname">Ethernet</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet"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>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType"title="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Ethernet.BackingType</span></code></a>) – Backing type for the virtual Ethernet adapter.</li>
<li><strong>network</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – 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: <codeclass="docutils literal notranslate"><spanclass="pre">Network</span></code>.
When methods return a value of this class as a return value, the
attribute will be an identifier for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">Network</span></code>.
If None, the identifier of the network backing could not be
determined.</li>
<li><strong>network_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the standard portgroup backing the virtual Ethernet
adapter.
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_client.Ethernet.BackingType.STANDARD_PORTGROUP"title="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.STANDARD_PORTGROUP"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Ethernet.BackingType.STANDARD_PORTGROUP</span></code></a>.</li>
<li><strong>host_device</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the device backing the virtual Ethernet adapter.
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_client.Ethernet.BackingType.HOST_DEVICE"title="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.HOST_DEVICE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Ethernet.BackingType.HOST_DEVICE</span></code></a>.</li>
<li><strong>distributed_switch_uuid</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – 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 <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.DISTRIBUTED_PORTGROUP"title="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.DISTRIBUTED_PORTGROUP"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Ethernet.BackingType.DISTRIBUTED_PORTGROUP</span></code></a>.</li>
<li><strong>distributed_port</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – 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.</li>
<li><strong>connection_cookie</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – 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.</li>
<li><strong>opaque_network_type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Type of the opaque network that backs the virtual Ethernet adapter.
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_client.Ethernet.BackingType.OPAQUE_NETWORK"title="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.OPAQUE_NETWORK"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Ethernet.BackingType.OPAQUE_NETWORK</span></code></a>.</li>
<li><strong>opaque_network_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the opaque network that backs the virtual Ethernet
adapter.
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_client.Ethernet.BackingType.OPAQUE_NETWORK"title="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.OPAQUE_NETWORK"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Ethernet.BackingType.OPAQUE_NETWORK</span></code></a>.</li>
<emclass="property">class </em><codeclass="descname">BackingSpec</code><spanclass="sig-paren">(</span><em>type=None</em>, <em>network=None</em>, <em>distributed_port=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingSpec"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType"title="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Ethernet.BackingType</span></code></a>) – Backing type for the virtual Ethernet adapter.</li>
<li><strong>network</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – 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: <codeclass="docutils literal notranslate"><spanclass="pre">Network</span></code>.
When methods return a value of this class as a return value, the
attribute will be an identifier for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">Network</span></code>.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is one of
<li><strong>distributed_port</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – 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
<codeclass="docutils literal notranslate"><spanclass="pre">network</span></code> 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
<emclass="property">class </em><codeclass="descname">BackingType</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Ethernet.BackingType</span></code> class defines the valid backing types for a
virtual Ethernet 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">DISTRIBUTED_PORTGROUP</code><emclass="property"> = BackingType(string='DISTRIBUTED_PORTGROUP')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.DISTRIBUTED_PORTGROUP"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">HOST_DEVICE</code><emclass="property"> = BackingType(string='HOST_DEVICE')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.HOST_DEVICE"title="Permalink to this definition">¶</a></dt>
<dd><p>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.</p>
<codeclass="descname">OPAQUE_NETWORK</code><emclass="property"> = BackingType(string='OPAQUE_NETWORK')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.OPAQUE_NETWORK"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">STANDARD_PORTGROUP</code><emclass="property"> = BackingType(string='STANDARD_PORTGROUP')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.STANDARD_PORTGROUP"title="Permalink to this definition">¶</a></dt>
<dd><p>vSphere standard portgroup network backing.</p>
<li><strong>upt_compatibility_enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating whether Universal Pass-Through (UPT) compatibility
is enabled on this virtual Ethernet adapter.
If None, defaults to false.</li>
<li><strong>mac_type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType"title="com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Ethernet.MacAddressType</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – MAC address type.
If None, defaults to <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType.GENERATED"title="com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType.GENERATED"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Ethernet.MacAddressType.GENERATED</span></code></a>.</li>
<li><strong>mac_address</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – MAC address.
Workaround for PR1459647</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 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.</li>
<li><strong>wake_on_lan_enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating whether wake-on-LAN is enabled on this virtual
Ethernet adapter.
Defaults to false if None.</li>
<li><strong>backing</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingSpec"title="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Ethernet.BackingSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – 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.</li>
<li><strong>start_connected</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating whether the virtual device should be connected
whenever the virtual machine is powered on.
Defaults to false if None.</li>
<li><strong>allow_guest_control</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating whether the guest can connect and disconnect the
<emclass="property">class </em><codeclass="descname">EmulationType</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Ethernet.EmulationType</span></code> class defines the valid emulation types for
a virtual Ethernet 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">E1000</code><emclass="property"> = EmulationType(string='E1000')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType.E1000"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">E1000E</code><emclass="property"> = EmulationType(string='E1000E')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType.E1000E"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">PCNET32</code><emclass="property"> = EmulationType(string='PCNET32')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType.PCNET32"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">VMXNET</code><emclass="property"> = EmulationType(string='VMXNET')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType.VMXNET"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">VMXNET2</code><emclass="property"> = EmulationType(string='VMXNET2')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType.VMXNET2"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">VMXNET3</code><emclass="property"> = EmulationType(string='VMXNET3')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType.VMXNET3"title="Permalink to this definition">¶</a></dt>
<li><strong>mac_address</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – MAC address.
May be None if <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Ethernet.Info.mac_type</span></code> is
<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType.MANUAL"title="com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType.MANUAL"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Ethernet.MacAddressType.MANUAL</span></code></a> and has not been specified,
or if <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Ethernet.Info.mac_type</span></code> is
<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType.GENERATED"title="com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType.GENERATED"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Ethernet.MacAddressType.GENERATED</span></code></a> and the virtual machine
has never been powered on since the Ethernet adapter was created.</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 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.</li>
<li><strong>wake_on_lan_enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag indicating whether wake-on-LAN is enabled on this virtual
Ethernet adapter.</li>
<li><strong>backing</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingInfo"title="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Ethernet.BackingInfo</span></code></a>) – Physical resource backing for the virtual Ethernet adapter.</li>
<li><strong>state</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.ConnectionState"title="com.vmware.vcenter.vm.hardware_client.ConnectionState"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ConnectionState</span></code></a>) – Connection status of the virtual device.</li>
<li><strong>start_connected</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag indicating whether the virtual device should be connected
whenever the virtual machine is powered on.</li>
<li><strong>allow_guest_control</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag indicating whether the guest can connect and disconnect the
<emclass="property">class </em><codeclass="descname">MacAddressType</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Ethernet.MacAddressType</span></code> class defines the valid MAC address origins
for a virtual Ethernet 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">ASSIGNED</code><emclass="property"> = MacAddressType(string='ASSIGNED')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType.ASSIGNED"title="Permalink to this definition">¶</a></dt>
<dd><p>MAC address is assigned by vCenter Server.</p>
<codeclass="descname">GENERATED</code><emclass="property"> = MacAddressType(string='GENERATED')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType.GENERATED"title="Permalink to this definition">¶</a></dt>
<dd><p>MAC address is generated automatically.</p>
<codeclass="descname">MANUAL</code><emclass="property"> = MacAddressType(string='MANUAL')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType.MANUAL"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">RESOURCE_TYPE</code><emclass="property"> = 'com.vmware.vcenter.vm.hardware.Ethernet'</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<dd><p>Resource type for the virtual Ethernet adapter.</p>
<emclass="property">class </em><codeclass="descname">Summary</code><spanclass="sig-paren">(</span><em>nic=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.Summary"title="Permalink to this definition">¶</a></dt>
<p>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
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Ethernet.UpdateSpec.mac_type</span></code> is
<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType.MANUAL"title="com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType.MANUAL"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Ethernet.MacAddressType.MANUAL</span></code></a>. Must be None if the MAC
address type is not <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType.MANUAL"title="com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType.MANUAL"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Ethernet.MacAddressType.MANUAL</span></code></a>.</p>
</li>
<li><strong>wake_on_lan_enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Flag indicating whether wake-on-LAN shoud be enabled on this
virtual Ethernet adapter.</p>
<p>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.</p>
</li>
<li><strong>backing</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingSpec"title="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Ethernet.BackingSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Physical resource backing for the virtual Ethernet adapter.</p>
<p>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.</p>
</li>
<li><strong>start_connected</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating whether the virtual device should be connected
whenever the virtual machine is powered on.
If None, the value is unchanged.</li>
<li><strong>allow_guest_control</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating whether the guest can connect and disconnect the
<codeclass="descname">connect</code><spanclass="sig-paren">(</span><em>vm</em>, <em>nic</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.connect"title="Permalink to this definition">¶</a></dt>
<dd><p>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.</p>
<p>For a powered-off virtual machine, the <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.update"title="com.vmware.vcenter.vm.hardware_client.Ethernet.update"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Ethernet.update()</span></code></a> method
may be used to configure the virtual Ethernet adapter to start in the
connected state when the virtual machine is powered on.</p>
<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_client.Ethernet.create"title="Permalink to this definition">¶</a></dt>
<dd><p>Adds a virtual Ethernet adapter to the virtual machine.</p>
<codeclass="descname">delete</code><spanclass="sig-paren">(</span><em>vm</em>, <em>nic</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Removes a virtual Ethernet adapter from the virtual machine.</p>
<codeclass="descname">disconnect</code><spanclass="sig-paren">(</span><em>vm</em>, <em>nic</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.disconnect"title="Permalink to this definition">¶</a></dt>
<dd><p>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.</p>
<p>For a powered-off virtual machine, the <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.update"title="com.vmware.vcenter.vm.hardware_client.Ethernet.update"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Ethernet.update()</span></code></a> method
may be used to configure the virtual Ethernet adapter to start in the
disconnected state when the virtual machine is powered on.</p>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>vm</em>, <em>nic</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about a virtual Ethernet adapter.</p>
<trclass="field-odd field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first">Information about the specified virtual Ethernet 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_client.Ethernet.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns commonly used information about the virtual Ethernet adapters
<trclass="field-odd field"><thclass="field-name">Returns:</th><tdclass="field-body">List of commonly used information about virtual Ethernet adapters.</td>
<codeclass="descname">update</code><spanclass="sig-paren">(</span><em>vm</em>, <em>nic</em>, <em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Updates the configuration of a virtual Ethernet adapter.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vm.hardware_client.</code><codeclass="descname">Floppy</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Floppy"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">BackingInfo</code><spanclass="sig-paren">(</span><em>type=None</em>, <em>image_file=None</em>, <em>host_device=None</em>, <em>auto_detect=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Floppy.BackingInfo"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Floppy.BackingType"title="com.vmware.vcenter.vm.hardware_client.Floppy.BackingType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Floppy.BackingType</span></code></a>) – Backing type for the virtual floppy drive.</li>
<li><strong>image_file</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Path of the image file backing the virtual floppy drive.
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_client.Floppy.BackingType.IMAGE_FILE"title="com.vmware.vcenter.vm.hardware_client.Floppy.BackingType.IMAGE_FILE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Floppy.BackingType.IMAGE_FILE</span></code></a>.</li>
<li><strong>host_device</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name of the host device backing the virtual floppy drive.
This attribute will be None if <codeclass="docutils literal notranslate"><spanclass="pre">autoDetect</span></code> is true and the
virtual floppy drive is not connected or no suitable device is
available on the host.</li>
<li><strong>auto_detect</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – 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 <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Floppy.BackingType.HOST_DEVICE"title="com.vmware.vcenter.vm.hardware_client.Floppy.BackingType.HOST_DEVICE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Floppy.BackingType.HOST_DEVICE</span></code></a>.</li>
<emclass="property">class </em><codeclass="descname">BackingSpec</code><spanclass="sig-paren">(</span><em>type=None</em>, <em>image_file=None</em>, <em>host_device=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Floppy.BackingSpec"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Floppy.BackingType"title="com.vmware.vcenter.vm.hardware_client.Floppy.BackingType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Floppy.BackingType</span></code></a>) – Backing type for the virtual floppy drive.</li>
<li><strong>image_file</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – 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 <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Floppy.BackingType.IMAGE_FILE"title="com.vmware.vcenter.vm.hardware_client.Floppy.BackingType.IMAGE_FILE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Floppy.BackingType.IMAGE_FILE</span></code></a>.</li>
<li><strong>host_device</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name of the device that should be used as the virtual floppy drive
backing.
If None, the virtual floppy drive will be configured to
<emclass="property">class </em><codeclass="descname">BackingType</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Floppy.BackingType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Floppy.BackingType</span></code> class defines the valid backing types for a
virtual floppy drive.</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">CLIENT_DEVICE</code><emclass="property"> = BackingType(string='CLIENT_DEVICE')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Floppy.BackingType.CLIENT_DEVICE"title="Permalink to this definition">¶</a></dt>
<dd><p>Virtual floppy drive is backed by a device on the client that is connected
<codeclass="descname">HOST_DEVICE</code><emclass="property"> = BackingType(string='HOST_DEVICE')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Floppy.BackingType.HOST_DEVICE"title="Permalink to this definition">¶</a></dt>
<dd><p>Virtual floppy drive is backed by a device on the host where the virtual
<codeclass="descname">IMAGE_FILE</code><emclass="property"> = BackingType(string='IMAGE_FILE')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Floppy.BackingType.IMAGE_FILE"title="Permalink to this definition">¶</a></dt>
<dd><p>Virtual floppy drive is backed by an image file.</p>
<emclass="property">class </em><codeclass="descname">CreateSpec</code><spanclass="sig-paren">(</span><em>backing=None</em>, <em>start_connected=None</em>, <em>allow_guest_control=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Floppy.CreateSpec"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>backing</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Floppy.BackingSpec"title="com.vmware.vcenter.vm.hardware_client.Floppy.BackingSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Floppy.BackingSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Physical resource backing for the virtual floppy drive.
If None, defaults to automatic detection of a suitable host device.</li>
<li><strong>start_connected</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating whether the virtual device should be connected
whenever the virtual machine is powered on.
Defaults to false if None.</li>
<li><strong>allow_guest_control</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating whether the guest can connect and disconnect the
<emclass="property">class </em><codeclass="descname">Info</code><spanclass="sig-paren">(</span><em>label=None</em>, <em>backing=None</em>, <em>state=None</em>, <em>start_connected=None</em>, <em>allow_guest_control=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Floppy.Info"title="Permalink to this definition">¶</a></dt>
<li><strong>backing</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Floppy.BackingInfo"title="com.vmware.vcenter.vm.hardware_client.Floppy.BackingInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Floppy.BackingInfo</span></code></a>) – Physical resource backing for the virtual floppy drive.</li>
<li><strong>state</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.ConnectionState"title="com.vmware.vcenter.vm.hardware_client.ConnectionState"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ConnectionState</span></code></a>) – Connection status of the virtual device.</li>
<li><strong>start_connected</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag indicating whether the virtual device should be connected
whenever the virtual machine is powered on.</li>
<li><strong>allow_guest_control</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag indicating whether the guest can connect and disconnect the
<codeclass="descname">RESOURCE_TYPE</code><emclass="property"> = 'com.vmware.vcenter.vm.hardware.Floppy'</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Floppy.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<dd><p>Resource type for the virtual floppy drive device.</p>
<emclass="property">class </em><codeclass="descname">Summary</code><spanclass="sig-paren">(</span><em>floppy=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Floppy.Summary"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descname">UpdateSpec</code><spanclass="sig-paren">(</span><em>backing=None</em>, <em>start_connected=None</em>, <em>allow_guest_control=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Floppy.UpdateSpec"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>backing</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Floppy.BackingSpec"title="com.vmware.vcenter.vm.hardware_client.Floppy.BackingSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Floppy.BackingSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Physical resource backing for the virtual floppy drive.</p>
<p>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.</p>
</li>
<li><strong>start_connected</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating whether the virtual device should be connected
whenever the virtual machine is powered on.
If None, the value is unchanged.</li>
<li><strong>allow_guest_control</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating whether the guest can connect and disconnect the
<codeclass="descname">connect</code><spanclass="sig-paren">(</span><em>vm</em>, <em>floppy</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Floppy.connect"title="Permalink to this definition">¶</a></dt>
<dd><p>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.</p>
<p>For a powered-off virtual machine, the <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Floppy.update"title="com.vmware.vcenter.vm.hardware_client.Floppy.update"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Floppy.update()</span></code></a> method may
be used to configure the virtual floppy drive to start in the connected
<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_client.Floppy.create"title="Permalink to this definition">¶</a></dt>
<dd><p>Adds a virtual floppy drive to the virtual machine.</p>
<codeclass="descname">delete</code><spanclass="sig-paren">(</span><em>vm</em>, <em>floppy</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Floppy.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Removes a virtual floppy drive from the virtual machine.</p>
<codeclass="descname">disconnect</code><spanclass="sig-paren">(</span><em>vm</em>, <em>floppy</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Floppy.disconnect"title="Permalink to this definition">¶</a></dt>
<dd><p>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.</p>
<p>For a powered-off virtual machine, the <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Floppy.update"title="com.vmware.vcenter.vm.hardware_client.Floppy.update"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Floppy.update()</span></code></a> method may
be used to configure the virtual floppy floppy to start in the
disconnected state when the virtual machine is powered on.</p>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>vm</em>, <em>floppy</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Floppy.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about a virtual floppy drive.</p>
<trclass="field-odd field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first">Information about the specified virtual floppy drive.</p>
<codeclass="descname">list</code><spanclass="sig-paren">(</span><em>vm</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Floppy.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns commonly used information about the virtual floppy drives
<trclass="field-odd field"><thclass="field-name">Returns:</th><tdclass="field-body">List of commonly used information about virtual floppy drives.</td>
<codeclass="descname">update</code><spanclass="sig-paren">(</span><em>vm</em>, <em>floppy</em>, <em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Floppy.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Updates the configuration of a virtual floppy drive.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vm.hardware_client.</code><codeclass="descname">IdeAddressInfo</code><spanclass="sig-paren">(</span><em>primary=None</em>, <em>master=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.IdeAddressInfo"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>primary</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag specifying whether the device is attached to the primary or
secondary IDE adapter of the virtual machine.</li>
<li><strong>master</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag specifying whether the device is the master or slave device on
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vm.hardware_client.</code><codeclass="descname">IdeAddressSpec</code><spanclass="sig-paren">(</span><em>primary=None</em>, <em>master=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.IdeAddressSpec"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>primary</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – 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.</li>
<li><strong>master</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – 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.</li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vm.hardware_client.</code><codeclass="descname">Memory</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Memory"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">Info</code><spanclass="sig-paren">(</span><em>size_mib=None</em>, <em>hot_add_enabled=None</em>, <em>hot_add_increment_size_mib=None</em>, <em>hot_add_limit_mib=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Memory.Info"title="Permalink to this definition">¶</a></dt>
<li><strong>hot_add_enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) –<p>Flag indicating whether adding memory while the virtual machine is
running is enabled.</p>
<p>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.</p>
</li>
<li><strong>hot_add_increment_size_mib</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>The granularity, in mebibytes, at which memory can be added to a
running virtual machine.</p>
<p>When adding memory to a running virtual machine, the amount of
memory added must be at least
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Memory.Info.hot_add_increment_size_mib</span></code> and the total memory
size of the virtual machine must be a multiple of
{\@link>hotAddIncrementSize}.
Only set when <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Memory.Info.hot_add_enabled</span></code> is true and the
virtual machine is running.</p>
</li>
<li><strong>hot_add_limit_mib</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The maximum amount of memory, in mebibytes, that can be added to a
running virtual machine.
Only set when <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Memory.Info.hot_add_enabled</span></code> is true and the
<emclass="property">class </em><codeclass="descname">UpdateSpec</code><spanclass="sig-paren">(</span><em>size_mib=None</em>, <em>hot_add_enabled=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Memory.UpdateSpec"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_client.Memory.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the memory-related settings of a virtual machine.</p>
<codeclass="descname">update</code><spanclass="sig-paren">(</span><em>vm</em>, <em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Memory.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Updates the memory-related settings of a virtual machine.</p>
<li><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Memory.UpdateSpec"title="com.vmware.vcenter.vm.hardware_client.Memory.UpdateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Memory.UpdateSpec</span></code></a>) – Specification for updating the memory-related settings of the
if <codeclass="docutils literal notranslate"><spanclass="pre">sizeMiB</span></code> is specified, <codeclass="docutils literal notranslate"><spanclass="pre">hotAddEnabled</span></code> is false, and the
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vm.hardware_client.</code><codeclass="descname">Parallel</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Parallel"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">BackingInfo</code><spanclass="sig-paren">(</span><em>type=None</em>, <em>file=None</em>, <em>host_device=None</em>, <em>auto_detect=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Parallel.BackingInfo"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Parallel.BackingType"title="com.vmware.vcenter.vm.hardware_client.Parallel.BackingType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Parallel.BackingType</span></code></a>) – Backing type for the virtual parallel port.</li>
<li><strong>file</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Path of the file backing the virtual parallel port.
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_client.Parallel.BackingType.FILE"title="com.vmware.vcenter.vm.hardware_client.Parallel.BackingType.FILE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Parallel.BackingType.FILE</span></code></a>.</li>
<li><strong>host_device</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name of the device backing the virtual parallel port.
This attribute will be None if <codeclass="docutils literal notranslate"><spanclass="pre">autoDetect</span></code> is true and the
virtual parallel port is not connected or no suitable device is
available on the host.</li>
<li><strong>auto_detect</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – 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 <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Parallel.BackingType.HOST_DEVICE"title="com.vmware.vcenter.vm.hardware_client.Parallel.BackingType.HOST_DEVICE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Parallel.BackingType.HOST_DEVICE</span></code></a>.</li>
<emclass="property">class </em><codeclass="descname">BackingSpec</code><spanclass="sig-paren">(</span><em>type=None</em>, <em>file=None</em>, <em>host_device=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Parallel.BackingSpec"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Parallel.BackingType"title="com.vmware.vcenter.vm.hardware_client.Parallel.BackingType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Parallel.BackingType</span></code></a>) – Backing type for the virtual parallel port.</li>
<li><strong>file</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – 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 <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Parallel.BackingType.FILE"title="com.vmware.vcenter.vm.hardware_client.Parallel.BackingType.FILE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Parallel.BackingType.FILE</span></code></a>.</li>
<li><strong>host_device</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name of the device that should be used as the virtual parallel port
backing.
If None, the virtual parallel port will be configured to
<emclass="property">class </em><codeclass="descname">BackingType</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Parallel.BackingType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Parallel.BackingType</span></code> class defines the valid backing types for a
virtual parallel port.</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">FILE</code><emclass="property"> = BackingType(string='FILE')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Parallel.BackingType.FILE"title="Permalink to this definition">¶</a></dt>
<dd><p>Virtual parallel port is backed by a file.</p>
<codeclass="descname">HOST_DEVICE</code><emclass="property"> = BackingType(string='HOST_DEVICE')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Parallel.BackingType.HOST_DEVICE"title="Permalink to this definition">¶</a></dt>
<dd><p>Virtual parallel port is backed by a device on the host where the virtual
<emclass="property">class </em><codeclass="descname">CreateSpec</code><spanclass="sig-paren">(</span><em>backing=None</em>, <em>start_connected=None</em>, <em>allow_guest_control=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Parallel.CreateSpec"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>backing</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Parallel.BackingSpec"title="com.vmware.vcenter.vm.hardware_client.Parallel.BackingSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Parallel.BackingSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Physical resource backing for the virtual parallel port.
If None, defaults to automatic detection of a suitable host device.</li>
<li><strong>start_connected</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating whether the virtual device should be connected
whenever the virtual machine is powered on.
Defaults to false if None.</li>
<li><strong>allow_guest_control</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating whether the guest can connect and disconnect the
<emclass="property">class </em><codeclass="descname">Info</code><spanclass="sig-paren">(</span><em>label=None</em>, <em>backing=None</em>, <em>state=None</em>, <em>start_connected=None</em>, <em>allow_guest_control=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Parallel.Info"title="Permalink to this definition">¶</a></dt>
<li><strong>backing</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Parallel.BackingInfo"title="com.vmware.vcenter.vm.hardware_client.Parallel.BackingInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Parallel.BackingInfo</span></code></a>) – Physical resource backing for the virtual parallel port.</li>
<li><strong>state</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.ConnectionState"title="com.vmware.vcenter.vm.hardware_client.ConnectionState"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ConnectionState</span></code></a>) – Connection status of the virtual device.</li>
<li><strong>start_connected</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag indicating whether the virtual device should be connected
whenever the virtual machine is powered on.</li>
<li><strong>allow_guest_control</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag indicating whether the guest can connect and disconnect the
<codeclass="descname">RESOURCE_TYPE</code><emclass="property"> = 'com.vmware.vcenter.vm.hardware.ParallelPort'</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Parallel.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<dd><p>Resource type for the virtual parallel port.</p>
<emclass="property">class </em><codeclass="descname">Summary</code><spanclass="sig-paren">(</span><em>port=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Parallel.Summary"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descname">UpdateSpec</code><spanclass="sig-paren">(</span><em>backing=None</em>, <em>start_connected=None</em>, <em>allow_guest_control=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Parallel.UpdateSpec"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>backing</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Parallel.BackingSpec"title="com.vmware.vcenter.vm.hardware_client.Parallel.BackingSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Parallel.BackingSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Physical resource backing for the virtual parallel port.</p>
<p>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.</p>
</li>
<li><strong>start_connected</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating whether the virtual device should be connected
whenever the virtual machine is powered on.
If None, the value is unchanged.</li>
<li><strong>allow_guest_control</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating whether the guest can connect and disconnect the
<codeclass="descname">connect</code><spanclass="sig-paren">(</span><em>vm</em>, <em>port</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Parallel.connect"title="Permalink to this definition">¶</a></dt>
<dd><p>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.</p>
<p>For a powered-off virtual machine, the <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Parallel.update"title="com.vmware.vcenter.vm.hardware_client.Parallel.update"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Parallel.update()</span></code></a> method
may be used to configure the virtual parallel port to start in the
connected state when the virtual machine is powered on.</p>
<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_client.Parallel.create"title="Permalink to this definition">¶</a></dt>
<dd><p>Adds a virtual parallel port to the virtual machine.</p>
<codeclass="descname">delete</code><spanclass="sig-paren">(</span><em>vm</em>, <em>port</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Parallel.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Removes a virtual parallel port from the virtual machine.</p>
<codeclass="descname">disconnect</code><spanclass="sig-paren">(</span><em>vm</em>, <em>port</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Parallel.disconnect"title="Permalink to this definition">¶</a></dt>
<dd><p>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.</p>
<p>For a powered-off virtual machine, the <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Parallel.update"title="com.vmware.vcenter.vm.hardware_client.Parallel.update"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Parallel.update()</span></code></a> method
may be used to configure the virtual parallel port to start in the
disconnected state when the virtual machine is powered on.</p>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>vm</em>, <em>port</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Parallel.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about a virtual parallel port.</p>
<trclass="field-odd field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first">Information about the specified virtual parallel port.</p>
<codeclass="descname">list</code><spanclass="sig-paren">(</span><em>vm</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Parallel.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns commonly used information about the virtual parallel ports
<trclass="field-odd field"><thclass="field-name">Returns:</th><tdclass="field-body">List of commonly used information about virtual parallel ports.</td>
<codeclass="descname">update</code><spanclass="sig-paren">(</span><em>vm</em>, <em>port</em>, <em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Parallel.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Updates the configuration of a virtual parallel port.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vm.hardware_client.</code><codeclass="descname">SataAddressInfo</code><spanclass="sig-paren">(</span><em>bus=None</em>, <em>unit=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.SataAddressInfo"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>bus</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Bus number of the adapter to which the device is attached.</li>
<li><strong>unit</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Unit number of the device.</li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vm.hardware_client.</code><codeclass="descname">SataAddressSpec</code><spanclass="sig-paren">(</span><em>bus=None</em>, <em>unit=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.SataAddressSpec"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>bus</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Bus number of the adapter to which the device should be attached.</li>
<li><strong>unit</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – 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
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vm.hardware_client.</code><codeclass="descname">ScsiAddressInfo</code><spanclass="sig-paren">(</span><em>bus=None</em>, <em>unit=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.ScsiAddressInfo"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>bus</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Bus number of the adapter to which the device is attached.</li>
<li><strong>unit</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Unit number of the device.</li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vm.hardware_client.</code><codeclass="descname">ScsiAddressSpec</code><spanclass="sig-paren">(</span><em>bus=None</em>, <em>unit=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.ScsiAddressSpec"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>bus</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Bus number of the adapter to which the device should be attached.</li>
<li><strong>unit</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – 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
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vm.hardware_client.</code><codeclass="descname">Serial</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Serial"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>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType"title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Serial.BackingType</span></code></a>) – Backing type for the virtual serial port.</li>
<li><strong>file</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Path of the file backing the virtual serial port.
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_client.Serial.BackingType.FILE"title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.FILE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Serial.BackingType.FILE</span></code></a>.</li>
<li><strong>host_device</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name of the device backing the virtual serial port.
This attribute will be None if <codeclass="docutils literal notranslate"><spanclass="pre">autoDetect</span></code> is true and the
virtual serial port is not connected or no suitable device is
available on the host.</li>
<li><strong>auto_detect</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – 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 <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.HOST_DEVICE"title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.HOST_DEVICE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Serial.BackingType.HOST_DEVICE</span></code></a>.</li>
<li><strong>pipe</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the pipe backing the virtual serial port.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is one of <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.PIPE_SERVER"title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.PIPE_SERVER"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Serial.BackingType.PIPE_SERVER</span></code></a> or
<li><strong>no_rx_loss</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – 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 <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is one of <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.PIPE_SERVER"title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.PIPE_SERVER"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Serial.BackingType.PIPE_SERVER</span></code></a> or
<li><strong>network_location</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) –<p>URI specifying the location of the network service backing the
virtual serial port.</p>
<ul>
<li>If <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Serial.BackingInfo.type</span></code> is
<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_SERVER"title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_SERVER"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Serial.BackingType.NETWORK_SERVER</span></code></a>, 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.</li>
<li>If <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Serial.BackingInfo.type</span></code> is
<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_CLIENT"title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_CLIENT"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Serial.BackingType.NETWORK_CLIENT</span></code></a>, this attribute is the
location used by the virtual machine to connect to the remote
server.</li>
</ul>
<p>This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is one of <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_SERVER"title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_SERVER"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Serial.BackingType.NETWORK_SERVER</span></code></a> or
<li><strong>proxy</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Proxy service that provides network access to the network backing.
If set, the virtual machine initiates a connection with the proxy
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType"title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Serial.BackingType</span></code></a>) – Backing type for the virtual serial port.</li>
<li><strong>file</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Path of the file backing the virtual serial port.
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_client.Serial.BackingType.FILE"title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.FILE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Serial.BackingType.FILE</span></code></a>.</li>
<li><strong>host_device</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – 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.</li>
<li><strong>pipe</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the pipe backing the virtual serial port.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is one of <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.PIPE_SERVER"title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.PIPE_SERVER"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Serial.BackingType.PIPE_SERVER</span></code></a> or
<li><strong>no_rx_loss</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – 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.</li>
<li><strong>network_location</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) –<p>URI specifying the location of the network service backing the
virtual serial port.</p>
<ul>
<li>If <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Serial.BackingSpec.type</span></code> is
<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_SERVER"title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_SERVER"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Serial.BackingType.NETWORK_SERVER</span></code></a>, 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.</li>
<li>If <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Serial.BackingSpec.type</span></code> is
<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_CLIENT"title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_CLIENT"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Serial.BackingType.NETWORK_CLIENT</span></code></a>, this attribute is the
location used by the virtual machine to connect to the remote
server.</li>
</ul>
<p>This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is one of <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_SERVER"title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_SERVER"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Serial.BackingType.NETWORK_SERVER</span></code></a> or
<li><strong>proxy</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Proxy service that provides network access to the network backing.
If set, the virtual machine initiates a connection with the proxy
<emclass="property">class </em><codeclass="descname">BackingType</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Serial.BackingType</span></code> class defines the valid backing types for a
virtual serial port.</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">FILE</code><emclass="property"> = BackingType(string='FILE')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.FILE"title="Permalink to this definition">¶</a></dt>
<dd><p>Virtual serial port is backed by a file.</p>
<codeclass="descname">HOST_DEVICE</code><emclass="property"> = BackingType(string='HOST_DEVICE')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.HOST_DEVICE"title="Permalink to this definition">¶</a></dt>
<dd><p>Virtual serial port is backed by a device on the host where the virtual
<codeclass="descname">NETWORK_CLIENT</code><emclass="property"> = BackingType(string='NETWORK_CLIENT')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_CLIENT"title="Permalink to this definition">¶</a></dt>
<dd><p>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,
<codeclass="descname">NETWORK_SERVER</code><emclass="property"> = BackingType(string='NETWORK_SERVER')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_SERVER"title="Permalink to this definition">¶</a></dt>
<dd><p>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,
<codeclass="descname">PIPE_CLIENT</code><emclass="property"> = BackingType(string='PIPE_CLIENT')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.PIPE_CLIENT"title="Permalink to this definition">¶</a></dt>
<dd><p>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.</p>
<codeclass="descname">PIPE_SERVER</code><emclass="property"> = BackingType(string='PIPE_SERVER')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.PIPE_SERVER"title="Permalink to this definition">¶</a></dt>
<dd><p>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
<emclass="property">class </em><codeclass="descname">CreateSpec</code><spanclass="sig-paren">(</span><em>yield_on_poll=None</em>, <em>backing=None</em>, <em>start_connected=None</em>, <em>allow_guest_control=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Serial.CreateSpec"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>yield_on_poll</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – 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.</li>
<li><strong>backing</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingSpec"title="com.vmware.vcenter.vm.hardware_client.Serial.BackingSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Serial.BackingSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Physical resource backing for the virtual serial port.
If None, defaults to automatic detection of a suitable host device.</li>
<li><strong>start_connected</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating whether the virtual device should be connected
whenever the virtual machine is powered on.
Defaults to false if None.</li>
<li><strong>allow_guest_control</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating whether the guest can connect and disconnect the
<emclass="property">class </em><codeclass="descname">Info</code><spanclass="sig-paren">(</span><em>label=None</em>, <em>yield_on_poll=None</em>, <em>backing=None</em>, <em>state=None</em>, <em>start_connected=None</em>, <em>allow_guest_control=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Serial.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Serial.Info</span></code> class contains information about a virtual serial port.</p>
<divclass="admonition tip">
<pclass="first admonition-title">Tip</p>
<pclass="last">The arguments are used to initialize data attributes with the same
<li><strong>yield_on_poll</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – 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.</li>
<li><strong>backing</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingInfo"title="com.vmware.vcenter.vm.hardware_client.Serial.BackingInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Serial.BackingInfo</span></code></a>) – Physical resource backing for the virtual serial port.</li>
<li><strong>state</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.ConnectionState"title="com.vmware.vcenter.vm.hardware_client.ConnectionState"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ConnectionState</span></code></a>) – Connection status of the virtual device.</li>
<li><strong>start_connected</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag indicating whether the virtual device should be connected
whenever the virtual machine is powered on.</li>
<li><strong>allow_guest_control</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag indicating whether the guest can connect and disconnect the
<codeclass="descname">RESOURCE_TYPE</code><emclass="property"> = 'com.vmware.vcenter.vm.hardware.SerialPort'</em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Serial.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<dd><p>Resource type for the virtual serial port device.</p>
<emclass="property">class </em><codeclass="descname">Summary</code><spanclass="sig-paren">(</span><em>port=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Serial.Summary"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>port</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – 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:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vm.hardware.SerialPort</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">UpdateSpec</code><spanclass="sig-paren">(</span><em>yield_on_poll=None</em>, <em>backing=None</em>, <em>start_connected=None</em>, <em>allow_guest_control=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Serial.UpdateSpec"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>yield_on_poll</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>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.</p>
<p>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.</p>
</li>
<li><strong>backing</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingSpec"title="com.vmware.vcenter.vm.hardware_client.Serial.BackingSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Serial.BackingSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Physical resource backing for the virtual serial port.</p>
<p>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.</p>
</li>
<li><strong>start_connected</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating whether the virtual device should be connected
whenever the virtual machine is powered on.
If None, the value is unchanged.</li>
<li><strong>allow_guest_control</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating whether the guest can connect and disconnect the
<codeclass="descname">connect</code><spanclass="sig-paren">(</span><em>vm</em>, <em>port</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Serial.connect"title="Permalink to this definition">¶</a></dt>
<dd><p>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.</p>
<p>For a powered-off virtual machine, the <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Serial.update"title="com.vmware.vcenter.vm.hardware_client.Serial.update"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Serial.update()</span></code></a> method may
be used to configure the virtual serial port to start in the connected
<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_client.Serial.create"title="Permalink to this definition">¶</a></dt>
<dd><p>Adds a virtual serial port to the virtual machine.</p>
<li><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Serial.CreateSpec"title="com.vmware.vcenter.vm.hardware_client.Serial.CreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Serial.CreateSpec</span></code></a>) – Specification for the new virtual serial port.</li>
<codeclass="descname">delete</code><spanclass="sig-paren">(</span><em>vm</em>, <em>port</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Serial.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Removes a virtual serial port from the virtual machine.</p>
<codeclass="descname">disconnect</code><spanclass="sig-paren">(</span><em>vm</em>, <em>port</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Serial.disconnect"title="Permalink to this definition">¶</a></dt>
<dd><p>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.</p>
<p>For a powered-off virtual machine, the <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Serial.update"title="com.vmware.vcenter.vm.hardware_client.Serial.update"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Serial.update()</span></code></a> method may
be used to configure the virtual serial port to start in the
disconnected state when the virtual machine is powered on.</p>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>vm</em>, <em>port</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Serial.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about a virtual serial port.</p>
<trclass="field-odd field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first">Information about the specified virtual serial port.</p>
<codeclass="descname">list</code><spanclass="sig-paren">(</span><em>vm</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Serial.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns commonly used information about the virtual serial ports
<codeclass="descname">update</code><spanclass="sig-paren">(</span><em>vm</em>, <em>port</em>, <em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Serial.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Updates the configuration of a virtual serial port.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vm.hardware_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_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-vcenter-vm-storage-client-module"></span><h2>com.vmware.vcenter.vm.storage_client module<aclass="headerlink"href="#module-com.vmware.vcenter.vm.storage_client"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vm.storage_client.</code><codeclass="descname">Policy</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.storage_client.Policy"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">DiskPolicySpec</code><spanclass="sig-paren">(</span><em>type=None</em>, <em>policy=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.storage_client.Policy.DiskPolicySpec"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.storage_client.Policy.DiskPolicySpec.PolicyType"title="com.vmware.vcenter.vm.storage_client.Policy.DiskPolicySpec.PolicyType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Policy.DiskPolicySpec.PolicyType</span></code></a>) – Policy type to be used while performing update operation on the
virtual disks. This attribute was added in vSphere API 6.7</li>
<li><strong>policy</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Storage Policy identification. This attribute was added in vSphere
API 6.7
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.StoragePolicy</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">PolicyType</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.storage_client.Policy.DiskPolicySpec.PolicyType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Policy.DiskPolicySpec</span></code> class defines the choices for how to specify
the policy to be associated with a virtual disk. This enumeration was added
in vSphere API 6.7</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">USE_DEFAULT_POLICY</code><emclass="property"> = PolicyType(string='USE_DEFAULT_POLICY')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.storage_client.Policy.DiskPolicySpec.PolicyType.USE_DEFAULT_POLICY"title="Permalink to this definition">¶</a></dt>
<dd><p>Use the default storage policy of the datastore. This class attribute was
<codeclass="descname">USE_SPECIFIED_POLICY</code><emclass="property"> = PolicyType(string='USE_SPECIFIED_POLICY')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.storage_client.Policy.DiskPolicySpec.PolicyType.USE_SPECIFIED_POLICY"title="Permalink to this definition">¶</a></dt>
<dd><p>Use the specified policy (see <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Policy.DiskPolicySpec.policy</span></code>). This
<emclass="property">class </em><codeclass="descname">Info</code><spanclass="sig-paren">(</span><em>vm_home=None</em>, <em>disks=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.storage_client.Policy.Info"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descname">UpdateSpec</code><spanclass="sig-paren">(</span><em>vm_home=None</em>, <em>disks=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.storage_client.Policy.UpdateSpec"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>vm_home</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.storage_client.Policy.VmHomePolicySpec"title="com.vmware.vcenter.vm.storage_client.Policy.VmHomePolicySpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Policy.VmHomePolicySpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Storage policy to be used when reconfiguring the virtual machine
home. This attribute was added in vSphere API 6.7
if None the current storage policy is retained.</li>
<li><strong>disks</strong> ((<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.vcenter.vm.storage_client.Policy.DiskPolicySpec"title="com.vmware.vcenter.vm.storage_client.Policy.DiskPolicySpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Policy.DiskPolicySpec</span></code></a>) or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Storage policy or policies to be used when reconfiguring virtual
machine diks. This attribute was added in vSphere API 6.7
When clients pass a value of this class as a parameter, the key in
the attribute <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> must be an identifier 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 key in the attribute
<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> will be an identifier for the resource type:
<emclass="property">class </em><codeclass="descname">VmHomePolicySpec</code><spanclass="sig-paren">(</span><em>type=None</em>, <em>policy=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.storage_client.Policy.VmHomePolicySpec"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.storage_client.Policy.VmHomePolicySpec.PolicyType"title="com.vmware.vcenter.vm.storage_client.Policy.VmHomePolicySpec.PolicyType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Policy.VmHomePolicySpec.PolicyType</span></code></a>) – Policy type to be used while performing update operation on the
virtual machine home’s directory. This attribute was added in
vSphere API 6.7</li>
<li><strong>policy</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Storage Policy identification. This attribute was added in vSphere
API 6.7
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.StoragePolicy</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">PolicyType</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.storage_client.Policy.VmHomePolicySpec.PolicyType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Policy.VmHomePolicySpec.PolicyType</span></code> class defines the choices for
how to specify the policy to be associated with the virtual machine home’s
directory. This enumeration was added in vSphere API 6.7</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">USE_DEFAULT_POLICY</code><emclass="property"> = PolicyType(string='USE_DEFAULT_POLICY')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.storage_client.Policy.VmHomePolicySpec.PolicyType.USE_DEFAULT_POLICY"title="Permalink to this definition">¶</a></dt>
<dd><p>Use the default storage policy of the datastore. This class attribute was
<codeclass="descname">USE_SPECIFIED_POLICY</code><emclass="property"> = PolicyType(string='USE_SPECIFIED_POLICY')</em><aclass="headerlink"href="#com.vmware.vcenter.vm.storage_client.Policy.VmHomePolicySpec.PolicyType.USE_SPECIFIED_POLICY"title="Permalink to this definition">¶</a></dt>
<dd><p>Use the specified policy (see <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Policy.VmHomePolicySpec.policy</span></code>). This
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>vm</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.storage_client.Policy.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns Information about Storage Policy associated with a virtual
machine’s home directory and/or its virtual hard disks. This method was
<trclass="field-odd field"><thclass="field-name">Returns:</th><tdclass="field-body">Overview of Storage Policy associated with a virtual machine’s home
directory and/or its associated virtual hard disks.</td>
<codeclass="descname">update</code><spanclass="sig-paren">(</span><em>vm</em>, <em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.storage_client.Policy.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Updates the storage policy configuration of a virtual machine and/or
its associated virtual hard disks. This method was added in vSphere API
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.vm.storage_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.storage_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>.
