<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
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vcenter.vm.compute_client.</code><codeclass="sig-name descname">Policies</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.compute_client.Policies"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><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.</p>
<emclass="property">class </em><codeclass="sig-name descname">Info</code><spanclass="sig-paren">(</span><emclass="sig-param">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>
<ddclass="field-odd"><p><strong>status</strong> (<aclass="reference internal"href="com.vmware.vcenter.compute.html#com.vmware.vcenter.compute.policies_client.ObjectCompliance"title="com.vmware.vcenter.compute.policies_client.ObjectCompliance"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.compute.policies_client.ObjectCompliance</span></code></a>) – The compliance status of the policy on a specified
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em>, <emclass="sig-param">policy</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.compute_client.Policies.get"title="Permalink to this definition">¶</a></dt>
<li><p><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.
<li><p><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.
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vcenter.vm.compute_client.</code><codeclass="sig-name descname">StubFactory</code><spanclass="sig-paren">(</span><emclass="sig-param">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="sig-prename descclassname">com.vmware.vcenter.vm.guest_client.</code><codeclass="sig-name descname">Customization</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Customization"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Customization</span></code> class provides methods to apply a customization
specification to a virtual machine. This class was added in vSphere API
7.0.0.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><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.</p>
<emclass="property">class </em><codeclass="sig-name descname">SetSpec</code><spanclass="sig-paren">(</span><emclass="sig-param">name=None</em>, <emclass="sig-param">spec=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Customization.SetSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Customization.SetSpec</span></code> class contains specification information that
has to be applied to a virtual machine. This class was added in vSphere API
7.0.0.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><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>) – The name of the customization specification that has be retrieved
from the virtual center inventory and applied for the virtual
machine. Either one of <codeclass="docutils literal notranslate"><spanclass="pre">name</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">spec</span></code> or none of them should
be specified. This attribute was added in vSphere API 7.0.0.
If None and <codeclass="docutils literal notranslate"><spanclass="pre">spec</span></code> is also None when executing
<aclass="reference internal"href="#com.vmware.vcenter.vm.guest_client.Customization.set"title="com.vmware.vcenter.vm.guest_client.Customization.set"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Customization.set()</span></code></a> operationg, then any pending
customization for the virtual machine will be cleared.</p></li>
<li><p><strong>spec</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.guest_client.CustomizationSpec"title="com.vmware.vcenter.guest_client.CustomizationSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.guest_client.CustomizationSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The customization specification that has to be applied for the
virtual machine. Either one of <codeclass="docutils literal notranslate"><spanclass="pre">name</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">spec</span></code> or none of them
should be specified. This attribute was added in vSphere API 7.0.0.
If None and <codeclass="docutils literal notranslate"><spanclass="pre">name</span></code> is also None when executing
<aclass="reference internal"href="#com.vmware.vcenter.vm.guest_client.Customization.set"title="com.vmware.vcenter.vm.guest_client.Customization.set"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Customization.set()</span></code></a> operationg, then any pending
customization for the virtual machine will be cleared.</p></li>
<codeclass="sig-name descname">set</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em>, <emclass="sig-param">spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Customization.set"title="Permalink to this definition">¶</a></dt>
<dd><p>Applies a customization specification in <codeclass="docutils literal notranslate"><spanclass="pre">spec</span></code> on the virtual
machine in <codeclass="docutils literal notranslate"><spanclass="pre">vm</span></code>. This method only sets the specification settings for
the virtual machine. The actual customization happens inside the guest
when the virtual machine is powered on. If <codeclass="docutils literal notranslate"><spanclass="pre">spec</span></code> has None values,
then any pending customization settings for the virtual machine are
cleared. If there is a pending customization for the virtual machine
and <codeclass="docutils literal notranslate"><spanclass="pre">spec</span></code> has valid content, then the existing customization setting
will be overwritten with the new settings. This method was added in
vSphere API 7.0.0.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>vm</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The unique identifier of the virtual machine that needs to be
customized.
The parameter must be an identifier for the resource type:
<li><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.guest_client.Customization.SetSpec"title="com.vmware.vcenter.vm.guest_client.Customization.SetSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Customization.SetSpec</span></code></a>) – The customization settings to be applied to the guest operating
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vcenter.vm.guest_client.</code><codeclass="sig-name descname">DhcpConfigInfo</code><spanclass="sig-paren">(</span><emclass="sig-param">ipv4_enabled=None</em>, <emclass="sig-param">ipv6_enabled=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.DhcpConfigInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">DhcpConfigInfo</span></code> class specifies when Dynamic Host Configuration
Protocol is enabled. This class was added in vSphere API 7.0.0.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>ipv4_enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – True if IPv4 DHCP is enabled, false otherwise. This attribute was
added in vSphere API 7.0.0.</p></li>
<li><p><strong>ipv6_enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – True if IPv6 DHCP is enabled, false otherwise. This attribute was
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vcenter.vm.guest_client.</code><codeclass="sig-name descname">DnsAssignedValues</code><spanclass="sig-paren">(</span><emclass="sig-param">host_name=None</em>, <emclass="sig-param">domain_name=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.DnsAssignedValues"title="Permalink to this definition">¶</a></dt>
<p>The {\@name DnsAssignedValues) class describes values assigned by a
Domain Name Server (DNS). This class was added in vSphere API 7.0.0.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>host_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The host name portion of DNS name. For example, “esx01” part of
esx01.example.com. This attribute was added in vSphere API 7.0.0.</p></li>
<li><p><strong>domain_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The domain name portion of the DNS name. “example.com” part of
esx01.example.com. This attribute was added in vSphere API 7.0.0.</p></li>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vcenter.vm.guest_client.</code><codeclass="sig-name descname">DnsConfigInfo</code><spanclass="sig-paren">(</span><emclass="sig-param">ip_addresses=None</em>, <emclass="sig-param">search_domains=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.DnsConfigInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">DnsConfigInfo</span></code> class describes the configuration of RFC 1034 DNS
settings. This class was added in vSphere API 7.0.0.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>ip_addresses</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The IP addresses of the DNS servers in order of use. IPv4 addresses
are specified using dotted decimal notation. For example,
“192.0.2.1”. IPv6 addresses are 128-bit addresses represented as
eight fields of up to four hexadecimal digits. A colon separates
each field (:). For example, 2001:DB8:101::230:6eff:fe04:d9ff. The
address can also consist of the symbol ‘::’ to represent multiple
16-bit groups of contiguous 0’s only once in an address as
described in RFC 2373. This attribute was added in vSphere API
7.0.0.</p></li>
<li><p><strong>search_domains</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The domain in which to search for hosts, placed in order of
preference. These are the domain name portion of the DNS names.
This attribute was added in vSphere API 7.0.0.</p></li>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vcenter.vm.guest_client.</code><codeclass="sig-name descname">Identity</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Identity"title="Permalink to this definition">¶</a></dt>
system identification information. This class was added in vSphere API 6.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><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.</p>
<emclass="property">class </em><codeclass="sig-name descname">Info</code><spanclass="sig-paren">(</span><emclass="sig-param">name=None</em>, <emclass="sig-param">family=None</em>, <emclass="sig-param">full_name=None</em>, <emclass="sig-param">host_name=None</em>, <emclass="sig-param">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>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Identity.get"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vcenter.vm.guest_client.</code><codeclass="sig-name descname">LocalFilesystem</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.LocalFilesystem"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><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.</p>
<emclass="property">class </em><codeclass="sig-name descname">Info</code><spanclass="sig-paren">(</span><emclass="sig-param">capacity=None</em>, <emclass="sig-param">free_space=None</em>, <emclass="sig-param">filesystem=None</em>, <emclass="sig-param">mappings=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.LocalFilesystem.Info"title="Permalink to this definition">¶</a></dt>
<li><p><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.</p></li>
<li><p><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
<li><p><strong>filesystem</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Filesystem type, if known. For example, ext3 or NTFS. This
attribute was added in vSphere API 7.0.0.
<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> if VMware Tools reports a value.</p></li>
<li><p><strong>mappings</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.vm.guest_client.LocalFilesystem.VirtualDiskMapping"title="com.vmware.vcenter.vm.guest_client.LocalFilesystem.VirtualDiskMapping"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LocalFilesystem.VirtualDiskMapping</span></code></a>) – VirtualDisks backing the guest partition, if known. This attribute
was added in vSphere API 7.0.0.
This attribute is optional because it was added in a newer version
<emclass="property">class </em><codeclass="sig-name descname">VirtualDiskMapping</code><spanclass="sig-paren">(</span><emclass="sig-param">disk=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.LocalFilesystem.VirtualDiskMapping"title="Permalink to this definition">¶</a></dt>
<p>Describes the virtual disk backing a local guest disk. This class was added
in vSphere API 7.0.0.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>disk</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The virtual disk. This attribute was added in vSphere API 7.0.0.
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.Disk</span></code>. When methods return a
value of this class as a return value, the attribute will be an
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.LocalFilesystem.get"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vcenter.vm.guest_client.</code><codeclass="sig-name descname">Networking</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Networking"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Networking</span></code> class provides methods for retrieving guest operating
system network information. This class was added in vSphere API 7.0.0.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><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.</p>
<emclass="property">class </em><codeclass="sig-name descname">Info</code><spanclass="sig-paren">(</span><emclass="sig-param">dns_values=None</em>, <emclass="sig-param">dns=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Networking.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Networking.Info</span></code> class contains information about networking as
configured in the guest operating system. This class was added in vSphere
API 7.0.0.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>dns_values</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.guest_client.DnsAssignedValues"title="com.vmware.vcenter.vm.guest_client.DnsAssignedValues"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DnsAssignedValues</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Client DNS values. Data assigned by DNS. This attribute was added
in vSphere API 7.0.0.
If None no DNS assigned value exists.</p></li>
<li><p><strong>dns</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.guest_client.DnsConfigInfo"title="com.vmware.vcenter.vm.guest_client.DnsConfigInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DnsConfigInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Client DNS configuration. How DNS queries are resolved. This
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Networking.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about the network configuration in the guest
operating system. This method was added in vSphere API 7.0.0.</p>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vcenter.vm.guest_client.</code><codeclass="sig-name descname">Power</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Power"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><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.</p>
<emclass="property">class </em><codeclass="sig-name descname">Info</code><spanclass="sig-paren">(</span><emclass="sig-param">state=None</em>, <emclass="sig-param">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>
<li><p><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.</p></li>
<li><p><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.</p></li>
<emclass="property">class </em><codeclass="sig-name descname">State</code><spanclass="sig-paren">(</span><emclass="sig-param">string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Power.State"title="Permalink to this definition">¶</a></dt>
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="sig-name 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>
<codeclass="sig-name 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>
<codeclass="sig-name 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>
<codeclass="sig-name 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>
<codeclass="sig-name 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>
<codeclass="sig-name 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>
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Power.get"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">reboot</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Power.reboot"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">shutdown</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Power.shutdown"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">standby</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Power.standby"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vcenter.vm.guest_client.</code><codeclass="sig-name descname">StubFactory</code><spanclass="sig-paren">(</span><emclass="sig-param">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="sig-prename descclassname">com.vmware.vcenter.vm.hardware_client.</code><codeclass="sig-name descname">Boot</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Boot"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><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.</p>
<li><p><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.
is supported for the virtual hardware version.</p></li>
<li><p><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
If None, defaults to a system defined default value.</p></li>
<li><p><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
<li><p><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
<li><p><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
<li><p><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
<li><p><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.</p></li>
<li><p><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.
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>.</p></li>
<li><p><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
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>.</p></li>
<li><p><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
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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
<emclass="property">class </em><codeclass="sig-name descname">NetworkProtocol</code><spanclass="sig-paren">(</span><emclass="sig-param">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>
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="sig-name 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="sig-name 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="sig-name descname">Type</code><spanclass="sig-paren">(</span><emclass="sig-param">string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Boot.Type"title="Permalink to this definition">¶</a></dt>
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="sig-name 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>
<codeclass="sig-name 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>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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
<li><p><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
<li><p><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
<li><p><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
<li><p><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
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Boot.get"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">update</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em>, <emclass="sig-param">spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Boot.update"title="Permalink to this definition">¶</a></dt>
<li><p><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="sig-prename descclassname">com.vmware.vcenter.vm.hardware_client.</code><codeclass="sig-name descname">Cdrom</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><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.</p>
<emclass="property">class </em><codeclass="sig-name descname">BackingInfo</code><spanclass="sig-paren">(</span><emclass="sig-param">type=None</em>, <emclass="sig-param">iso_file=None</em>, <emclass="sig-param">host_device=None</em>, <emclass="sig-param">auto_detect=None</em>, <emclass="sig-param">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>
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>.</p></li>
<li><p><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.
<li><p><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
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>.</p></li>
<li><p><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="sig-name descname">BackingSpec</code><spanclass="sig-paren">(</span><emclass="sig-param">type=None</em>, <emclass="sig-param">iso_file=None</em>, <emclass="sig-param">host_device=None</em>, <emclass="sig-param">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>
<li><p><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.</p></li>
<li><p><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
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>.</p></li>
<li><p><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
automatically detect a suitable host device.</p></li>
<li><p><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>.</p></li>
<emclass="property">class </em><codeclass="sig-name descname">BackingType</code><spanclass="sig-paren">(</span><emclass="sig-param">string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType"title="Permalink to this definition">¶</a></dt>
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="sig-name 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>
<codeclass="sig-name 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>
<codeclass="sig-name 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>
<li><p><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</p></li>
<li><p><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.
<li><p><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.
<li><p><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.</p></li>
<li><p><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
<li><p><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="sig-name descname">DeviceAccessType</code><spanclass="sig-paren">(</span><emclass="sig-param">string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.DeviceAccessType"title="Permalink to this definition">¶</a></dt>
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="sig-name 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="sig-name 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="sig-name 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>
<emclass="property">class </em><codeclass="sig-name descname">HostBusAdapterType</code><spanclass="sig-paren">(</span><emclass="sig-param">string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.HostBusAdapterType"title="Permalink to this definition">¶</a></dt>
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="sig-name 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="sig-name 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>
<li><p><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.</p></li>
<li><p><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.
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>.</p></li>
<li><p><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.
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>.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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="sig-name 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>
<emclass="property">class </em><codeclass="sig-name descname">Summary</code><spanclass="sig-paren">(</span><emclass="sig-param">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="sig-name descname">UpdateSpec</code><spanclass="sig-paren">(</span><emclass="sig-param">backing=None</em>, <emclass="sig-param">start_connected=None</em>, <emclass="sig-param">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>
<li><p><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
<li><p><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="sig-name descname">connect</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em>, <emclass="sig-param">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="sig-name descname">create</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em>, <emclass="sig-param">spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.create"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">delete</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em>, <emclass="sig-param">cdrom</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.delete"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">disconnect</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em>, <emclass="sig-param">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="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em>, <emclass="sig-param">cdrom</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.get"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">list</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.list"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">update</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em>, <emclass="sig-param">cdrom</em>, <emclass="sig-param">spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.update"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vcenter.vm.hardware_client.</code><codeclass="sig-name descname">ConnectionCreateSpec</code><spanclass="sig-paren">(</span><emclass="sig-param">start_connected=None</em>, <emclass="sig-param">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>
<li><p><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
<li><p><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="sig-prename descclassname">com.vmware.vcenter.vm.hardware_client.</code><codeclass="sig-name descname">ConnectionInfo</code><spanclass="sig-paren">(</span><emclass="sig-param">state=None</em>, <emclass="sig-param">start_connected=None</em>, <emclass="sig-param">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>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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="sig-prename descclassname">com.vmware.vcenter.vm.hardware_client.</code><codeclass="sig-name descname">ConnectionState</code><spanclass="sig-paren">(</span><emclass="sig-param">string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.ConnectionState"title="Permalink to this definition">¶</a></dt>
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="sig-name 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>
<codeclass="sig-name 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="sig-name 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>
<codeclass="sig-name 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="sig-name 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>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vcenter.vm.hardware_client.</code><codeclass="sig-name descname">ConnectionUpdateSpec</code><spanclass="sig-paren">(</span><emclass="sig-param">start_connected=None</em>, <emclass="sig-param">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>
<li><p><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
<li><p><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="sig-prename descclassname">com.vmware.vcenter.vm.hardware_client.</code><codeclass="sig-name descname">Cpu</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cpu"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><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.</p>
<emclass="property">class </em><codeclass="sig-name descname">Info</code><spanclass="sig-paren">(</span><emclass="sig-param">count=None</em>, <emclass="sig-param">cores_per_socket=None</em>, <emclass="sig-param">hot_add_enabled=None</em>, <emclass="sig-param">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>
<li><p><strong>count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Number of CPU cores.</p></li>
<li><p><strong>cores_per_socket</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Number of CPU cores per socket.</p></li>
<li><p><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.</p></li>
<li><p><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="sig-name descname">UpdateSpec</code><spanclass="sig-paren">(</span><emclass="sig-param">count=None</em>, <emclass="sig-param">cores_per_socket=None</em>, <emclass="sig-param">hot_add_enabled=None</em>, <emclass="sig-param">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>
<li><p><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
<li><p><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
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cpu.get"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">update</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em>, <emclass="sig-param">spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cpu.update"title="Permalink to this definition">¶</a></dt>
<li><p><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="sig-prename descclassname">com.vmware.vcenter.vm.hardware_client.</code><codeclass="sig-name descname">Disk</code><spanclass="sig-paren">(</span><emclass="sig-param">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>
<ddclass="field-odd"><p><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.</p>
<emclass="property">class </em><codeclass="sig-name descname">BackingInfo</code><spanclass="sig-paren">(</span><emclass="sig-param">type=None</em>, <emclass="sig-param">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>
<li><p><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.</p></li>
<li><p><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.
<emclass="property">class </em><codeclass="sig-name descname">BackingSpec</code><spanclass="sig-paren">(</span><emclass="sig-param">type=None</em>, <emclass="sig-param">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>
<li><p><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.</p></li>
<li><p><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.
<emclass="property">class </em><codeclass="sig-name descname">BackingType</code><spanclass="sig-paren">(</span><emclass="sig-param">string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Disk.BackingType"title="Permalink to this definition">¶</a></dt>
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="sig-name 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>
<li><p><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</p></li>
<li><p><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.
<li><p><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.
<li><p><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.
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
<li><p><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.
<emclass="property">class </em><codeclass="sig-name descname">HostBusAdapterType</code><spanclass="sig-paren">(</span><emclass="sig-param">string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Disk.HostBusAdapterType"title="Permalink to this definition">¶</a></dt>
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="sig-name 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="sig-name 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="sig-name 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><p><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.</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<codeclass="sig-name 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="sig-name descname">StoragePolicySpec</code><spanclass="sig-paren">(</span><emclass="sig-param">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>
<ddclass="field-odd"><p><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.
<emclass="property">class </em><codeclass="sig-name descname">Summary</code><spanclass="sig-paren">(</span><emclass="sig-param">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="sig-name descname">UpdateSpec</code><spanclass="sig-paren">(</span><emclass="sig-param">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="sig-name descname">VmdkCreateSpec</code><spanclass="sig-paren">(</span><emclass="sig-param">name=None</em>, <emclass="sig-param">capacity=None</em>, <emclass="sig-param">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>
<li><p><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’
<li><p><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.</p></li>
<li><p><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
<codeclass="sig-name descname">create</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em>, <emclass="sig-param">spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Disk.create"title="Permalink to this definition">¶</a></dt>
<li><p><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.</p></li>
<codeclass="sig-name descname">delete</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em>, <emclass="sig-param">disk</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Disk.delete"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em>, <emclass="sig-param">disk</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Disk.get"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">list</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Disk.list"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">update</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em>, <emclass="sig-param">disk</em>, <emclass="sig-param">spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Disk.update"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vcenter.vm.hardware_client.</code><codeclass="sig-name descname">Ethernet</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><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.</p>
<li><p><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
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>.</p></li>
<li><p><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.
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>.</p></li>
<li><p><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
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>.</p></li>
<li><p><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
<li><p><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.
<li><p><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.
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>.</p></li>
<li><p><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
<emclass="property">class </em><codeclass="sig-name descname">BackingSpec</code><spanclass="sig-paren">(</span><emclass="sig-param">type=None</em>, <emclass="sig-param">network=None</em>, <emclass="sig-param">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>
<li><p><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.</p></li>
<li><p><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.
<li><p><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
<emclass="property">class </em><codeclass="sig-name descname">BackingType</code><spanclass="sig-paren">(</span><emclass="sig-param">string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType"title="Permalink to this definition">¶</a></dt>
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="sig-name 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="sig-name 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>
<codeclass="sig-name 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="sig-name 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>
<li><p><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>.</p></li>
<li><p><strong>mac_address</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – MAC address.
Workaround for PR1459647</p></li>
<li><p><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
<li><p><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
<li><p><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
<li><p><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="sig-name descname">EmulationType</code><spanclass="sig-paren">(</span><emclass="sig-param">string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType"title="Permalink to this definition">¶</a></dt>
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="sig-name 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="sig-name 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="sig-name 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="sig-name 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="sig-name 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="sig-name 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>
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.</p></li>
<li><p><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
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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="sig-name descname">MacAddressType</code><spanclass="sig-paren">(</span><emclass="sig-param">string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType"title="Permalink to this definition">¶</a></dt>
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="sig-name 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>
<codeclass="sig-name 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>
<codeclass="sig-name 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="sig-name 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>
<emclass="property">class </em><codeclass="sig-name descname">Summary</code><spanclass="sig-paren">(</span><emclass="sig-param">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><p><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
<li><p><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
<li><p><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="sig-name descname">connect</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em>, <emclass="sig-param">nic</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.connect"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">create</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em>, <emclass="sig-param">spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.create"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">delete</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em>, <emclass="sig-param">nic</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.delete"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">disconnect</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em>, <emclass="sig-param">nic</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.disconnect"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em>, <emclass="sig-param">nic</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.get"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">list</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.list"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">update</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em>, <emclass="sig-param">nic</em>, <emclass="sig-param">spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.update"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vcenter.vm.hardware_client.</code><codeclass="sig-name descname">Floppy</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Floppy"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><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.</p>
<emclass="property">class </em><codeclass="sig-name descname">BackingInfo</code><spanclass="sig-paren">(</span><emclass="sig-param">type=None</em>, <emclass="sig-param">image_file=None</em>, <emclass="sig-param">host_device=None</em>, <emclass="sig-param">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>
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>.</p></li>
<li><p><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.
<li><p><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
<emclass="property">class </em><codeclass="sig-name descname">BackingSpec</code><spanclass="sig-paren">(</span><emclass="sig-param">type=None</em>, <emclass="sig-param">image_file=None</em>, <emclass="sig-param">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>
<li><p><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.</p></li>
<li><p><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
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>.</p></li>
<li><p><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
<emclass="property">class </em><codeclass="sig-name descname">BackingType</code><spanclass="sig-paren">(</span><emclass="sig-param">string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Floppy.BackingType"title="Permalink to this definition">¶</a></dt>
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="sig-name 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>
<codeclass="sig-name 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>
<codeclass="sig-name 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>
<emclass="property">class </em><codeclass="sig-name descname">CreateSpec</code><spanclass="sig-paren">(</span><emclass="sig-param">backing=None</em>, <emclass="sig-param">start_connected=None</em>, <emclass="sig-param">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>
<li><p><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.</p></li>
<li><p><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
<li><p><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="sig-name descname">Info</code><spanclass="sig-paren">(</span><emclass="sig-param">label=None</em>, <emclass="sig-param">backing=None</em>, <emclass="sig-param">state=None</em>, <emclass="sig-param">start_connected=None</em>, <emclass="sig-param">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><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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="sig-name 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>
<emclass="property">class </em><codeclass="sig-name descname">Summary</code><spanclass="sig-paren">(</span><emclass="sig-param">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="sig-name descname">UpdateSpec</code><spanclass="sig-paren">(</span><emclass="sig-param">backing=None</em>, <emclass="sig-param">start_connected=None</em>, <emclass="sig-param">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>
<li><p><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
<li><p><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="sig-name descname">connect</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em>, <emclass="sig-param">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="sig-name descname">create</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em>, <emclass="sig-param">spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Floppy.create"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">delete</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em>, <emclass="sig-param">floppy</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Floppy.delete"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">disconnect</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em>, <emclass="sig-param">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="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em>, <emclass="sig-param">floppy</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Floppy.get"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">list</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Floppy.list"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">update</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em>, <emclass="sig-param">floppy</em>, <emclass="sig-param">spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Floppy.update"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vcenter.vm.hardware_client.</code><codeclass="sig-name descname">IdeAddressInfo</code><spanclass="sig-paren">(</span><emclass="sig-param">primary=None</em>, <emclass="sig-param">master=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.IdeAddressInfo"title="Permalink to this definition">¶</a></dt>
<li><p><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.</p></li>
<li><p><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="sig-prename descclassname">com.vmware.vcenter.vm.hardware_client.</code><codeclass="sig-name descname">IdeAddressSpec</code><spanclass="sig-paren">(</span><emclass="sig-param">primary=None</em>, <emclass="sig-param">master=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.IdeAddressSpec"title="Permalink to this definition">¶</a></dt>
<li><p><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
<li><p><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
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vcenter.vm.hardware_client.</code><codeclass="sig-name descname">Memory</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Memory"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><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.</p>
<emclass="property">class </em><codeclass="sig-name descname">Info</code><spanclass="sig-paren">(</span><emclass="sig-param">size_mib=None</em>, <emclass="sig-param">hot_add_enabled=None</em>, <emclass="sig-param">hot_add_increment_size_mib=None</em>, <emclass="sig-param">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><p><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
<li><p><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
<emclass="property">class </em><codeclass="sig-name descname">UpdateSpec</code><spanclass="sig-paren">(</span><emclass="sig-param">size_mib=None</em>, <emclass="sig-param">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="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Memory.get"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">update</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em>, <emclass="sig-param">spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Memory.update"title="Permalink to this definition">¶</a></dt>
<li><p><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="sig-prename descclassname">com.vmware.vcenter.vm.hardware_client.</code><codeclass="sig-name descname">Parallel</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Parallel"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><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.</p>
<emclass="property">class </em><codeclass="sig-name descname">BackingInfo</code><spanclass="sig-paren">(</span><emclass="sig-param">type=None</em>, <emclass="sig-param">file=None</em>, <emclass="sig-param">host_device=None</em>, <emclass="sig-param">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>
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>.</p></li>
<li><p><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.
<li><p><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
<emclass="property">class </em><codeclass="sig-name descname">BackingSpec</code><spanclass="sig-paren">(</span><emclass="sig-param">type=None</em>, <emclass="sig-param">file=None</em>, <emclass="sig-param">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>
<li><p><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.</p></li>
<li><p><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
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>.</p></li>
<li><p><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
<emclass="property">class </em><codeclass="sig-name descname">BackingType</code><spanclass="sig-paren">(</span><emclass="sig-param">string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Parallel.BackingType"title="Permalink to this definition">¶</a></dt>
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="sig-name 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>
<codeclass="sig-name 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>
<emclass="property">class </em><codeclass="sig-name descname">CreateSpec</code><spanclass="sig-paren">(</span><emclass="sig-param">backing=None</em>, <emclass="sig-param">start_connected=None</em>, <emclass="sig-param">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>
<li><p><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.</p></li>
<li><p><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
<li><p><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="sig-name descname">Info</code><spanclass="sig-paren">(</span><emclass="sig-param">label=None</em>, <emclass="sig-param">backing=None</em>, <emclass="sig-param">state=None</em>, <emclass="sig-param">start_connected=None</em>, <emclass="sig-param">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><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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="sig-name 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>
<emclass="property">class </em><codeclass="sig-name descname">Summary</code><spanclass="sig-paren">(</span><emclass="sig-param">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="sig-name descname">UpdateSpec</code><spanclass="sig-paren">(</span><emclass="sig-param">backing=None</em>, <emclass="sig-param">start_connected=None</em>, <emclass="sig-param">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>
<li><p><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
<li><p><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="sig-name descname">connect</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em>, <emclass="sig-param">port</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Parallel.connect"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">create</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em>, <emclass="sig-param">spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Parallel.create"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">delete</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em>, <emclass="sig-param">port</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Parallel.delete"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">disconnect</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em>, <emclass="sig-param">port</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Parallel.disconnect"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em>, <emclass="sig-param">port</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Parallel.get"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">list</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Parallel.list"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">update</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em>, <emclass="sig-param">port</em>, <emclass="sig-param">spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Parallel.update"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vcenter.vm.hardware_client.</code><codeclass="sig-name descname">SataAddressInfo</code><spanclass="sig-paren">(</span><emclass="sig-param">bus=None</em>, <emclass="sig-param">unit=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.SataAddressInfo"title="Permalink to this definition">¶</a></dt>
<li><p><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.</p></li>
<li><p><strong>unit</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Unit number of the device.</p></li>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vcenter.vm.hardware_client.</code><codeclass="sig-name descname">SataAddressSpec</code><spanclass="sig-paren">(</span><emclass="sig-param">bus=None</em>, <emclass="sig-param">unit=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.SataAddressSpec"title="Permalink to this definition">¶</a></dt>
<li><p><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.</p></li>
<li><p><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.
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vcenter.vm.hardware_client.</code><codeclass="sig-name descname">ScsiAddressInfo</code><spanclass="sig-paren">(</span><emclass="sig-param">bus=None</em>, <emclass="sig-param">unit=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.ScsiAddressInfo"title="Permalink to this definition">¶</a></dt>
<li><p><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.</p></li>
<li><p><strong>unit</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Unit number of the device.</p></li>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vcenter.vm.hardware_client.</code><codeclass="sig-name descname">ScsiAddressSpec</code><spanclass="sig-paren">(</span><emclass="sig-param">bus=None</em>, <emclass="sig-param">unit=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.ScsiAddressSpec"title="Permalink to this definition">¶</a></dt>
<li><p><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.</p></li>
<li><p><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.
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vcenter.vm.hardware_client.</code><codeclass="sig-name descname">Serial</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Serial"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><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.</p>
<li><p><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.</p></li>
<li><p><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.
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>.</p></li>
<li><p><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.
<li><p><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
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>.</p></li>
<li><p><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><p><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><p><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
<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
<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
<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><p><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.
<li><p><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.</p></li>
<li><p><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.
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>.</p></li>
<li><p><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.
automatically detect a suitable host device.</p></li>
<li><p><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><p><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
<li><p><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
<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
<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
<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><p><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.
<emclass="property">class </em><codeclass="sig-name descname">BackingType</code><spanclass="sig-paren">(</span><emclass="sig-param">string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType"title="Permalink to this definition">¶</a></dt>
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="sig-name 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>
<codeclass="sig-name 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>
<codeclass="sig-name 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>
<codeclass="sig-name 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>
<codeclass="sig-name 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>
<codeclass="sig-name 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>
<emclass="property">class </em><codeclass="sig-name descname">CreateSpec</code><spanclass="sig-paren">(</span><emclass="sig-param">yield_on_poll=None</em>, <emclass="sig-param">backing=None</em>, <emclass="sig-param">start_connected=None</em>, <emclass="sig-param">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>
<li><p><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
<li><p><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.</p></li>
<li><p><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
<li><p><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
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Serial.Info</span></code> class contains information about a virtual serial port.</p>
<li><p><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
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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="sig-name 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>
<emclass="property">class </em><codeclass="sig-name descname">Summary</code><spanclass="sig-paren">(</span><emclass="sig-param">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>
<ddclass="field-odd"><p><strong>port</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the virtual serial port.
<emclass="property">class </em><codeclass="sig-name descname">UpdateSpec</code><spanclass="sig-paren">(</span><emclass="sig-param">yield_on_poll=None</em>, <emclass="sig-param">backing=None</em>, <emclass="sig-param">start_connected=None</em>, <emclass="sig-param">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>
<li><p><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
<li><p><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>
<li><p><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
<li><p><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="sig-name descname">connect</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em>, <emclass="sig-param">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="sig-name descname">create</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em>, <emclass="sig-param">spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Serial.create"title="Permalink to this definition">¶</a></dt>
<li><p><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.</p></li>
<codeclass="sig-name descname">delete</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em>, <emclass="sig-param">port</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Serial.delete"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">disconnect</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em>, <emclass="sig-param">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="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em>, <emclass="sig-param">port</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Serial.get"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">list</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Serial.list"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">update</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em>, <emclass="sig-param">port</em>, <emclass="sig-param">spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Serial.update"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vcenter.vm.hardware_client.</code><codeclass="sig-name descname">StubFactory</code><spanclass="sig-paren">(</span><emclass="sig-param">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="sig-prename descclassname">com.vmware.vcenter.vm.storage_client.</code><codeclass="sig-name descname">Policy</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.storage_client.Policy"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><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.</p>
<emclass="property">class </em><codeclass="sig-name descname">DiskPolicySpec</code><spanclass="sig-paren">(</span><emclass="sig-param">type=None</em>, <emclass="sig-param">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>
<li><p><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.</p></li>
<li><p><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
<emclass="property">class </em><codeclass="sig-name descname">PolicyType</code><spanclass="sig-paren">(</span><emclass="sig-param">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>
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="sig-name 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>
<codeclass="sig-name 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="sig-name descname">Info</code><spanclass="sig-paren">(</span><emclass="sig-param">vm_home=None</em>, <emclass="sig-param">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="sig-name descname">UpdateSpec</code><spanclass="sig-paren">(</span><emclass="sig-param">vm_home=None</em>, <emclass="sig-param">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>
<li><p><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.</p></li>
<li><p><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.
<emclass="property">class </em><codeclass="sig-name descname">VmHomePolicySpec</code><spanclass="sig-paren">(</span><emclass="sig-param">type=None</em>, <emclass="sig-param">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>
<li><p><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
<emclass="property">class </em><codeclass="sig-name descname">PolicyType</code><spanclass="sig-paren">(</span><emclass="sig-param">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>
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="sig-name 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>
<codeclass="sig-name 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="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.storage_client.Policy.get"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">update</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em>, <emclass="sig-param">spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.storage_client.Policy.update"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vcenter.vm.storage_client.</code><codeclass="sig-name descname">StubFactory</code><spanclass="sig-paren">(</span><emclass="sig-param">stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.storage_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-vcenter-vm-tools-client-module"></span><h2>com.vmware.vcenter.vm.tools_client module<aclass="headerlink"href="#module-com.vmware.vcenter.vm.tools_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vm_client</span></code> module provides classes for managing
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vcenter.vm.tools_client.</code><codeclass="sig-name descname">Installer</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.tools_client.Installer"title="Permalink to this definition">¶</a></dt>
Tools in the guest operating system. This class was added in vSphere API
7.0.0.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><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.</p>
<emclass="property">class </em><codeclass="sig-name descname">Info</code><spanclass="sig-paren">(</span><emclass="sig-param">is_connected=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.tools_client.Installer.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Installer.Info</span></code> class contains information about the VMWare Tools
installer. This class was added in vSphere API 7.0.0.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>is_connected</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag indicating whether the VMware Tools installer is mounted as a
CD-ROM. This attribute was added in vSphere API 7.0.0.</p>
<codeclass="sig-name descname">connect</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.tools_client.Installer.connect"title="Permalink to this definition">¶</a></dt>
<dd><p>Connects the VMware Tools CD installer as a CD-ROM for the guest
operating system. On Windows guest operating systems with autorun, this
should cause the installer to initiate the Tools installation which
will need user input to complete. On other (non-Windows) guest
operating systems this will make the Tools installation available, and
a a user will need to do guest-specific actions. On Linux, this
includes opening an archive and running the installer. To monitor the
status of the Tools install, clients should check the <codeclass="docutils literal notranslate"><spanclass="pre">versionStatus</span></code>
and <codeclass="docutils literal notranslate"><spanclass="pre">runState</span></code> from <aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.vm_client.Tools.get"title="com.vmware.vcenter.vm_client.Tools.get"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vm_client.Tools.get()</span></code></a>.
<codeclass="sig-name descname">disconnect</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.tools_client.Installer.disconnect"title="Permalink to this definition">¶</a></dt>
<dd><p>Disconnect the VMware Tools installer CD image. This method was added
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">vm</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.tools_client.Installer.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Get information about the VMware Tools installer. This method was added
in vSphere API 7.0.0.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>vm</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the virtual machine.
The parameter must be an identifier for the resource type:
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vcenter.vm.tools_client.</code><codeclass="sig-name descname">StubFactory</code><spanclass="sig-paren">(</span><emclass="sig-param">stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.tools_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>.
