<spanid="com-vmware-vcenter-vm-package"></span><h1>com.vmware.vcenter.vm package<aclass="headerlink"href="#module-com.vmware.vcenter.vm"title="Permalink to this headline">¶</a></h1>
<divclass="section"id="subpackages">
<h2>Subpackages<aclass="headerlink"href="#subpackages"title="Permalink to this headline">¶</a></h2>
<spanid="com-vmware-vcenter-vm-compute-client-module"></span><h2>com.vmware.vcenter.vm.compute_client module<aclass="headerlink"href="#module-com.vmware.vcenter.vm.compute_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vm.compute_client</span></code> module provides classes for
quering the status of compute policies on virtual machines in VMware Cloud on
AWS. Usage beyond VMware Cloud on AWS is not supported.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm.compute_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Policies</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.compute_client.Policies"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Policies</span></code> class provides methods to query the status of policies on
virtual machines in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS
is not supported. <strong>Warning:</strong> This class is available as Technology
Preview. These are early access APIs provided to test, automate and provide
feedback on the feature. Since this can change based on feedback, VMware
does not guarantee backwards compatibility and recommends against using
them in production environments. Some Technology Preview APIs might only be
applicable to specific environments.</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"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Info</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">status</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></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
object.**Warning:** This attribute is available as Technology
Preview. These are early access APIs provided to test, automate and
provide feedback on the feature. Since this can change based on
feedback, VMware does not guarantee backwards compatibility and
recommends against using them in production environments. Some
Technology Preview APIs might only be applicable to specific
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">policy</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.compute_client.Policies.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about the compliance of a virtual machine with a
compute policy in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS
is not supported. <strong>Warning:</strong> This method is available as Technology
Preview. These are early access APIs provided to test, automate and
provide feedback on the feature. Since this can change based on
feedback, VMware does not guarantee backwards compatibility and
recommends against using them in production environments. Some
Technology Preview APIs might only be applicable to specific
environments.</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>) – Identifier of the virtual machine to query the status for.
The parameter must be an identifier for the resource type:
<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.
The parameter must be an identifier for the resource type:
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm.compute_client.</span></code><codeclass="sig-name descname"><spanclass="pre">StubFactory</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">stub_config</span></span></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-console-client-module"></span><h2>com.vmware.vcenter.vm.console_client module<aclass="headerlink"href="#module-com.vmware.vcenter.vm.console_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vm.console_client</span></code> module provides classes for
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm.console_client.</span></code><codeclass="sig-name descname"><spanclass="pre">StubFactory</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">stub_config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.console_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm.console_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Tickets</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.console_client.Tickets"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Tickets</span></code> class provides methods for managing the virtual machine
console tickets. This class was added in vSphere API 7.0.0.2.</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"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">CreateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.console_client.Tickets.CreateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Tickets.CreateSpec</span></code> class defines the information used to create the
virtual machine console ticket. This class was added in vSphere API
7.0.0.2.</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>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.console_client.Tickets.Type"title="com.vmware.vcenter.vm.console_client.Tickets.Type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Tickets.Type</span></code></a>) – The type of virtual machine console ticket. This attribute was
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Summary</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">ticket</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.console_client.Tickets.Summary"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Tickets.Summary</span></code> class contains commonly used information about the
virtual machine console ticket. This class was added in vSphere API
7.0.0.2.</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>ticket</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Console ticket URI. This attribute was added in vSphere API
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Type</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.console_client.Tickets.Type"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Tickets.Type</span></code> class defines the types of console tickets. This
enumeration was added in vSphere API 7.0.0.2.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Type</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">VMRC</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Type(string='VMRC')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.console_client.Tickets.Type.VMRC"title="Permalink to this definition">¶</a></dt>
<dd><p>Virtual machine remote console ticket. This class attribute was added in
<codeclass="sig-name descname"><spanclass="pre">WEBMKS</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Type(string='WEBMKS')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.console_client.Tickets.Type.WEBMKS"title="Permalink to this definition">¶</a></dt>
<dd><p>Web socket console ticket. This class attribute was added in vSphere API
<codeclass="sig-name descname"><spanclass="pre">create</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.console_client.Tickets.create"title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a virtual machine console ticket of a given ticket type. The
created ticket is a one time use URI. The validity of the ticket is 30
minutes, if not used with in the time frame the ticket expires.</p>
<p>The <aclass="reference internal"href="#com.vmware.vcenter.vm.console_client.Tickets.Type.VMRC"title="com.vmware.vcenter.vm.console_client.Tickets.Type.VMRC"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Tickets.Type.VMRC</span></code></a> ticket contains the IP address or the DNS
resolvable name of the vCenter server. This ticket requires
installation of VMware Workstation, VMware Fusion or VMRC to be
installed on the machine where the ticket has to be opened. This ticket
can be acquired even when the VM is turned off.</p>
<p>The <aclass="reference internal"href="#com.vmware.vcenter.vm.console_client.Tickets.Type.WEBMKS"title="com.vmware.vcenter.vm.console_client.Tickets.Type.WEBMKS"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Tickets.Type.WEBMKS</span></code></a> ticket contains the IP address of the
DNS resolvable name of the ESX server. This ticket requires user to
embed this ticket in a HTML page using VMware HTML Console SDK -
<aclass="reference external"href="https://www.vmware.com/support/developer/html-console">https://www.vmware.com/support/developer/html-console</a> This ticket can
be acquired only when the VM is turned on.. This method was added in
<li><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.console_client.Tickets.CreateSpec"title="com.vmware.vcenter.vm.console_client.Tickets.CreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Tickets.CreateSpec</span></code></a>) – Specification for the console ticket to be created.</p></li>
<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"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm.guest_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Credentials</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">interactive_session</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">user_name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">password</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">saml_token</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Credentials"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Credentials</span></code> class defines the guest credentials used for guest
operation authentication. This class was added in vSphere API 7.0.2.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>interactive_session</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – If <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code>, the method will interact with the logged-in
desktop session in the guest. This requires that the logged-on user
matches the user specified by the <aclass="reference internal"href="#com.vmware.vcenter.vm.guest_client.Credentials"title="com.vmware.vcenter.vm.guest_client.Credentials"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Credentials</span></code></a>. This is
currently only supported for
<aclass="reference internal"href="#com.vmware.vcenter.vm.guest_client.Credentials.Type.USERNAME_PASSWORD"title="com.vmware.vcenter.vm.guest_client.Credentials.Type.USERNAME_PASSWORD"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Credentials.Type.USERNAME_PASSWORD</span></code></a>. This attribute was
added in vSphere API 7.0.2.0.</p></li>
<li><p><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.guest_client.Credentials.Type"title="com.vmware.vcenter.vm.guest_client.Credentials.Type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Credentials.Type</span></code></a>) – The guest credentials type. This attribute was added in vSphere API
7.0.2.0.</p></li>
<li><p><strong>user_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>) – For <aclass="reference internal"href="#com.vmware.vcenter.vm.guest_client.Credentials.Type.SAML_BEARER_TOKEN"title="com.vmware.vcenter.vm.guest_client.Credentials.Type.SAML_BEARER_TOKEN"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Credentials.Type.SAML_BEARER_TOKEN</span></code></a>, this is the guest
user to be associated with the credentials. For
<aclass="reference internal"href="#com.vmware.vcenter.vm.guest_client.Credentials.Type.USERNAME_PASSWORD"title="com.vmware.vcenter.vm.guest_client.Credentials.Type.USERNAME_PASSWORD"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Credentials.Type.USERNAME_PASSWORD</span></code></a> this is the guest
username. This attribute was added in vSphere API 7.0.2.0.
If no user is specified for
<aclass="reference internal"href="#com.vmware.vcenter.vm.guest_client.Credentials.Type.SAML_BEARER_TOKEN"title="com.vmware.vcenter.vm.guest_client.Credentials.Type.SAML_BEARER_TOKEN"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Credentials.Type.SAML_BEARER_TOKEN</span></code></a>, a guest dependent
mapping will decide what guest user account is applied.</p></li>
<li><p><strong>password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – password. This attribute was added in vSphere API 7.0.2.0.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.vm.guest_client.Credentials.Type.USERNAME_PASSWORD"title="com.vmware.vcenter.vm.guest_client.Credentials.Type.USERNAME_PASSWORD"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Credentials.Type.USERNAME_PASSWORD</span></code></a>.</p></li>
<li><p><strong>saml_token</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – SAML Bearer Token. This attribute was added in vSphere API 7.0.2.0.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.vm.guest_client.Credentials.Type.SAML_BEARER_TOKEN"title="com.vmware.vcenter.vm.guest_client.Credentials.Type.SAML_BEARER_TOKEN"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Credentials.Type.SAML_BEARER_TOKEN</span></code></a>.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Type</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Credentials.Type"title="Permalink to this definition">¶</a></dt>
<p>Types of guest credentials. This enumeration was added in vSphere API
7.0.2.0.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Type</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">SAML_BEARER_TOKEN</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Type(string='SAML_BEARER_TOKEN')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Credentials.Type.SAML_BEARER_TOKEN"title="Permalink to this definition">¶</a></dt>
<dd><p>SAML_BEARER_TOKEN contains the information necessary to authenticate within
a guest using a SAML token. SAML Bearer token credentials relies on a guest
alias that associates a guest account with the subject and certificate
encoded in a SAML Bearer token obtained from the VMware SSO Server. This
class attribute was added in vSphere API 7.0.2.0.</p>
<codeclass="sig-name descname"><spanclass="pre">USERNAME_PASSWORD</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Type(string='USERNAME_PASSWORD')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Credentials.Type.USERNAME_PASSWORD"title="Permalink to this definition">¶</a></dt>
<dd><p>USERNAME_PASSWORD credentials contains the information necessary to
authenticate within a guest using a username and password. This method of
authentication is stateless.</p>
<p>To use USERNAME_PASSWORD, populate userName and password with the
appropriate login information.</p>
<p>Once populated, you can use USERNAME_PASSWORD in any guest operations
method.. This class attribute was added in vSphere API 7.0.2.0.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm.guest_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Customization</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></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.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"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Info</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">status</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">error</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">start_time</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">end_time</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Customization.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Customization.Info</span></code> class contains the status of a customization
operation applied to a virtual machine. This class was added in vSphere API
7.0.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>status</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.guest_client.Customization.Info.Status"title="com.vmware.vcenter.vm.guest_client.Customization.Info.Status"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Customization.Info.Status</span></code></a>) – The status of the customization operation. This attribute was added
in vSphere API 7.0.0.0.</p></li>
<li><p><strong>error</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Description of the error if the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Customization.Info.status</span></code>
of customization operation is
<aclass="reference internal"href="#com.vmware.vcenter.vm.guest_client.Customization.Info.Status.FAILED"title="com.vmware.vcenter.vm.guest_client.Customization.Info.Status.FAILED"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Customization.Info.Status.FAILED</span></code></a>. This attribute was added
in vSphere API 7.0.0.0.
This attribute will be None if the status is not FAILED or there is
no information available for the error.</p></li>
<li><p><strong>start_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Time when the customization process has started inside the guest
operating system. This attribute was added in vSphere API 7.0.0.0.
This attribute will be None if the status is PENDING.</p></li>
<li><p><strong>end_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Time when the customization process has completed inside the guest
operating system. This attribute was added in vSphere API 7.0.0.0.
This attribute will be None if the status is not SUCCEEDED or
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Status</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Customization.Info.Status"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Customization.Info.Status</span></code> class defines the status values that can
be reported for the customization operation. This enumeration was added in
vSphere API 7.0.0.0.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Status</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">FAILED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Status(string='FAILED')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Customization.Info.Status.FAILED"title="Permalink to this definition">¶</a></dt>
<dd><p>The customizatio process has failed inside the guest operating system. This
class attribute was added in vSphere API 7.0.0.0.</p>
<codeclass="sig-name descname"><spanclass="pre">PENDING</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Status(string='PENDING')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Customization.Info.Status.PENDING"title="Permalink to this definition">¶</a></dt>
<dd><p>The customization process has not yet started inside the guest operating
system. This class attribute was added in vSphere API 7.0.0.0.</p>
<codeclass="sig-name descname"><spanclass="pre">RUNNING</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Status(string='RUNNING')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Customization.Info.Status.RUNNING"title="Permalink to this definition">¶</a></dt>
<dd><p>The customization process is currently running inside the guest operating
system. This class attribute was added in vSphere API 7.0.0.0.</p>
<codeclass="sig-name descname"><spanclass="pre">SUCCEEDED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Status(string='SUCCEEDED')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Customization.Info.Status.SUCCEEDED"title="Permalink to this definition">¶</a></dt>
<dd><p>The customization process has completed successfully inside the guest
operating system. This class attribute was added in vSphere API 7.0.0.0.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">SetSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></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.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.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.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"><spanclass="pre">set</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></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.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"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm.guest_client.</span></code><codeclass="sig-name descname"><spanclass="pre">DhcpConfigInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">ipv4_enabled</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">ipv6_enabled</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></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.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.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"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm.guest_client.</span></code><codeclass="sig-name descname"><spanclass="pre">DnsAssignedValues</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">host_name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">domain_name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></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.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.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.0.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm.guest_client.</span></code><codeclass="sig-name descname"><spanclass="pre">DnsConfigInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">ip_addresses</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">search_domains</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></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.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.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.0.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm.guest_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Environment</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Environment"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Environment</span></code> class provides methods to manage environment variables
in the guest operating system. This class was added in vSphere API 7.0.2.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>
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">credentials</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Environment.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Reads a single environment variable from the guest operating system.</p>
<p>If the authentication uses <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Credentials.interactive_session</span></code>,
then the environment being read will be that of the user logged into
the desktop. Otherwise it’s the environment of the system user.</p>
<p>. This method was added in vSphere API 7.0.2.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>) – Virtual machine to perform the operation on.
The parameter must be an identifier for the resource type:
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the environment variable to be read.</p></li>
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">credentials</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">names</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Environment.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Reads a list of environment variables from the guest operating system.</p>
<p>If the authentication uses <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Credentials.interactive_session</span></code>,
then the environment being read will be that of the user logged into
the desktop. Otherwise it’s the environment of the system user.</p>
<p>. This method was added in vSphere API 7.0.2.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>) – Virtual machine to perform the operation on.
The parameter must be an identifier for the resource type:
<li><p><strong>names</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The names of the variables to be read. If the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> is
empty, then all the environment variables are returned.</p></li>
</ul>
</dd>
<dtclass="field-even">Return type</dt>
<ddclass="field-even"><p><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 <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code></p>
</dd>
<dtclass="field-odd">Returns</dt>
<ddclass="field-odd"><p>Mapping from environment variable names to environment variable
values, or all environment variables if nothing is specified. If
any specified environment variable contained in <codeclass="docutils literal notranslate"><spanclass="pre">names</span></code> is not
set, then nothing is returned for that variable.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm.guest_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Identity</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Identity"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Identity</span></code> class provides methods for retrieving guest operating
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"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Info</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">family</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">full_name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">host_name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">ip_address</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Identity.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Identity.Info</span></code> class contains information describing the guest
operating system identification. This class was added in vSphere API 6.7.</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> (<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"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Identity.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Return information about the guest. This method was added in vSphere
API 6.7.</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"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm.guest_client.</span></code><codeclass="sig-name descname"><spanclass="pre">LocalFilesystem</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.LocalFilesystem"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">LocalFilesystem</span></code> class provides methods for retrieving information
about the guest operating system local file systems. 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"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Info</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">capacity</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">free_space</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">filesystem</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">mappings</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.LocalFilesystem.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">LocalFilesystem.Info</span></code> class contains information about a local file
system configured in the guest operating system. This class was added in
vSphere API 6.7.</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>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
in vSphere API 6.7.</p></li>
<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.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.0.
This attribute is optional because it was added in a newer version
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">VirtualDiskMapping</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">disk</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></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.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.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"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.LocalFilesystem.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns details of the local file systems in the guest operating
system. This method was added in vSphere API 6.7.</p>
<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"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm.guest_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Networking</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></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.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"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Info</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">dns_values</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">dns</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></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.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.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"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></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.0.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm.guest_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Operations</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Operations"title="Permalink to this definition">¶</a></dt>
<p>Status of operations in the guest OS. This class was added in vSphere API
7.0.2.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"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Info</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">guest_operations_ready</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">interactive_guest_operations_ready</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Operations.Info"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Operations.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Get information about the guest operation status. This method was added
in vSphere API 7.0.2.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"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm.guest_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Power</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Power"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Power</span></code> class provides methods for managing the guest operating
system power state of a virtual machine. 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"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Info</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">state</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">operations_ready</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Power.Info"title="Permalink to this definition">¶</a></dt>
<p>Information about the guest operating system power state. This class was
added in vSphere API 6.7.</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>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"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">State</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Power.State"title="Permalink to this definition">¶</a></dt>
<p>Possible guest power states. This enumeration was added in vSphere API 6.7.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">State</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">NOT_RUNNING</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">State(string='NOT_RUNNING')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Power.State.NOT_RUNNING"title="Permalink to this definition">¶</a></dt>
<dd><p>The guest OS is not running. This class attribute was added in vSphere API
<codeclass="sig-name descname"><spanclass="pre">RESETTING</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">State(string='RESETTING')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Power.State.RESETTING"title="Permalink to this definition">¶</a></dt>
<dd><p>The guest OS is resetting. This class attribute was added in vSphere API
<codeclass="sig-name descname"><spanclass="pre">RUNNING</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">State(string='RUNNING')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Power.State.RUNNING"title="Permalink to this definition">¶</a></dt>
<dd><p>The guest OS is running. This class attribute was added in vSphere API 6.7.</p>
<codeclass="sig-name descname"><spanclass="pre">SHUTTING_DOWN</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">State(string='SHUTTING_DOWN')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Power.State.SHUTTING_DOWN"title="Permalink to this definition">¶</a></dt>
<dd><p>The guest OS is shutting down. This class attribute was added in vSphere
<codeclass="sig-name descname"><spanclass="pre">STANDBY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">State(string='STANDBY')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Power.State.STANDBY"title="Permalink to this definition">¶</a></dt>
<dd><p>The guest OS is in standby. This class attribute was added in vSphere API
<codeclass="sig-name descname"><spanclass="pre">UNAVAILABLE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">State(string='UNAVAILABLE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Power.State.UNAVAILABLE"title="Permalink to this definition">¶</a></dt>
<dd><p>The guest OS power state is unknown. This class attribute was added in
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Power.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about the guest operating system power state. This
method was added in vSphere API 6.7.</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:
<codeclass="sig-name descname"><spanclass="pre">reboot</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Power.reboot"title="Permalink to this definition">¶</a></dt>
<dd><p>Issues a request to the guest operating system asking it to perform a
reboot. This request returns immediately and does not wait for the
guest operating system to complete the operation. This method was added
in vSphere API 6.7.</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:
<codeclass="sig-name descname"><spanclass="pre">shutdown</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Power.shutdown"title="Permalink to this definition">¶</a></dt>
<dd><p>Issues a request to the guest operating system asking it to perform a
clean shutdown of all services. This request returns immediately and
does not wait for the guest operating system to complete the operation.
This method was added in vSphere API 6.7.</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:
<codeclass="sig-name descname"><spanclass="pre">standby</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Power.standby"title="Permalink to this definition">¶</a></dt>
<dd><p>Issues a request to the guest operating system asking it to perform a
suspend operation. This method was added in vSphere API 6.7.</p>
<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"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm.guest_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Processes</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Processes"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Processes</span></code> class provides methods to manage processes in the guest
operating system. This class was added in vSphere API 7.0.2.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"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">CreateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">path</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">arguments</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">working_directory</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">environment_variables</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">start_minimized</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Processes.CreateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Processes.CreateSpec</span></code> class describes the arguments to
<aclass="reference internal"href="#com.vmware.vcenter.vm.guest_client.Processes.create"title="com.vmware.vcenter.vm.guest_client.Processes.create"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Processes.create()</span></code></a>. This class was added in vSphere API 7.0.2.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>path</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) –<p>The absolute path to the program to start.</p>
<p>For Linux guest operating systems, /bin/bash is used to start the
program.</p>
<p>For Solaris guest operating systems, if /bin/bash exists, its used
to start the program, otherwise /bin/sh is used. If /bin/sh is
used, then the process ID returned by <aclass="reference internal"href="#com.vmware.vcenter.vm.guest_client.Processes.create"title="com.vmware.vcenter.vm.guest_client.Processes.create"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Processes.create()</span></code></a> will
be that of the shell used to start the program, rather than the
program itself, due to the differences in how /bin/sh and /bin/bash
work. This PID will still be usable for watching the process with
<aclass="reference internal"href="#com.vmware.vcenter.vm.guest_client.Processes.list"title="com.vmware.vcenter.vm.guest_client.Processes.list"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Processes.list()</span></code></a> to find its exit code and elapsed time.</p>
<p>For Windows, no shell is used. Using a simple batch file instead by
prepending <codeclass="docutils literal notranslate"><spanclass="pre">c:\windows\system32\cmd.exe</span><spanclass="pre">/c</span></code> will allow stdio
redirection to work if passed in the <codeclass="docutils literal notranslate"><spanclass="pre">arguments</span></code> parameter.. This
attribute was added in vSphere API 7.0.2.0.</p>
</p></li>
<li><p><strong>arguments</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>The arguments to the program.</p>
<p>Characters which must be escaped to the shell should also be
escaped in <codeclass="docutils literal notranslate"><spanclass="pre">arguments</span></code>.</p>
<p>In Linux and Solaris guest operating systems, stdio redirection
arguments may be used.</p>
<p>For Windows, stdio redirection can be added to the argments if
<codeclass="docutils literal notranslate"><spanclass="pre">path</span></code> is prefixed with <codeclass="docutils literal notranslate"><spanclass="pre">c:\windows\system32\cmd.exe</span><spanclass="pre">/c</span></code>.. This
attribute was added in vSphere API 7.0.2.0.
If None no arguments are passed to the program.</p>
</p></li>
<li><p><strong>working_directory</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 absolute path of the working directory for the program to be
run. VMware recommends explicitly setting the working directory for
the program to be run. This attribute was added in vSphere API
7.0.2.0.
If None or is an empty string, the behavior depends on the guest
operating system. For Linux guest operating systems, if None or is
an empty string, the working directory will be the home directory
of the user associated with the guest authentication. For other
guest operating systems, if None, the behavior is unspecified.</p></li>
<li><p><strong>environment_variables</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 <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A map of environment variables, specified using the guest OS rules
(for example <codeclass="docutils literal notranslate"><spanclass="pre">PATH,</span><spanclass="pre">c:in;c:\windows\system32</span></code> or
<codeclass="docutils literal notranslate"><spanclass="pre">LD_LIBRARY_PATH,/usr/lib:/lib</span></code>), to be set for the program being
run. Note that these are not additions to the default environment
variables; they define the complete set available to the program.
This attribute was added in vSphere API 7.0.2.0.
If None, the environment variables used are guest dependent
defaults.</p></li>
<li><p><strong>start_minimized</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Makes any program window start minimized in Windows operating
systems. Returns an error if <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> for non-Windows guests.
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Info</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">owner</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">command</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">started</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">finished</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">exit_code</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Processes.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Processes.Info</span></code> class describes the state of a guest process. This
class was added in vSphere API 7.0.2.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>) – The process name. This attribute was added in vSphere API 7.0.2.0.</p></li>
<li><p><strong>owner</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The process owner. This attribute was added in vSphere API 7.0.2.0.</p></li>
<li><p><strong>command</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The full command line of the process. This attribute was added in
vSphere API 7.0.2.0.</p></li>
<li><p><strong>started</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – The start time of the process. This attribute was added in vSphere
API 7.0.2.0.</p></li>
<li><p><strong>finished</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – If the process was started using <aclass="reference internal"href="#com.vmware.vcenter.vm.guest_client.Processes.create"title="com.vmware.vcenter.vm.guest_client.Processes.create"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Processes.create()</span></code></a> then the
process completion time will be available if queried within 5
minutes after it completes. This attribute was added in vSphere API
7.0.2.0.
Set if the process was started with <aclass="reference internal"href="#com.vmware.vcenter.vm.guest_client.Processes.create"title="com.vmware.vcenter.vm.guest_client.Processes.create"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Processes.create()</span></code></a> and
has recently exited.</p></li>
<li><p><strong>exit_code</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – If the process was started using <aclass="reference internal"href="#com.vmware.vcenter.vm.guest_client.Processes.create"title="com.vmware.vcenter.vm.guest_client.Processes.create"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Processes.create()</span></code></a> then the
process exit code will be available if queried within 5 minutes
after it completes. This attribute was added in vSphere API
7.0.2.0.
Set if the process was started with <aclass="reference internal"href="#com.vmware.vcenter.vm.guest_client.Processes.create"title="com.vmware.vcenter.vm.guest_client.Processes.create"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Processes.create()</span></code></a> and
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">ProcessErrorDetails</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">pid</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Processes.ProcessErrorDetails"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Processes.ProcessErrorDetails</span></code> class describes additional error
information for process operations. This class was added in vSphere API
7.0.2.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>pid</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – The process associated with the error. This attribute was added in
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Summary</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">pid</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">owner</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">command</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">started</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Processes.Summary"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Processes.Summary</span></code> class describes the state of a guest process.
This class was added in vSphere API 7.0.2.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>) – The process name. This attribute was added in vSphere API 7.0.2.0.</p></li>
<li><p><strong>pid</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – The process ID. This attribute was added in vSphere API 7.0.2.0.</p></li>
<li><p><strong>owner</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The process owner. This attribute was added in vSphere API 7.0.2.0.</p></li>
<li><p><strong>command</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The full command line of the process. This attribute was added in
vSphere API 7.0.2.0.</p></li>
<li><p><strong>started</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – The start time of the process. This attribute was added in vSphere
<codeclass="sig-name descname"><spanclass="pre">create</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">credentials</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Processes.create"title="Permalink to this definition">¶</a></dt>
<dd><p>Starts a program in the guest operating system.</p>
<p>A process started this way can have its status queried with
<aclass="reference internal"href="#com.vmware.vcenter.vm.guest_client.Processes.list"title="com.vmware.vcenter.vm.guest_client.Processes.list"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Processes.list()</span></code></a> or <aclass="reference internal"href="#com.vmware.vcenter.vm.guest_client.Processes.get"title="com.vmware.vcenter.vm.guest_client.Processes.get"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Processes.get()</span></code></a>. When the process
completes, its exit code and end time will be available for 5 minutes
after completion.</p>
<p>. This method was added in vSphere API 7.0.2.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>) – Virtual machine to perform the operation on.
The parameter must be an identifier for the resource type:
<li><p><strong>credentials</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.guest_client.Credentials"title="com.vmware.vcenter.vm.guest_client.Credentials"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Credentials</span></code></a>) – The guest authentication data. See <aclass="reference internal"href="#com.vmware.vcenter.vm.guest_client.Credentials"title="com.vmware.vcenter.vm.guest_client.Credentials"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Credentials</span></code></a>. The
program will be run as the user associated with this data.</p></li>
<li><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.guest_client.Processes.CreateSpec"title="com.vmware.vcenter.vm.guest_client.Processes.CreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Processes.CreateSpec</span></code></a>) – The arguments describing the program to be started.</p></li>
if the <codeclass="docutils literal notranslate"><spanclass="pre">path</span></code> attribute of <codeclass="docutils literal notranslate"><spanclass="pre">spec</span></code> cannot be accessed.</p>
if the <codeclass="docutils literal notranslate"><spanclass="pre">path</span></code> attribute of <codeclass="docutils literal notranslate"><spanclass="pre">spec</span></code> cannot be run because
<codeclass="docutils literal notranslate"><spanclass="pre">credentials</span></code> will not allow the operation.</p>
<codeclass="sig-name descname"><spanclass="pre">delete</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">credentials</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">pid</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Processes.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Terminates a process in the guest OS.</p>
<p>On Posix guests, the process is sent a TERM signal. If that doesn’t
terminate the process, a KILL signal is sent. A process may still be
running if it’s stuck.</p>
<p>. This method was added in vSphere API 7.0.2.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>) – Virtual machine to perform the operation on.
The parameter must be an identifier for the resource type:
<li><p><strong>pid</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Process ID of the process to be terminated</p></li>
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">credentials</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">pid</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Processes.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the status of a process running in the guest operating system,
including those started by <aclass="reference internal"href="#com.vmware.vcenter.vm.guest_client.Processes.create"title="com.vmware.vcenter.vm.guest_client.Processes.create"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Processes.create()</span></code></a> that may have
recently completed.</p>
<p>. This method was added in vSphere API 7.0.2.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>) – Virtual machine to perform the operation on.
The parameter must be an identifier for the resource type:
<li><p><strong>pid</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Specifies the process to query.</p></li>
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">credentials</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.guest_client.Processes.list"title="Permalink to this definition">¶</a></dt>
<dd><p>List the processes running in the guest operating system, plus those
started by <aclass="reference internal"href="#com.vmware.vcenter.vm.guest_client.Processes.create"title="com.vmware.vcenter.vm.guest_client.Processes.create"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Processes.create()</span></code></a> that have recently completed.</p>
<p>. This method was added in vSphere API 7.0.2.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>) – Virtual machine to perform the operation on.
The parameter must be an identifier for the resource type:
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm.guest_client.</span></code><codeclass="sig-name descname"><spanclass="pre">StubFactory</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">stub_config</span></span></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"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm.hardware_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Boot</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Boot"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Boot</span></code> class provides methods for configuring the settings used when
booting a virtual machine.</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>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Boot.CreateSpec</span></code> class describes settings used when booting a
virtual machine.</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>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Boot.Type"title="com.vmware.vcenter.vm.hardware_client.Boot.Type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Boot.Type</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Firmware type to be used by the virtual machine.
If None, defaults to value that is recommended for the guest OS and
is supported for the virtual hardware version.</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, defaults to value that is recommended for the guest OS and
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
the network.
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
when the virtual machine is powered on. This delay may be used to
provide a time window for users to connect to the virtual machine
console and enter BIOS setup mode.
If None, default value is 0.</p></li>
<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
retry the boot process after a failure.
If None, default value is false.</p></li>
<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
failure; applicable only when <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Boot.Info.retry</span></code> is true.
If None, default value is 10000.</p></li>
<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
automatically enter setup mode the next time the virtual machine
boots. Note that this flag will automatically be reset to false
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Boot.Info</span></code> class contains information about the virtual machine boot
process.</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>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.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Boot.Type.EFI"title="com.vmware.vcenter.vm.hardware_client.Boot.Type.EFI"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Boot.Type.EFI</span></code></a>.</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
the network.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Boot.Type.EFI"title="com.vmware.vcenter.vm.hardware_client.Boot.Type.EFI"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Boot.Type.EFI</span></code></a>.</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
when the virtual machine is powered on. This delay may be used to
provide a time window for users to connect to the virtual machine
console and enter BIOS setup mode.</p></li>
<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
automatically enter setup mode the next time the virtual machine
boots. Note that this flag will automatically be reset to false
once the virtual machine enters setup mode.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">NetworkProtocol</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Boot.NetworkProtocol"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Boot.NetworkProtocol</span></code> class defines the valid network boot protocols
supported when booting a virtual machine with <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Boot.Type.EFI"title="com.vmware.vcenter.vm.hardware_client.Boot.Type.EFI"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Boot.Type.EFI</span></code></a>
firmware over the network.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">NetworkProtocol</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">IPV4</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">NetworkProtocol(string='IPV4')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Boot.NetworkProtocol.IPV4"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">IPV6</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">NetworkProtocol(string='IPV6')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Boot.NetworkProtocol.IPV6"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Type</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Boot.Type"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Boot.Type</span></code> class defines the valid firmware types for a virtual
machine.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Type</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">BIOS</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Type(string='BIOS')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Boot.Type.BIOS"title="Permalink to this definition">¶</a></dt>
<dd><p>Basic Input/Output System (BIOS) firmware.</p>
<codeclass="sig-name descname"><spanclass="pre">EFI</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Type(string='EFI')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Boot.Type.EFI"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Boot.UpdateSpec</span></code> class describes the updates to the settings used
when booting a virtual machine.</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>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
the network.
If None, the value is unchanged.</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
when the virtual machine is powered on. This delay may be used to
provide a time window for users to connect to the virtual machine
console and enter BIOS setup mode.
If None, the value is unchanged.</p></li>
<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
retry the boot process after a failure.
If None, the value is unchanged.</p></li>
<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
failure; applicable only when <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Boot.Info.retry</span></code> is true.
If None, the value is unchanged.</p></li>
<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
automatically enter setup mode the next time the virtual machine
boots. Note that this flag will automatically be reset to false
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Boot.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the boot-related settings of a virtual machine.</p>
<codeclass="sig-name descname"><spanclass="pre">update</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Boot.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Updates the boot-related settings of a virtual machine.</p>
<li><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"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm.hardware_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Cdrom</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cdrom</span></code> class provides methods for configuring the virtual CD-ROM
devices of a virtual machine.</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"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">BackingInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">iso_file</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">host_device</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">auto_detect</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">device_access_type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cdrom.BackingInfo</span></code> class contains information about the physical
resource backing a virtual CD-ROM device.</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>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 backing the virtual CD-ROM device.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType.ISO_FILE"title="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType.ISO_FILE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cdrom.BackingType.ISO_FILE</span></code></a>.</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.
This attribute will be None if <codeclass="docutils literal notranslate"><spanclass="pre">autoDetect</span></code> is true and the
virtual CD-ROM device is not connected or no suitable device is
available on the host.</p></li>
<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
automatically detect a suitable host device.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType.HOST_DEVICE"title="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType.HOST_DEVICE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cdrom.BackingType.HOST_DEVICE</span></code></a>.</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"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">BackingSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">iso_file</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">host_device</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">device_access_type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cdrom.BackingSpec</span></code> class provides a specification of the physical
resource backing a virtual CD-ROM device.</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>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
device backing.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType.ISO_FILE"title="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType.ISO_FILE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cdrom.BackingType.ISO_FILE</span></code></a>.</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
backing.
If None, the virtual CD-ROM device will be configured to
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"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">BackingType</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cdrom.BackingType</span></code> class defines the valid backing types for a
virtual CD-ROM device.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">BackingType</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">CLIENT_DEVICE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">BackingType(string='CLIENT_DEVICE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType.CLIENT_DEVICE"title="Permalink to this definition">¶</a></dt>
<dd><p>Virtual CD-ROM device is backed by a device on the client that is connected
<codeclass="sig-name descname"><spanclass="pre">HOST_DEVICE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">BackingType(string='HOST_DEVICE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType.HOST_DEVICE"title="Permalink to this definition">¶</a></dt>
<dd><p>Virtual CD-ROM device is backed by a device on the host where the virtual
<codeclass="sig-name descname"><spanclass="pre">ISO_FILE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">BackingType(string='ISO_FILE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType.ISO_FILE"title="Permalink to this definition">¶</a></dt>
<dd><p>Virtual CD-ROM device is backed by an ISO file.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">CreateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">ide</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">sata</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">backing</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">start_connected</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">allow_guest_control</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.CreateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cdrom.CreateSpec</span></code> class provides a specification for the
configuration of a newly-created virtual CD-ROM device.</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>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.
If None, the server will choose an available address; if none is
available, the request will fail.</p></li>
<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.
If None, the server will choose an available address; if none is
available, the request will fail.</p></li>
<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
whenever the virtual machine is powered on.
Defaults to false if None.</p></li>
<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"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">DeviceAccessType</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.DeviceAccessType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cdrom.DeviceAccessType</span></code> class defines the valid device access types
for a physical device packing of a virtual CD-ROM device.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DeviceAccessType</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">EMULATION</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">DeviceAccessType(string='EMULATION')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.DeviceAccessType.EMULATION"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">PASSTHRU</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">DeviceAccessType(string='PASSTHRU')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.DeviceAccessType.PASSTHRU"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">PASSTHRU_EXCLUSIVE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">DeviceAccessType(string='PASSTHRU_EXCLUSIVE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.DeviceAccessType.PASSTHRU_EXCLUSIVE"title="Permalink to this definition">¶</a></dt>
<dd><p>Raw passthru device access, with exclusive access to the device.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">HostBusAdapterType</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.HostBusAdapterType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cdrom.HostBusAdapterType</span></code> class defines the valid types of host bus
adapters that may be used for attaching a Cdrom to a virtual machine.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">HostBusAdapterType</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">IDE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">HostBusAdapterType(string='IDE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.HostBusAdapterType.IDE"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">SATA</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">HostBusAdapterType(string='SATA')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.HostBusAdapterType.SATA"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cdrom.Info</span></code> class contains information about a virtual CD-ROM
device.</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>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.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.HostBusAdapterType.IDE"title="com.vmware.vcenter.vm.hardware_client.Cdrom.HostBusAdapterType.IDE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cdrom.HostBusAdapterType.IDE</span></code></a>.</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.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.HostBusAdapterType.SATA"title="com.vmware.vcenter.vm.hardware_client.Cdrom.HostBusAdapterType.SATA"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cdrom.HostBusAdapterType.SATA</span></code></a>.</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"><spanclass="pre">RESOURCE_TYPE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'com.vmware.vcenter.vm.hardware.Cdrom'</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<dd><p>Resource type for the virtual CD-ROM device.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Summary</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cdrom</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></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"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">UpdateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">backing</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">start_connected</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">allow_guest_control</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.UpdateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cdrom.UpdateSpec</span></code> class describes the updates to be made to the
configuration of a virtual CD-ROM device.</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>backing</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingSpec"title="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cdrom.BackingSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Physical resource backing for the virtual CD-ROM device.</p>
<p>This attribute may only be modified if the virtual machine is not
powered on or the virtual CD-ROM device is not connected.
If None, the value is unchanged.</p>
</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
whenever the virtual machine is powered on.
If None, the value is unchanged.</p></li>
<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"><spanclass="pre">connect</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">cdrom</span></span></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"><spanclass="pre">create</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.create"title="Permalink to this definition">¶</a></dt>
<dd><p>Adds a virtual CD-ROM device to the virtual machine.</p>
<codeclass="sig-name descname"><spanclass="pre">delete</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">cdrom</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Removes a virtual CD-ROM device from the virtual machine.</p>
<codeclass="sig-name descname"><spanclass="pre">disconnect</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">cdrom</span></span></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"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">cdrom</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about a virtual CD-ROM device.</p>
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns commonly used information about the virtual CD-ROM devices
<codeclass="sig-name descname"><spanclass="pre">update</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">cdrom</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cdrom.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Updates the configuration of a virtual CD-ROM device.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm.hardware_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ConnectionCreateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">start_connected</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">allow_guest_control</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.ConnectionCreateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ConnectionCreateSpec</span></code> class provides a specification for the
configuration of a newly-created removable device.</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>start_connected</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating whether the virtual device should be connected
whenever the virtual machine is powered on.
Defaults to false if None.</p></li>
<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"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm.hardware_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ConnectionInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">state</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">start_connected</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">allow_guest_control</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.ConnectionInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ConnectionInfo</span></code> class provides information about the state and
configuration of a removable virtual device.</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>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"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm.hardware_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ConnectionState</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.ConnectionState"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ConnectionState</span></code> class defines the valid states for a removable
device that is configured to be connected.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <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> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">CONNECTED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ConnectionState(string='CONNECTED')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.ConnectionState.CONNECTED"title="Permalink to this definition">¶</a></dt>
<dd><p>The device is connected and working correctly.</p>
<codeclass="sig-name descname"><spanclass="pre">NOT_CONNECTED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ConnectionState(string='NOT_CONNECTED')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.ConnectionState.NOT_CONNECTED"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">RECOVERABLE_ERROR</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ConnectionState(string='RECOVERABLE_ERROR')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.ConnectionState.RECOVERABLE_ERROR"title="Permalink to this definition">¶</a></dt>
<dd><p>Device connection failed due to a recoverable error; for example, the
virtual device backing is currently in use by another virtual machine.</p>
<codeclass="sig-name descname"><spanclass="pre">UNKNOWN</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ConnectionState(string='UNKNOWN')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.ConnectionState.UNKNOWN"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">UNRECOVERABLE_ERROR</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ConnectionState(string='UNRECOVERABLE_ERROR')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.ConnectionState.UNRECOVERABLE_ERROR"title="Permalink to this definition">¶</a></dt>
<dd><p>Device connection failed due to an unrecoverable error; for example, the
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm.hardware_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ConnectionUpdateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">start_connected</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">allow_guest_control</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.ConnectionUpdateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ConnectionUpdateSpec</span></code> class describes the updates to be made to the
configuration of a removable virtual device.</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>start_connected</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating whether the virtual device should be connected
whenever the virtual machine is powered on.
If None, the value is unchanged.</p></li>
<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"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm.hardware_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Cpu</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cpu"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cpu</span></code> class provides methods for configuring the CPU settings of a
virtual machine.</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"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Info</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">count</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">cores_per_socket</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">hot_add_enabled</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">hot_remove_enabled</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cpu.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cpu.Info</span></code> class contains CPU-related information about a virtual
machine.</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>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"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">UpdateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">count</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">cores_per_socket</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">hot_add_enabled</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">hot_remove_enabled</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cpu.UpdateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cpu.UpdateSpec</span></code> class describes the updates to be made to the
CPU-related settings of a virtual machine.</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>count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>New number of CPU cores. The number of CPU cores in the virtual
machine must be a multiple of the number of cores per socket.</p>
<p>The supported range of CPU counts is constrained by the configured
guest operating system and virtual hardware version of the virtual
machine.</p>
<p>If the virtual machine is running, the number of CPU cores may only
be increased if <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cpu.Info.hot_add_enabled</span></code> is true, and may
only be decreased if <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cpu.Info.hot_remove_enabled</span></code> is true.
If None, the value is unchanged.</p>
</p></li>
<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
virtual machine must be a multiple of the number of cores per
socket.
If None, the value is unchanged.</p></li>
<li><p><strong>hot_add_enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Flag indicating whether adding CPUs while the virtual machine is
running is enabled.</p>
<p>This attribute may only be modified if the virtual machine is
powered off.
If None, the value is unchanged.</p>
</p></li>
<li><p><strong>hot_remove_enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Flag indicating whether removing CPUs while the virtual machine is
running is enabled.</p>
<p>This attribute may only be modified if the virtual machine is
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cpu.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the CPU-related settings of a virtual machine.</p>
<codeclass="sig-name descname"><spanclass="pre">update</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Cpu.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Updates the CPU-related settings of a virtual machine.</p>
<li><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"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm.hardware_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Disk</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></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>
<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"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">BackingInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">vmdk_file</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Disk.BackingInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Disk.BackingInfo</span></code> class contains information about the physical
resource backing a virtual disk.</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>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.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Disk.BackingType.VMDK_FILE"title="com.vmware.vcenter.vm.hardware_client.Disk.BackingType.VMDK_FILE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Disk.BackingType.VMDK_FILE</span></code></a>.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">BackingSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">vmdk_file</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Disk.BackingSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Disk.BackingSpec</span></code> class provides a specification of the physical
resource backing a virtual disk.</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>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.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Disk.BackingType.VMDK_FILE"title="com.vmware.vcenter.vm.hardware_client.Disk.BackingType.VMDK_FILE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Disk.BackingType.VMDK_FILE</span></code></a>.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">BackingType</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Disk.BackingType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Disk.BackingType</span></code> class defines the valid backing types for a
virtual disk.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">BackingType</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">VMDK_FILE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">BackingType(string='VMDK_FILE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Disk.BackingType.VMDK_FILE"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">CreateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">ide</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">scsi</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">sata</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">backing</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">new_vmdk</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Disk.CreateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Disk.CreateSpec</span></code> class provides a specification for the
configuration of a newly-created virtual disk.</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>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.
If None, the server will choose an available address; if none is
available, the request will fail.</p></li>
<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.
If None, the server will choose an available address; if none is
available, the request will fail.</p></li>
<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.
If None, the server will choose an available address; if none is
available, the request will fail.</p></li>
<li><p><strong>backing</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Disk.BackingSpec"title="com.vmware.vcenter.vm.hardware_client.Disk.BackingSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Disk.BackingSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Existing physical resource backing for the virtual disk. Exactly
one of <codeclass="docutils literal notranslate"><spanclass="pre">backing</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">newVmdk</span></code> must be specified.
If None, the virtual disk will not be connected to an existing
backing.</p></li>
<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.
If None, a new VMDK backing will not be created.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">HostBusAdapterType</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Disk.HostBusAdapterType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Disk.HostBusAdapterType</span></code> class defines the valid types of host bus
adapters that may be used for attaching a virtual storage device to a
virtual machine.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">HostBusAdapterType</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">IDE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">HostBusAdapterType(string='IDE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Disk.HostBusAdapterType.IDE"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">SATA</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">HostBusAdapterType(string='SATA')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Disk.HostBusAdapterType.SATA"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">SCSI</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">HostBusAdapterType(string='SCSI')</span></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"><spanclass="pre">RESOURCE_TYPE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'com.vmware.vcenter.vm.hardware.Disk'</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Disk.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">StoragePolicySpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">policy</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Disk.StoragePolicySpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Disk.StoragePolicySpec</span></code> class contains information about the storage
policy be associated with a VMDK file. This class was added in vSphere API
6.7.</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>policy</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the storage policy which should be associated with
the VMDK file. This attribute was added in vSphere API 6.7.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.StoragePolicy</span></code>. When methods return a value
of this class as a return value, the attribute will be an
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Summary</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">disk</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></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"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">UpdateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">backing</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></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"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">VmdkCreateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">capacity</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">storage_policy</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></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’
file extension.
If None, a name (derived from the name of the virtual machine) will
be chosen by the server.</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 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
storage policy that is to be associated the with VMDK file. This
attribute was added in vSphere API 6.7.
If None the default storage policy of the target datastore (if
applicable) is applied. Currently a default storage policy is only
supported by object based datastores : VVol & vSAN. For non- object
datastores, if None then no storage policy would be associated with
<codeclass="sig-name descname"><spanclass="pre">create</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Disk.create"title="Permalink to this definition">¶</a></dt>
<dd><p>Adds a virtual disk to the virtual machine. While adding the virtual
disk, a new VMDK file may be created or an existing VMDK file may be
<li><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"><spanclass="pre">delete</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">disk</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Disk.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Removes a virtual disk from the virtual machine. This method does not
destroy the VMDK file that backs the virtual disk. It only detaches the
VMDK file from the virtual machine. Once detached, the VMDK file will
not be destroyed when the virtual machine to which it was associated is
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">disk</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Disk.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about a virtual disk.</p>
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Disk.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns commonly used information about the virtual disks belonging to
<codeclass="sig-name descname"><spanclass="pre">update</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">disk</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Disk.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Updates the configuration of a virtual disk. An update method can be
used to detach the existing VMDK file and attach another VMDK file to
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm.hardware_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Ethernet</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Ethernet</span></code> class provides methods for configuring the virtual
Ethernet adapters of a virtual machine.</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>
<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> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifier of the network backing the virtual Ethernet adapter.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">Network</span></code>.
When methods return a value of this class as a return value, the
attribute will be an identifier for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">Network</span></code>.
If None, the identifier of the network backing could not be
determined.</p></li>
<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
adapter.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.STANDARD_PORTGROUP"title="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.STANDARD_PORTGROUP"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Ethernet.BackingType.STANDARD_PORTGROUP</span></code></a>.</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.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.HOST_DEVICE"title="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.HOST_DEVICE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Ethernet.BackingType.HOST_DEVICE</span></code></a>.</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
Ethernet adapter.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.DISTRIBUTED_PORTGROUP"title="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.DISTRIBUTED_PORTGROUP"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Ethernet.BackingType.DISTRIBUTED_PORTGROUP</span></code></a>.</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
adapter.
This attribute will be None if the virtual Ethernet device is not
bound to a distributed virtual port; this can happen if the virtual
machine is powered off or the virtual Ethernet device is not
connected.</p></li>
<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.
This ookie may be used to verify that the virtual machine is the
rightful owner of the port.
This attribute will be None if the virtual Ethernet device is not
bound to a distributed virtual port; this can happen if the virtual
machine is powered off or the virtual Ethernet device is not
connected.</p></li>
<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.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.OPAQUE_NETWORK"title="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.OPAQUE_NETWORK"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Ethernet.BackingType.OPAQUE_NETWORK</span></code></a>.</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
adapter.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.OPAQUE_NETWORK"title="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.OPAQUE_NETWORK"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Ethernet.BackingType.OPAQUE_NETWORK</span></code></a>.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">BackingSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">network</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">distributed_port</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></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.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">Network</span></code>.
When methods return a value of this class as a return value, the
attribute will be an identifier for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">Network</span></code>.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is one of
<li><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
adapter. Depending on the type of the Portgroup, the port may be
specified using this field. If the portgroup type is early-binding
(also known as static), a port is assigned when the Ethernet
adapter is configured to use the port. The port may be either
automatically or specifically assigned based on the value of this
attribute. If the portgroup type is ephemeral, the port is created
and assigned to a virtual machine when it is powered on and the
Ethernet adapter is connected. This attribute cannot be specified
as no free ports exist before use.
May be used to specify a port when the network specified on the
<codeclass="docutils literal notranslate"><spanclass="pre">network</span></code> attribute is a static or early binding distributed
portgroup. If None, the port will be automatically assigned to the
Ethernet adapter based on the policy embodied by the portgroup
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">BackingType</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Ethernet.BackingType</span></code> class defines the valid backing types for a
virtual Ethernet adapter.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">BackingType</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">DISTRIBUTED_PORTGROUP</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">BackingType(string='DISTRIBUTED_PORTGROUP')</span></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"><spanclass="pre">HOST_DEVICE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">BackingType(string='HOST_DEVICE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.HOST_DEVICE"title="Permalink to this definition">¶</a></dt>
<dd><p>Legacy host device network backing. Imported VMs may have virtual Ethernet
adapters with this type of backing, but this type of backing cannot be used
to create or to update a virtual Ethernet adapter.</p>
<codeclass="sig-name descname"><spanclass="pre">OPAQUE_NETWORK</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">BackingType(string='OPAQUE_NETWORK')</span></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"><spanclass="pre">STANDARD_PORTGROUP</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">BackingType(string='STANDARD_PORTGROUP')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.STANDARD_PORTGROUP"title="Permalink to this definition">¶</a></dt>
<dd><p>vSphere standard portgroup network backing.</p>
If None, defaults to a guest-specific type.</p></li>
<li><p><strong>upt_compatibility_enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating whether Universal Pass-Through (UPT) compatibility
is enabled on this virtual Ethernet adapter.
If None, defaults to false.</p></li>
<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
address is invalid, the server will change when it the VM is
started or as the device is hot added.
If None, the server will choose an available address when the
virtual machine is powered on.</p></li>
<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
Ethernet adapter.
Defaults to false if None.</p></li>
<li><p><strong>backing</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingSpec"title="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Ethernet.BackingSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Physical resource backing for the virtual Ethernet adapter.
If None, the system may try to find an appropriate backing. If one
is not found, the request will fail.</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
whenever the virtual machine is powered on.
Defaults to false if None.</p></li>
<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"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">EmulationType</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Ethernet.EmulationType</span></code> class defines the valid emulation types for
a virtual Ethernet adapter.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">EmulationType</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">E1000</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">EmulationType(string='E1000')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType.E1000"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">E1000E</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">EmulationType(string='E1000E')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType.E1000E"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">PCNET32</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">EmulationType(string='PCNET32')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType.PCNET32"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">VMXNET</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">EmulationType(string='VMXNET')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType.VMXNET"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">VMXNET2</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">EmulationType(string='VMXNET2')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType.VMXNET2"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">VMXNET3</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">EmulationType(string='VMXNET3')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType.VMXNET3"title="Permalink to this definition">¶</a></dt>
<li><p><strong>mac_address</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – MAC address.
May be None if <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Ethernet.Info.mac_type</span></code> is
<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType.MANUAL"title="com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType.MANUAL"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Ethernet.MacAddressType.MANUAL</span></code></a> and has not been specified,
or if <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Ethernet.Info.mac_type</span></code> is
<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType.GENERATED"title="com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType.GENERATED"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Ethernet.MacAddressType.GENERATED</span></code></a> and the virtual machine
has never been powered on since the Ethernet adapter was created.</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
address is invalid, the server will change it when the VM is
started or as the device is hot added.
May be None if the virtual machine has never been powered on since
the adapter was created.</p></li>
<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"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">MacAddressType</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Ethernet.MacAddressType</span></code> class defines the valid MAC address origins
for a virtual Ethernet adapter.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">MacAddressType</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">ASSIGNED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">MacAddressType(string='ASSIGNED')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType.ASSIGNED"title="Permalink to this definition">¶</a></dt>
<dd><p>MAC address is assigned by vCenter Server.</p>
<codeclass="sig-name descname"><spanclass="pre">GENERATED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">MacAddressType(string='GENERATED')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType.GENERATED"title="Permalink to this definition">¶</a></dt>
<dd><p>MAC address is generated automatically.</p>
<codeclass="sig-name descname"><spanclass="pre">MANUAL</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">MacAddressType(string='MANUAL')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType.MANUAL"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">RESOURCE_TYPE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'com.vmware.vcenter.vm.hardware.Ethernet'</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<dd><p>Resource type for the virtual Ethernet adapter.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Summary</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">nic</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></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>
</p></li>
<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
virtual Ethernet adapter.</p>
<p>This attribute may be modified at any time, and changes will be
applied the next time the virtual machine is powered on.
If None, the value is unchanged.</p>
</p></li>
<li><p><strong>backing</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingSpec"title="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Ethernet.BackingSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Physical resource backing for the virtual Ethernet adapter.</p>
<p>This attribute may be modified at any time, and changes will be
applied the next time the virtual machine is powered on.
If None, the value is unchanged.</p>
</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
whenever the virtual machine is powered on.
If None, the value is unchanged.</p></li>
<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"><spanclass="pre">connect</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">nic</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.connect"title="Permalink to this definition">¶</a></dt>
<dd><p>Connects a virtual Ethernet adapter of a powered-on virtual machine to
its backing. Connecting the virtual device makes the backing accessible
from the perspective of the guest operating system.</p>
<p>For a powered-off virtual machine, the <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.update"title="com.vmware.vcenter.vm.hardware_client.Ethernet.update"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Ethernet.update()</span></code></a> method
may be used to configure the virtual Ethernet adapter to start in the
connected state when the virtual machine is powered on.</p>
<codeclass="sig-name descname"><spanclass="pre">create</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.create"title="Permalink to this definition">¶</a></dt>
<dd><p>Adds a virtual Ethernet adapter to the virtual machine.</p>
<codeclass="sig-name descname"><spanclass="pre">delete</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">nic</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Removes a virtual Ethernet adapter from the virtual machine.</p>
<codeclass="sig-name descname"><spanclass="pre">disconnect</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">nic</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.disconnect"title="Permalink to this definition">¶</a></dt>
<dd><p>Disconnects a virtual Ethernet adapter of a powered-on virtual machine
from its backing. The virtual device is still present and its backing
configuration is unchanged, but from the perspective of the guest
operating system, the Ethernet adapter is not connected to its backing
resource.</p>
<p>For a powered-off virtual machine, the <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.update"title="com.vmware.vcenter.vm.hardware_client.Ethernet.update"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Ethernet.update()</span></code></a> method
may be used to configure the virtual Ethernet adapter to start in the
disconnected state when the virtual machine is powered on.</p>
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">nic</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about a virtual Ethernet adapter.</p>
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns commonly used information about the virtual Ethernet adapters
<codeclass="sig-name descname"><spanclass="pre">update</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">nic</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Ethernet.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Updates the configuration of a virtual Ethernet adapter.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm.hardware_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Floppy</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Floppy"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Floppy</span></code> class provides methods for configuring the virtual floppy
drives of a virtual machine.</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"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">BackingInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">image_file</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">host_device</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">auto_detect</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Floppy.BackingInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Floppy.BackingInfo</span></code> class contains information about the physical
resource backing a virtual floppy drive.</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>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 backing the virtual floppy drive.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Floppy.BackingType.IMAGE_FILE"title="com.vmware.vcenter.vm.hardware_client.Floppy.BackingType.IMAGE_FILE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Floppy.BackingType.IMAGE_FILE</span></code></a>.</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.
This attribute will be None if <codeclass="docutils literal notranslate"><spanclass="pre">autoDetect</span></code> is true and the
virtual floppy drive is not connected or no suitable device is
available on the host.</p></li>
<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
automatically detect a suitable host device.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Floppy.BackingType.HOST_DEVICE"title="com.vmware.vcenter.vm.hardware_client.Floppy.BackingType.HOST_DEVICE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Floppy.BackingType.HOST_DEVICE</span></code></a>.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">BackingSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">image_file</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">host_device</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Floppy.BackingSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Floppy.BackingSpec</span></code> class provides a specification of the physical
resource backing a virtual floppy drive.</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>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
drive backing.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Floppy.BackingType.IMAGE_FILE"title="com.vmware.vcenter.vm.hardware_client.Floppy.BackingType.IMAGE_FILE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Floppy.BackingType.IMAGE_FILE</span></code></a>.</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
backing.
If None, the virtual floppy drive will be configured to
automatically detect a suitable host device.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">BackingType</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Floppy.BackingType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Floppy.BackingType</span></code> class defines the valid backing types for a
virtual floppy drive.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">BackingType</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">CLIENT_DEVICE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">BackingType(string='CLIENT_DEVICE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Floppy.BackingType.CLIENT_DEVICE"title="Permalink to this definition">¶</a></dt>
<dd><p>Virtual floppy drive is backed by a device on the client that is connected
<codeclass="sig-name descname"><spanclass="pre">HOST_DEVICE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">BackingType(string='HOST_DEVICE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Floppy.BackingType.HOST_DEVICE"title="Permalink to this definition">¶</a></dt>
<dd><p>Virtual floppy drive is backed by a device on the host where the virtual
<codeclass="sig-name descname"><spanclass="pre">IMAGE_FILE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">BackingType(string='IMAGE_FILE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Floppy.BackingType.IMAGE_FILE"title="Permalink to this definition">¶</a></dt>
<dd><p>Virtual floppy drive is backed by an image file.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">CreateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">backing</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">start_connected</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">allow_guest_control</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Floppy.CreateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Floppy.CreateSpec</span></code> class provides a specification for the
configuration of a newly-created virtual floppy drive.</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>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
whenever the virtual machine is powered on.
Defaults to false if None.</p></li>
<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"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Info</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">label</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">backing</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">state</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">start_connected</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">allow_guest_control</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></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"><spanclass="pre">RESOURCE_TYPE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'com.vmware.vcenter.vm.hardware.Floppy'</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Floppy.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<dd><p>Resource type for the virtual floppy drive device.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Summary</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">floppy</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></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"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">UpdateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">backing</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">start_connected</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">allow_guest_control</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Floppy.UpdateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Floppy.UpdateSpec</span></code> class describes the updates to be made to the
configuration of a virtual floppy drive.</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>backing</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Floppy.BackingSpec"title="com.vmware.vcenter.vm.hardware_client.Floppy.BackingSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Floppy.BackingSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Physical resource backing for the virtual floppy drive.</p>
<p>This attribute may only be modified if the virtual machine is not
powered on or the virtual floppy drive is not connected.
If None, the value is unchanged.</p>
</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
whenever the virtual machine is powered on.
If None, the value is unchanged.</p></li>
<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"><spanclass="pre">connect</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">floppy</span></span></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"><spanclass="pre">create</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Floppy.create"title="Permalink to this definition">¶</a></dt>
<dd><p>Adds a virtual floppy drive to the virtual machine.</p>
<codeclass="sig-name descname"><spanclass="pre">delete</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">floppy</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Floppy.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Removes a virtual floppy drive from the virtual machine.</p>
<codeclass="sig-name descname"><spanclass="pre">disconnect</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">floppy</span></span></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"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">floppy</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Floppy.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about a virtual floppy drive.</p>
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Floppy.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns commonly used information about the virtual floppy drives
<codeclass="sig-name descname"><spanclass="pre">update</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">floppy</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Floppy.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Updates the configuration of a virtual floppy drive.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm.hardware_client.</span></code><codeclass="sig-name descname"><spanclass="pre">IdeAddressInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">primary</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">master</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.IdeAddressInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">IdeAddressInfo</span></code> class contains information about the address of a
virtual device that is attached to a virtual IDE adapter of a virtual
machine.</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>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"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm.hardware_client.</span></code><codeclass="sig-name descname"><spanclass="pre">IdeAddressSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">primary</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">master</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.IdeAddressSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">IdeAddressSpec</span></code> class contains information for specifying the
address of a virtual device that is attached to a virtual IDE adapter of a
virtual machine.</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>primary</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag specifying whether the device should be attached to the
primary or secondary IDE adapter of the virtual machine.
If None, the server will choose a adapter with an available
connection. If no IDE connections are available, the request will
be rejected.</p></li>
<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
device on the IDE adapter.
If None, the server will choose an available connection type. If no
IDE connections are available, the request will be rejected.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm.hardware_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Memory</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Memory"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Memory</span></code> class provides methods for configuring the memory settings
of a virtual machine.</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"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Info</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">size_mib</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">hot_add_enabled</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">hot_add_increment_size_mib</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">hot_add_limit_mib</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></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_enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) –<p>Flag indicating whether adding memory while the virtual machine is
running is enabled.</p>
<p>Some guest operating systems may consume more resources or perform
less efficiently when they run on hardware that supports adding
memory while the machine is running.</p>
</p></li>
<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
running virtual machine.</p>
<p>When adding memory to a running virtual machine, the amount of
memory added must be at least
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Memory.Info.hot_add_increment_size_mib</span></code> and the total memory
size of the virtual machine must be a multiple of
{\@link>hotAddIncrementSize}.
Only set when <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Memory.Info.hot_add_enabled</span></code> is true and the
virtual machine is running.</p>
</p></li>
<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
running virtual machine.
Only set when <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Memory.Info.hot_add_enabled</span></code> is true and the
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">UpdateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">size_mib</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">hot_add_enabled</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></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"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Memory.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the memory-related settings of a virtual machine.</p>
<codeclass="sig-name descname"><spanclass="pre">update</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Memory.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Updates the memory-related settings of a virtual machine.</p>
<li><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"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm.hardware_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Parallel</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Parallel"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Parallel</span></code> class provides methods for configuring the virtual
parallel ports of a virtual machine.</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"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">BackingInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">file</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">host_device</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">auto_detect</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Parallel.BackingInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Parallel.BackingInfo</span></code> class contains information about the physical
resource backing a virtual parallel port.</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>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 backing the virtual parallel port.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Parallel.BackingType.FILE"title="com.vmware.vcenter.vm.hardware_client.Parallel.BackingType.FILE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Parallel.BackingType.FILE</span></code></a>.</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.
This attribute will be None if <codeclass="docutils literal notranslate"><spanclass="pre">autoDetect</span></code> is true and the
virtual parallel port is not connected or no suitable device is
available on the host.</p></li>
<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
automatically detect a suitable host device.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Parallel.BackingType.HOST_DEVICE"title="com.vmware.vcenter.vm.hardware_client.Parallel.BackingType.HOST_DEVICE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Parallel.BackingType.HOST_DEVICE</span></code></a>.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">BackingSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">file</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">host_device</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Parallel.BackingSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Parallel.BackingSpec</span></code> class provides a specification of the physical
resource backing a virtual parallel port.</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>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
backing.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Parallel.BackingType.FILE"title="com.vmware.vcenter.vm.hardware_client.Parallel.BackingType.FILE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Parallel.BackingType.FILE</span></code></a>.</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
backing.
If None, the virtual parallel port will be configured to
automatically detect a suitable host device.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">BackingType</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Parallel.BackingType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Parallel.BackingType</span></code> class defines the valid backing types for a
virtual parallel port.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="sig-name descname"><spanclass="pre">FILE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">BackingType(string='FILE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Parallel.BackingType.FILE"title="Permalink to this definition">¶</a></dt>
<dd><p>Virtual parallel port is backed by a file.</p>
<codeclass="sig-name descname"><spanclass="pre">HOST_DEVICE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">BackingType(string='HOST_DEVICE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Parallel.BackingType.HOST_DEVICE"title="Permalink to this definition">¶</a></dt>
<dd><p>Virtual parallel port is backed by a device on the host where the virtual
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">CreateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">backing</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">start_connected</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">allow_guest_control</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Parallel.CreateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Parallel.CreateSpec</span></code> class provides a specification for the
configuration of a newly-created virtual parallel port.</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>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
whenever the virtual machine is powered on.
Defaults to false if None.</p></li>
<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"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Info</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">label</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">backing</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">state</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">start_connected</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">allow_guest_control</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></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"><spanclass="pre">RESOURCE_TYPE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'com.vmware.vcenter.vm.hardware.ParallelPort'</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Parallel.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<dd><p>Resource type for the virtual parallel port.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Summary</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">port</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></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"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">UpdateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">backing</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">start_connected</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">allow_guest_control</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Parallel.UpdateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Parallel.UpdateSpec</span></code> class describes the updates to be made to the
configuration of a virtual parallel port.</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>backing</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Parallel.BackingSpec"title="com.vmware.vcenter.vm.hardware_client.Parallel.BackingSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Parallel.BackingSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Physical resource backing for the virtual parallel port.</p>
<p>This attribute may only be modified if the virtual machine is not
powered on or the virtual parallel port is not connected.
If None, the value is unchanged.</p>
</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
whenever the virtual machine is powered on.
If None, the value is unchanged.</p></li>
<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"><spanclass="pre">connect</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">port</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Parallel.connect"title="Permalink to this definition">¶</a></dt>
<dd><p>Connects a virtual parallel port of a powered-on virtual machine to its
backing. Connecting the virtual device makes the backing accessible
from the perspective of the guest operating system.</p>
<p>For a powered-off virtual machine, the <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Parallel.update"title="com.vmware.vcenter.vm.hardware_client.Parallel.update"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Parallel.update()</span></code></a> method
may be used to configure the virtual parallel port to start in the
connected state when the virtual machine is powered on.</p>
<codeclass="sig-name descname"><spanclass="pre">create</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Parallel.create"title="Permalink to this definition">¶</a></dt>
<dd><p>Adds a virtual parallel port to the virtual machine.</p>
<codeclass="sig-name descname"><spanclass="pre">delete</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">port</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Parallel.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Removes a virtual parallel port from the virtual machine.</p>
<codeclass="sig-name descname"><spanclass="pre">disconnect</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">port</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Parallel.disconnect"title="Permalink to this definition">¶</a></dt>
<dd><p>Disconnects a virtual parallel port of a powered-on virtual machine
from its backing. The virtual device is still present and its backing
configuration is unchanged, but from the perspective of the guest
operating system, the parallel port is not connected to its backing.</p>
<p>For a powered-off virtual machine, the <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Parallel.update"title="com.vmware.vcenter.vm.hardware_client.Parallel.update"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Parallel.update()</span></code></a> method
may be used to configure the virtual parallel port to start in the
disconnected state when the virtual machine is powered on.</p>
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">port</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Parallel.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about a virtual parallel port.</p>
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Parallel.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns commonly used information about the virtual parallel ports
<codeclass="sig-name descname"><spanclass="pre">update</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">port</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Parallel.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Updates the configuration of a virtual parallel port.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm.hardware_client.</span></code><codeclass="sig-name descname"><spanclass="pre">SataAddressInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">bus</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">unit</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.SataAddressInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">SataAddressInfo</span></code> class contains information about the address of a
virtual device that is attached to a virtual SATA adapter of a virtual
machine.</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>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"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm.hardware_client.</span></code><codeclass="sig-name descname"><spanclass="pre">SataAddressSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">bus</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">unit</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.SataAddressSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">SataAddressSpec</span></code> class contains information for specifying the
address of a virtual device that is attached to a virtual SATA adapter of a
virtual machine.</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>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.
If None, the server will choose an available unit number on the
specified adapter. If there are no available connections on the
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm.hardware_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ScsiAddressInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">bus</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">unit</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.ScsiAddressInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ScsiAddressInfo</span></code> class contains information about the address of a
virtual device that is attached to a virtual SCSI adapter of a virtual
machine.</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>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"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm.hardware_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ScsiAddressSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">bus</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">unit</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.ScsiAddressSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ScsiAddressSpec</span></code> class contains information for specifying the
address of a virtual device that is attached to a virtual SCSI adapter of a
virtual machine.</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>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.
If None, the server will choose an available unit number on the
specified adapter. If there are no available connections on the
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm.hardware_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Serial</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Serial"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Serial</span></code> class provides methods for configuring the virtual serial
ports of a virtual machine.</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>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Serial.BackingInfo</span></code> class contains information about the physical
resource backing a virtual serial port.</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>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.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.FILE"title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.FILE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Serial.BackingType.FILE</span></code></a>.</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.
This attribute will be None if <codeclass="docutils literal notranslate"><spanclass="pre">autoDetect</span></code> is true and the
virtual serial port is not connected or no suitable device is
available on the host.</p></li>
<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
automatically detect a suitable host device.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.HOST_DEVICE"title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.HOST_DEVICE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Serial.BackingType.HOST_DEVICE</span></code></a>.</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
virtual serial port.</p>
<ul>
<li><p>If <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Serial.BackingInfo.type</span></code> is
<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_SERVER"title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_SERVER"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Serial.BackingType.NETWORK_SERVER</span></code></a>, this attribute is the
location used by clients to connect to this server. The hostname
part of the URI should either be empty or should specify the
address of the host on which the virtual machine is running.</p></li>
<li><p>If <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Serial.BackingInfo.type</span></code> is
<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_CLIENT"title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_CLIENT"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Serial.BackingType.NETWORK_CLIENT</span></code></a>, this attribute is the
location used by the virtual machine to connect to the remote
server.</p></li>
</ul>
<p>This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is one of <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_SERVER"title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_SERVER"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Serial.BackingType.NETWORK_SERVER</span></code></a> or
<li><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.
If set, the virtual machine initiates a connection with the proxy
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Serial.BackingSpec</span></code> class provides a specification of the physical
resource backing a virtual serial port.</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>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.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.FILE"title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.FILE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Serial.BackingType.FILE</span></code></a>.</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.
If None, the virtual serial port will be configured to
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
value is true, the host buffers data to prevent data overrun. This
allows the virtual machine to read all of the data transferred over
the pipe with no data loss.
If None, defaults to false.</p></li>
<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
virtual serial port.</p>
<ul>
<li><p>If <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Serial.BackingSpec.type</span></code> is
<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_SERVER"title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_SERVER"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Serial.BackingType.NETWORK_SERVER</span></code></a>, this attribute is the
location used by clients to connect to this server. The hostname
part of the URI should either be empty or should specify the
address of the host on which the virtual machine is running.</p></li>
<li><p>If <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Serial.BackingSpec.type</span></code> is
<aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_CLIENT"title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_CLIENT"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Serial.BackingType.NETWORK_CLIENT</span></code></a>, this attribute is the
location used by the virtual machine to connect to the remote
server.</p></li>
</ul>
<p>This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is one of <aclass="reference internal"href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_SERVER"title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_SERVER"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Serial.BackingType.NETWORK_SERVER</span></code></a> or
<li><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.
If set, the virtual machine initiates a connection with the proxy
service and forwards the traffic to the proxy.
If None, no proxy service should be used.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">BackingType</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Serial.BackingType</span></code> class defines the valid backing types for a
virtual serial port.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">BackingType</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">FILE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">BackingType(string='FILE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.FILE"title="Permalink to this definition">¶</a></dt>
<dd><p>Virtual serial port is backed by a file.</p>
<codeclass="sig-name descname"><spanclass="pre">HOST_DEVICE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">BackingType(string='HOST_DEVICE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.HOST_DEVICE"title="Permalink to this definition">¶</a></dt>
<dd><p>Virtual serial port is backed by a device on the host where the virtual
<codeclass="sig-name descname"><spanclass="pre">NETWORK_CLIENT</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">BackingType(string='NETWORK_CLIENT')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_CLIENT"title="Permalink to this definition">¶</a></dt>
<dd><p>Virtual serial port is backed by a network client. This backing may be used
to create a network-accessible serial port on the virtual machine,
<codeclass="sig-name descname"><spanclass="pre">NETWORK_SERVER</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">BackingType(string='NETWORK_SERVER')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_SERVER"title="Permalink to this definition">¶</a></dt>
<dd><p>Virtual serial port is backed by a network server. This backing may be used
to create a network-accessible serial port on the virtual machine,
<codeclass="sig-name descname"><spanclass="pre">PIPE_CLIENT</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">BackingType(string='PIPE_CLIENT')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.PIPE_CLIENT"title="Permalink to this definition">¶</a></dt>
<dd><p>Virtual serial port is backed by a named pipe client. The virtual machine
will connect to the named pipe provided by a host application or another
virtual machine on the same host. This is useful for capturing debugging
information sent through the virtual serial port.</p>
<codeclass="sig-name descname"><spanclass="pre">PIPE_SERVER</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">BackingType(string='PIPE_SERVER')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.PIPE_SERVER"title="Permalink to this definition">¶</a></dt>
<dd><p>Virtual serial port is backed by a named pipe server. The virtual machine
will accept a connection from a host application or another virtual machine
on the same host. This is useful for capturing debugging information sent
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">CreateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">yield_on_poll</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">backing</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">start_connected</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">allow_guest_control</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Serial.CreateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Serial.CreateSpec</span></code> class provides a specification for the
configuration of a newly-created virtual serial port.</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>yield_on_poll</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – CPU yield behavior. If set to true, the virtual machine will
periodically relinquish the processor if its sole task is polling
the virtual serial port. The amount of time it takes to regain the
processor will depend on the degree of other virtual machine
activity on the host.
If None, defaults to false.</p></li>
<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
whenever the virtual machine is powered on.
Defaults to false if None.</p></li>
<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"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Info</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">label</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">yield_on_poll</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">backing</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">state</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">start_connected</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">allow_guest_control</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Serial.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Serial.Info</span></code> class contains information about a virtual serial port.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
<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
periodically relinquish the processor if its sole task is polling
the virtual serial port. The amount of time it takes to regain the
processor will depend on the degree of other virtual machine
activity on the host.</p></li>
<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"><spanclass="pre">RESOURCE_TYPE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'com.vmware.vcenter.vm.hardware.SerialPort'</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Serial.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<dd><p>Resource type for the virtual serial port device.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Summary</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">port</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Serial.Summary"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Serial.Summary</span></code> class contains commonly used information about a
virtual serial port.</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>port</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the virtual serial port.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vm.hardware.SerialPort</span></code>. When methods return
a value of this class as a return value, the attribute will be an
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">UpdateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">yield_on_poll</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">backing</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">start_connected</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">allow_guest_control</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Serial.UpdateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Serial.UpdateSpec</span></code> class describes the updates to be made to the
configuration of a virtual serial port.</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>yield_on_poll</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>CPU yield behavior. If set to true, the virtual machine will
periodically relinquish the processor if its sole task is polling
the virtual serial port. The amount of time it takes to regain the
processor will depend on the degree of other virtual machine
activity on the host.</p>
<p>This attribute may be modified at any time, and changes applied to
a connected virtual serial port take effect immediately.
If None, the value is unchanged.</p>
</p></li>
<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>
<p>This attribute may only be modified if the virtual machine is not
powered on or the virtual serial port is not connected.
If None, the value is unchanged.</p>
</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
whenever the virtual machine is powered on.
If None, the value is unchanged.</p></li>
<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"><spanclass="pre">connect</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">port</span></span></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"><spanclass="pre">create</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Serial.create"title="Permalink to this definition">¶</a></dt>
<dd><p>Adds a virtual serial port to the virtual machine.</p>
<li><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"><spanclass="pre">delete</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">port</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Serial.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Removes a virtual serial port from the virtual machine.</p>
<codeclass="sig-name descname"><spanclass="pre">disconnect</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">port</span></span></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"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">port</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Serial.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about a virtual serial port.</p>
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Serial.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns commonly used information about the virtual serial ports
<codeclass="sig-name descname"><spanclass="pre">update</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">port</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.hardware_client.Serial.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Updates the configuration of a virtual serial port.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm.hardware_client.</span></code><codeclass="sig-name descname"><spanclass="pre">StubFactory</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">stub_config</span></span></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"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm.storage_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Policy</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.storage_client.Policy"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Policy</span></code> class provides methods to configure the storage policies
associated with the virtual machine home and/or its virtual disks. 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"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">DiskPolicySpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">policy</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.storage_client.Policy.DiskPolicySpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Policy.DiskPolicySpec</span></code> class provides a specification for the
storage policy to be associated with the virtual disks. This class was
added in vSphere API 6.7.</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>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
API 6.7.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.StoragePolicy</span></code>. When methods return a value
of this class as a return value, the attribute will be an
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">PolicyType</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.storage_client.Policy.DiskPolicySpec.PolicyType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Policy.DiskPolicySpec</span></code> class defines the choices for how to specify
the policy to be associated with a virtual disk. This enumeration was added
in vSphere API 6.7.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">PolicyType</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">USE_DEFAULT_POLICY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">PolicyType(string='USE_DEFAULT_POLICY')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.storage_client.Policy.DiskPolicySpec.PolicyType.USE_DEFAULT_POLICY"title="Permalink to this definition">¶</a></dt>
<dd><p>Use the default storage policy of the datastore. This class attribute was
<codeclass="sig-name descname"><spanclass="pre">USE_SPECIFIED_POLICY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">PolicyType(string='USE_SPECIFIED_POLICY')</span></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"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Info</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm_home</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">disks</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></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"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">UpdateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm_home</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">disks</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.storage_client.Policy.UpdateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Policy.UpdateSpec</span></code> class describes the updates to be made to the
storage policies associated with the virtual machine home and/or its
virtual disks. This class was added in vSphere API 6.7.</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>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.
When clients pass a value of this class as a parameter, the key in
the attribute <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> must be an identifier for the resource
type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>. When methods return
a value of this class as a return value, the key in the attribute
<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> will be an identifier for the resource type:
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">VmHomePolicySpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">policy</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.storage_client.Policy.VmHomePolicySpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Policy.VmHomePolicySpec</span></code> class provides a specification for the
storage policy to be associated with the virtual machine home’s directory.
This class was added in vSphere API 6.7.</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>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm.storage_client.Policy.VmHomePolicySpec.PolicyType"title="com.vmware.vcenter.vm.storage_client.Policy.VmHomePolicySpec.PolicyType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Policy.VmHomePolicySpec.PolicyType</span></code></a>) – Policy type to be used while performing update operation on the
virtual machine home’s directory. This attribute was added in
vSphere API 6.7.</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
API 6.7.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.StoragePolicy</span></code>. When methods return a value
of this class as a return value, the attribute will be an
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">PolicyType</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.storage_client.Policy.VmHomePolicySpec.PolicyType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Policy.VmHomePolicySpec.PolicyType</span></code> class defines the choices for
how to specify the policy to be associated with the virtual machine home’s
directory. This enumeration was added in vSphere API 6.7.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">PolicyType</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">USE_DEFAULT_POLICY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">PolicyType(string='USE_DEFAULT_POLICY')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm.storage_client.Policy.VmHomePolicySpec.PolicyType.USE_DEFAULT_POLICY"title="Permalink to this definition">¶</a></dt>
<dd><p>Use the default storage policy of the datastore. This class attribute was
<codeclass="sig-name descname"><spanclass="pre">USE_SPECIFIED_POLICY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">PolicyType(string='USE_SPECIFIED_POLICY')</span></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"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.storage_client.Policy.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns Information about Storage Policy associated with a virtual
machine’s home directory and/or its virtual hard disks. This method was
<codeclass="sig-name descname"><spanclass="pre">update</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.storage_client.Policy.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Updates the storage policy configuration of a virtual machine and/or
its associated virtual hard disks. This method was added in vSphere API
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm.storage_client.</span></code><codeclass="sig-name descname"><spanclass="pre">StubFactory</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">stub_config</span></span></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"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm.tools_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Installer</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></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.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"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Info</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">is_connected</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></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.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.0.</p>
<codeclass="sig-name descname"><spanclass="pre">connect</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></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"><spanclass="pre">disconnect</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></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"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></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.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"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm.tools_client.</span></code><codeclass="sig-name descname"><spanclass="pre">StubFactory</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">stub_config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm.tools_client.StubFactory"title="Permalink to this definition">¶</a></dt>
