mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-25 10:50:00 -05:00
5601 lines
412 KiB
HTML
5601 lines
412 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
|
|
||
|
|
|
||
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||
|
|
|
||
|
|
<title>com.vmware.vcenter.vm package — vSphere Automation SDK for Python 6.6.1 documentation</title>
|
||
|
|
|
||
|
|
<link rel="stylesheet" href="_static/vapitheme.css" type="text/css" />
|
||
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||
|
|
|
||
|
|
<script type="text/javascript">
|
||
|
|
var DOCUMENTATION_OPTIONS = {
|
||
|
|
URL_ROOT: './',
|
||
|
|
VERSION: '6.6.1',
|
||
|
|
COLLAPSE_INDEX: false,
|
||
|
|
FILE_SUFFIX: '.html',
|
||
|
|
HAS_SOURCE: true
|
||
|
|
};
|
||
|
|
</script>
|
||
|
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
||
|
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
||
|
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
||
|
|
<link rel="top" title="vSphere Automation SDK for Python 6.6.1 documentation" href="index.html" />
|
||
|
|
<link rel="up" title="com.vmware.vcenter package" href="com.vmware.vcenter.html" />
|
||
|
|
<link rel="next" title="com.vmware.vcenter.vm.hardware package" href="com.vmware.vcenter.vm.hardware.html" />
|
||
|
|
<link rel="prev" title="com.vmware.vcenter.hvc package" href="com.vmware.vcenter.hvc.html" />
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<div class="related">
|
||
|
|
<h3>Navigation</h3>
|
||
|
|
<ul>
|
||
|
|
<li class="right" style="margin-right: 10px">
|
||
|
|
<a href="genindex.html" title="General Index"
|
||
|
|
accesskey="I">index</a></li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="py-modindex.html" title="Python Module Index"
|
||
|
|
>modules</a> |</li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="com.vmware.vcenter.vm.hardware.html" title="com.vmware.vcenter.vm.hardware package"
|
||
|
|
accesskey="N">next</a> |</li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="com.vmware.vcenter.hvc.html" title="com.vmware.vcenter.hvc package"
|
||
|
|
accesskey="P">previous</a> |</li>
|
||
|
|
<li><a href="index.html">vSphere Automation SDK for Python 6.6.1 documentation</a> »</li>
|
||
|
|
<li><a href="com.html" >com package</a> »</li>
|
||
|
|
<li><a href="com.vmware.html" >com.vmware package</a> »</li>
|
||
|
|
<li><a href="com.vmware.vcenter.html" accesskey="U">com.vmware.vcenter package</a> »</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="document">
|
||
|
|
<div class="documentwrapper">
|
||
|
|
<div class="bodywrapper">
|
||
|
|
<div class="body">
|
||
|
|
|
||
|
|
<div class="section" id="com-vmware-vcenter-vm-package">
|
||
|
|
<h1>com.vmware.vcenter.vm package<a class="headerlink" href="#com-vmware-vcenter-vm-package" title="Permalink to this headline">¶</a></h1>
|
||
|
|
<div class="section" id="subpackages">
|
||
|
|
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<div class="toctree-wrapper compound">
|
||
|
|
<ul>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vcenter.vm.hardware.html">com.vmware.vcenter.vm.hardware package</a><ul>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.vm.hardware.html#submodules">Submodules</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.vm.hardware.html#module-com.vmware.vcenter.vm.hardware.adapter_client">com.vmware.vcenter.vm.hardware.adapter_client module</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.vm.hardware.html#module-com.vmware.vcenter.vm.hardware.boot_client">com.vmware.vcenter.vm.hardware.boot_client module</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.vm.hardware.html#module-com.vmware.vcenter.vm.hardware">Module contents</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="submodules">
|
||
|
|
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="module-com.vmware.vcenter.vm.hardware_client">
|
||
|
|
<span id="com-vmware-vcenter-vm-hardware-client-module"></span><h2>com.vmware.vcenter.vm.hardware_client module<a class="headerlink" href="#module-com.vmware.vcenter.vm.hardware_client" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware_client</span></tt> 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>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Boot">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter.vm.hardware_client.</tt><tt class="descname">Boot</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Boot" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Boot</span></tt> class provides methods for configuring the settings used when
|
||
|
|
booting a virtual machine.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Boot.CreateSpec">
|
||
|
|
<em class="property">class </em><tt class="descname">CreateSpec</tt><big>(</big><em>type=None</em>, <em>efi_legacy_boot=None</em>, <em>network_protocol=None</em>, <em>delay=None</em>, <em>retry=None</em>, <em>retry_delay=None</em>, <em>enter_setup_mode=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Boot.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Boot.CreateSpec</span></tt> class describes settings used when booting a
|
||
|
|
virtual machine.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Boot.Type" title="com.vmware.vcenter.vm.hardware_client.Boot.Type"><tt class="xref py py-class docutils literal"><span class="pre">Boot.Type</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Firmware type to be used by the virtual machine.
|
||
|
|
If None, defaults to value that is recommended for the guest OS and
|
||
|
|
is supported for the virtual hardware version.</li>
|
||
|
|
<li><strong>efi_legacy_boot</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Flag indicating whether to use EFI legacy boot mode.
|
||
|
|
If None, defaults to value that is recommended for the guest OS and
|
||
|
|
is supported for the virtual hardware version.</li>
|
||
|
|
<li><strong>network_protocol</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Boot.NetworkProtocol" title="com.vmware.vcenter.vm.hardware_client.Boot.NetworkProtocol"><tt class="xref py py-class docutils literal"><span class="pre">Boot.NetworkProtocol</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Protocol to use when attempting to boot the virtual machine over
|
||
|
|
the network.
|
||
|
|
If None, defaults to a system defined default value.</li>
|
||
|
|
<li><strong>delay</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Delay in milliseconds before beginning the firmware boot process
|
||
|
|
when the virtual machine is powered on. This delay may be used to
|
||
|
|
provide a time window for users to connect to the virtual machine
|
||
|
|
console and enter BIOS setup mode.
|
||
|
|
If None, default value is 0.</li>
|
||
|
|
<li><strong>retry</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Flag indicating whether the virtual machine should automatically
|
||
|
|
retry the boot process after a failure.
|
||
|
|
If None, default value is false.</li>
|
||
|
|
<li><strong>retry_delay</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Delay in milliseconds before retrying the boot process after a
|
||
|
|
failure; applicable only when <tt class="xref py py-attr docutils literal"><span class="pre">Boot.Info.retry</span></tt> is true.
|
||
|
|
If None, default value is 10000.</li>
|
||
|
|
<li><strong>enter_setup_mode</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – 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
|
||
|
|
once the virtual machine enters setup mode.
|
||
|
|
If None, the value is unchanged.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Boot.Info">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Boot.</tt><tt class="descname">Info</tt><big>(</big><em>type=None</em>, <em>efi_legacy_boot=None</em>, <em>network_protocol=None</em>, <em>delay=None</em>, <em>retry=None</em>, <em>retry_delay=None</em>, <em>enter_setup_mode=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Boot.Info" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Boot.Info</span></tt> class contains information about the virtual machine boot
|
||
|
|
process.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Boot.Type" title="com.vmware.vcenter.vm.hardware_client.Boot.Type"><tt class="xref py py-class docutils literal"><span class="pre">Boot.Type</span></tt></a>) – Firmware type used by the virtual machine.</li>
|
||
|
|
<li><strong>efi_legacy_boot</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Flag indicating whether to use EFI legacy boot mode.
|
||
|
|
This attribute is optional and it is only relevant when the value
|
||
|
|
of <tt class="docutils literal"><span class="pre">type</span></tt> is <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Boot.Type.EFI" title="com.vmware.vcenter.vm.hardware_client.Boot.Type.EFI"><tt class="xref py py-attr docutils literal"><span class="pre">Boot.Type.EFI</span></tt></a>.</li>
|
||
|
|
<li><strong>network_protocol</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Boot.NetworkProtocol" title="com.vmware.vcenter.vm.hardware_client.Boot.NetworkProtocol"><tt class="xref py py-class docutils literal"><span class="pre">Boot.NetworkProtocol</span></tt></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 <tt class="docutils literal"><span class="pre">type</span></tt> is <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Boot.Type.EFI" title="com.vmware.vcenter.vm.hardware_client.Boot.Type.EFI"><tt class="xref py py-attr docutils literal"><span class="pre">Boot.Type.EFI</span></tt></a>.</li>
|
||
|
|
<li><strong>delay</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – Delay in milliseconds before beginning the firmware boot process
|
||
|
|
when the virtual machine is powered on. This delay may be used to
|
||
|
|
provide a time window for users to connect to the virtual machine
|
||
|
|
console and enter BIOS setup mode.</li>
|
||
|
|
<li><strong>retry</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Flag indicating whether the virtual machine will automatically
|
||
|
|
retry the boot process after a failure.</li>
|
||
|
|
<li><strong>retry_delay</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – Delay in milliseconds before retrying the boot process after a
|
||
|
|
failure; applicable only when <tt class="xref py py-attr docutils literal"><span class="pre">Boot.Info.retry</span></tt> is true.</li>
|
||
|
|
<li><strong>enter_setup_mode</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – 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.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Boot.NetworkProtocol">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Boot.</tt><tt class="descname">NetworkProtocol</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Boot.NetworkProtocol" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Boot.NetworkProtocol</span></tt> class defines the valid network boot protocols
|
||
|
|
supported when booting a virtual machine with <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Boot.Type.EFI" title="com.vmware.vcenter.vm.hardware_client.Boot.Type.EFI"><tt class="xref py py-attr docutils literal"><span class="pre">Boot.Type.EFI</span></tt></a>
|
||
|
|
firmware over the network.</p>
|
||
|
|
<div class="admonition note">
|
||
|
|
<p class="first admonition-title">Note</p>
|
||
|
|
<p class="last">This class represents an enumerated type in the interface language
|
||
|
|
definition. The class contains class attributes which represent the
|
||
|
|
values in the current version of the enumerated type. Newer versions of
|
||
|
|
the enumerated type may contain new values. To use new values of the
|
||
|
|
enumerated type in communication with a server that supports the newer
|
||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
||
|
|
type description page</em></a>.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <tt class="xref py py-class docutils literal"><span class="pre">NetworkProtocol</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Boot.NetworkProtocol.IPV4">
|
||
|
|
<tt class="descname">IPV4</tt><em class="property"> = NetworkProtocol(string=u'IPV4')</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Boot.NetworkProtocol.IPV4" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>PXE or Apple NetBoot over IPv4.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Boot.NetworkProtocol.IPV6">
|
||
|
|
<tt class="descname">IPV6</tt><em class="property"> = NetworkProtocol(string=u'IPV6')</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Boot.NetworkProtocol.IPV6" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>PXE over IPv6.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Boot.Type">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Boot.</tt><tt class="descname">Type</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Boot.Type" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Boot.Type</span></tt> class defines the valid firmware types for a virtual
|
||
|
|
machine.</p>
|
||
|
|
<div class="admonition note">
|
||
|
|
<p class="first admonition-title">Note</p>
|
||
|
|
<p class="last">This class represents an enumerated type in the interface language
|
||
|
|
definition. The class contains class attributes which represent the
|
||
|
|
values in the current version of the enumerated type. Newer versions of
|
||
|
|
the enumerated type may contain new values. To use new values of the
|
||
|
|
enumerated type in communication with a server that supports the newer
|
||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
||
|
|
type description page</em></a>.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <tt class="xref py py-class docutils literal"><span class="pre">Type</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Boot.Type.BIOS">
|
||
|
|
<tt class="descname">BIOS</tt><em class="property"> = Type(string=u'BIOS')</em><a class="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>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Boot.Type.EFI">
|
||
|
|
<tt class="descname">EFI</tt><em class="property"> = Type(string=u'EFI')</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Boot.Type.EFI" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Extensible Firmware Interface (EFI) firmware.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Boot.UpdateSpec">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Boot.</tt><tt class="descname">UpdateSpec</tt><big>(</big><em>type=None</em>, <em>efi_legacy_boot=None</em>, <em>network_protocol=None</em>, <em>delay=None</em>, <em>retry=None</em>, <em>retry_delay=None</em>, <em>enter_setup_mode=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Boot.UpdateSpec" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Boot.UpdateSpec</span></tt> class describes the updates to the settings used
|
||
|
|
when booting a virtual machine.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Boot.Type" title="com.vmware.vcenter.vm.hardware_client.Boot.Type"><tt class="xref py py-class docutils literal"><span class="pre">Boot.Type</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Firmware type to be used by the virtual machine.
|
||
|
|
If None, the value is unchanged.</li>
|
||
|
|
<li><strong>efi_legacy_boot</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Flag indicating whether to use EFI legacy boot mode.
|
||
|
|
If None, the value is unchanged.</li>
|
||
|
|
<li><strong>network_protocol</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Boot.NetworkProtocol" title="com.vmware.vcenter.vm.hardware_client.Boot.NetworkProtocol"><tt class="xref py py-class docutils literal"><span class="pre">Boot.NetworkProtocol</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Protocol to use when attempting to boot the virtual machine over
|
||
|
|
the network.
|
||
|
|
If None, the value is unchanged.</li>
|
||
|
|
<li><strong>delay</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Delay in milliseconds before beginning the firmware boot process
|
||
|
|
when the virtual machine is powered on. This delay may be used to
|
||
|
|
provide a time window for users to connect to the virtual machine
|
||
|
|
console and enter BIOS setup mode.
|
||
|
|
If None, the value is unchanged.</li>
|
||
|
|
<li><strong>retry</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Flag indicating whether the virtual machine should automatically
|
||
|
|
retry the boot process after a failure.
|
||
|
|
If None, the value is unchanged.</li>
|
||
|
|
<li><strong>retry_delay</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Delay in milliseconds before retrying the boot process after a
|
||
|
|
failure; applicable only when <tt class="xref py py-attr docutils literal"><span class="pre">Boot.Info.retry</span></tt> is true.
|
||
|
|
If None, the value is unchanged.</li>
|
||
|
|
<li><strong>enter_setup_mode</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – 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
|
||
|
|
once the virtual machine enters setup mode.
|
||
|
|
If None, the value is unchanged.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Boot.get">
|
||
|
|
<tt class="descclassname">Boot.</tt><tt class="descname">get</tt><big>(</big><em>vm</em><big>)</big><a class="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>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Boot.Info" title="com.vmware.vcenter.vm.hardware_client.Boot.Info"><tt class="xref py py-class docutils literal"><span class="pre">Boot.Info</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Boot-related settings of the virtual machine.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the virtual machine is not found.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the virtual machine’s configuration state cannot be accessed.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Boot.update">
|
||
|
|
<tt class="descclassname">Boot.</tt><tt class="descname">update</tt><big>(</big><em>vm</em>, <em>spec</em><big>)</big><a class="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>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</li>
|
||
|
|
<li><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Boot.UpdateSpec" title="com.vmware.vcenter.vm.hardware_client.Boot.UpdateSpec"><tt class="xref py py-class docutils literal"><span class="pre">Boot.UpdateSpec</span></tt></a>) – Specification for updating the boot-related settings of the virtual
|
||
|
|
machine.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the virtual machine is not found.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt>
|
||
|
|
if one of the provided settings is not permitted; for example,
|
||
|
|
specifying a negative value for <tt class="docutils literal"><span class="pre">delay</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></tt>
|
||
|
|
if the virtual machine is busy performing another operation.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter.vm.hardware_client.</tt><tt class="descname">Cdrom</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Cdrom" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Cdrom</span></tt> class provides methods for configuring the virtual CD-ROM
|
||
|
|
devices of a virtual machine.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingInfo">
|
||
|
|
<em class="property">class </em><tt class="descname">BackingInfo</tt><big>(</big><em>type=None</em>, <em>iso_file=None</em>, <em>host_device=None</em>, <em>auto_detect=None</em>, <em>device_access_type=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingInfo" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Cdrom.BackingInfo</span></tt> class contains information about the physical
|
||
|
|
resource backing a virtual CD-ROM device.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType" title="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType"><tt class="xref py py-class docutils literal"><span class="pre">Cdrom.BackingType</span></tt></a>) – Backing type for the virtual CD-ROM device.</li>
|
||
|
|
<li><strong>iso_file</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Path of the image file backing the virtual CD-ROM device.
|
||
|
|
This attribute is optional and it is only relevant when the value
|
||
|
|
of <tt class="docutils literal"><span class="pre">type</span></tt> is <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType.ISO_FILE" title="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType.ISO_FILE"><tt class="xref py py-attr docutils literal"><span class="pre">Cdrom.BackingType.ISO_FILE</span></tt></a>.</li>
|
||
|
|
<li><strong>host_device</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Name of the host device backing the virtual CD-ROM device.
|
||
|
|
This attribute will be None if <tt class="docutils literal"><span class="pre">autoDetect</span></tt> is true and the
|
||
|
|
virtual CD-ROM device is not connected or no suitable device is
|
||
|
|
available on the host.</li>
|
||
|
|
<li><strong>auto_detect</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – 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 <tt class="docutils literal"><span class="pre">type</span></tt> is <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType.HOST_DEVICE" title="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType.HOST_DEVICE"><tt class="xref py py-attr docutils literal"><span class="pre">Cdrom.BackingType.HOST_DEVICE</span></tt></a>.</li>
|
||
|
|
<li><strong>device_access_type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.DeviceAccessType" title="com.vmware.vcenter.vm.hardware_client.Cdrom.DeviceAccessType"><tt class="xref py py-class docutils literal"><span class="pre">Cdrom.DeviceAccessType</span></tt></a>) – Access type for the device backing.
|
||
|
|
This attribute is optional and it is only relevant when the value
|
||
|
|
of <tt class="docutils literal"><span class="pre">type</span></tt> is one of <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType.HOST_DEVICE" title="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType.HOST_DEVICE"><tt class="xref py py-attr docutils literal"><span class="pre">Cdrom.BackingType.HOST_DEVICE</span></tt></a> or
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType.CLIENT_DEVICE" title="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType.CLIENT_DEVICE"><tt class="xref py py-attr docutils literal"><span class="pre">Cdrom.BackingType.CLIENT_DEVICE</span></tt></a>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingSpec">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Cdrom.</tt><tt class="descname">BackingSpec</tt><big>(</big><em>type=None</em>, <em>iso_file=None</em>, <em>host_device=None</em>, <em>device_access_type=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingSpec" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Cdrom.BackingSpec</span></tt> class provides a specification of the physical
|
||
|
|
resource backing a virtual CD-ROM device.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType" title="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType"><tt class="xref py py-class docutils literal"><span class="pre">Cdrom.BackingType</span></tt></a>) – Backing type for the virtual CD-ROM device.</li>
|
||
|
|
<li><strong>iso_file</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – 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 <tt class="docutils literal"><span class="pre">type</span></tt> is <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType.ISO_FILE" title="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType.ISO_FILE"><tt class="xref py py-attr docutils literal"><span class="pre">Cdrom.BackingType.ISO_FILE</span></tt></a>.</li>
|
||
|
|
<li><strong>host_device</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Name of the device that should be used as the virtual CD-ROM device
|
||
|
|
backing.
|
||
|
|
If None, the virtual CD-ROM device will be configured to
|
||
|
|
automatically detect a suitable host device.</li>
|
||
|
|
<li><strong>device_access_type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.DeviceAccessType" title="com.vmware.vcenter.vm.hardware_client.Cdrom.DeviceAccessType"><tt class="xref py py-class docutils literal"><span class="pre">Cdrom.DeviceAccessType</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Access type for the device backing.
|
||
|
|
If None, defaults to <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.DeviceAccessType.EMULATION" title="com.vmware.vcenter.vm.hardware_client.Cdrom.DeviceAccessType.EMULATION"><tt class="xref py py-attr docutils literal"><span class="pre">Cdrom.DeviceAccessType.EMULATION</span></tt></a>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Cdrom.</tt><tt class="descname">BackingType</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Cdrom.BackingType</span></tt> class defines the valid backing types for a
|
||
|
|
virtual CD-ROM device.</p>
|
||
|
|
<div class="admonition note">
|
||
|
|
<p class="first admonition-title">Note</p>
|
||
|
|
<p class="last">This class represents an enumerated type in the interface language
|
||
|
|
definition. The class contains class attributes which represent the
|
||
|
|
values in the current version of the enumerated type. Newer versions of
|
||
|
|
the enumerated type may contain new values. To use new values of the
|
||
|
|
enumerated type in communication with a server that supports the newer
|
||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
||
|
|
type description page</em></a>.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <tt class="xref py py-class docutils literal"><span class="pre">BackingType</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType.CLIENT_DEVICE">
|
||
|
|
<tt class="descname">CLIENT_DEVICE</tt><em class="property"> = BackingType(string=u'CLIENT_DEVICE')</em><a class="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
|
||
|
|
to the virtual machine console.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType.HOST_DEVICE">
|
||
|
|
<tt class="descname">HOST_DEVICE</tt><em class="property"> = BackingType(string=u'HOST_DEVICE')</em><a class="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
|
||
|
|
machine is running.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType.ISO_FILE">
|
||
|
|
<tt class="descname">ISO_FILE</tt><em class="property"> = BackingType(string=u'ISO_FILE')</em><a class="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>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.CreateSpec">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Cdrom.</tt><tt class="descname">CreateSpec</tt><big>(</big><em>type=None</em>, <em>ide=None</em>, <em>sata=None</em>, <em>backing=None</em>, <em>start_connected=None</em>, <em>allow_guest_control=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Cdrom.CreateSpec</span></tt> class provides a specification for the
|
||
|
|
configuration of a newly-created virtual CD-ROM device.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.HostBusAdapterType" title="com.vmware.vcenter.vm.hardware_client.Cdrom.HostBusAdapterType"><tt class="xref py py-class docutils literal"><span class="pre">Cdrom.HostBusAdapterType</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Type of host bus adapter to which the device should be attached.
|
||
|
|
If None, guest-specific default values will be used</li>
|
||
|
|
<li><strong>ide</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.IdeAddressSpec" title="com.vmware.vcenter.vm.hardware_client.IdeAddressSpec"><tt class="xref py py-class docutils literal"><span class="pre">IdeAddressSpec</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Address for attaching the device to a virtual IDE adapter.
|
||
|
|
If None, the server will choose an available address; if none is
|
||
|
|
available, the request will fail.</li>
|
||
|
|
<li><strong>sata</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.SataAddressSpec" title="com.vmware.vcenter.vm.hardware_client.SataAddressSpec"><tt class="xref py py-class docutils literal"><span class="pre">SataAddressSpec</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Address for attaching the device to a virtual SATA adapter.
|
||
|
|
If None, the server will choose an available address; if none is
|
||
|
|
available, the request will fail.</li>
|
||
|
|
<li><strong>backing</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingSpec" title="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingSpec"><tt class="xref py py-class docutils literal"><span class="pre">Cdrom.BackingSpec</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Physical resource backing for the virtual CD-ROM device.
|
||
|
|
If None, defaults to automatic detection of a suitable host device.</li>
|
||
|
|
<li><strong>start_connected</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Flag indicating whether the virtual device should be connected
|
||
|
|
whenever the virtual machine is powered on.
|
||
|
|
Defaults to false if None.</li>
|
||
|
|
<li><strong>allow_guest_control</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Flag indicating whether the guest can connect and disconnect the
|
||
|
|
device.
|
||
|
|
Defaults to false if None.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.DeviceAccessType">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Cdrom.</tt><tt class="descname">DeviceAccessType</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.DeviceAccessType" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Cdrom.DeviceAccessType</span></tt> class defines the valid device access types
|
||
|
|
for a physical device packing of a virtual CD-ROM device.</p>
|
||
|
|
<div class="admonition note">
|
||
|
|
<p class="first admonition-title">Note</p>
|
||
|
|
<p class="last">This class represents an enumerated type in the interface language
|
||
|
|
definition. The class contains class attributes which represent the
|
||
|
|
values in the current version of the enumerated type. Newer versions of
|
||
|
|
the enumerated type may contain new values. To use new values of the
|
||
|
|
enumerated type in communication with a server that supports the newer
|
||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
||
|
|
type description page</em></a>.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <tt class="xref py py-class docutils literal"><span class="pre">DeviceAccessType</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.DeviceAccessType.EMULATION">
|
||
|
|
<tt class="descname">EMULATION</tt><em class="property"> = DeviceAccessType(string=u'EMULATION')</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.DeviceAccessType.EMULATION" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>ATAPI or SCSI device emulation.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.DeviceAccessType.PASSTHRU">
|
||
|
|
<tt class="descname">PASSTHRU</tt><em class="property"> = DeviceAccessType(string=u'PASSTHRU')</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.DeviceAccessType.PASSTHRU" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Raw passthru device access.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.DeviceAccessType.PASSTHRU_EXCLUSIVE">
|
||
|
|
<tt class="descname">PASSTHRU_EXCLUSIVE</tt><em class="property"> = DeviceAccessType(string=u'PASSTHRU_EXCLUSIVE')</em><a class="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>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.HostBusAdapterType">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Cdrom.</tt><tt class="descname">HostBusAdapterType</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.HostBusAdapterType" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Cdrom.HostBusAdapterType</span></tt> class defines the valid types of host bus
|
||
|
|
adapters that may be used for attaching a Cdrom to a virtual machine.</p>
|
||
|
|
<div class="admonition note">
|
||
|
|
<p class="first admonition-title">Note</p>
|
||
|
|
<p class="last">This class represents an enumerated type in the interface language
|
||
|
|
definition. The class contains class attributes which represent the
|
||
|
|
values in the current version of the enumerated type. Newer versions of
|
||
|
|
the enumerated type may contain new values. To use new values of the
|
||
|
|
enumerated type in communication with a server that supports the newer
|
||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
||
|
|
type description page</em></a>.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <tt class="xref py py-class docutils literal"><span class="pre">HostBusAdapterType</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.HostBusAdapterType.IDE">
|
||
|
|
<tt class="descname">IDE</tt><em class="property"> = HostBusAdapterType(string=u'IDE')</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.HostBusAdapterType.IDE" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Cdrom is attached to an IDE adapter.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.HostBusAdapterType.SATA">
|
||
|
|
<tt class="descname">SATA</tt><em class="property"> = HostBusAdapterType(string=u'SATA')</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.HostBusAdapterType.SATA" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Cdrom is attached to a SATA adapter.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.Info">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Cdrom.</tt><tt class="descname">Info</tt><big>(</big><em>type=None</em>, <em>label=None</em>, <em>ide=None</em>, <em>sata=None</em>, <em>backing=None</em>, <em>state=None</em>, <em>start_connected=None</em>, <em>allow_guest_control=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.Info" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Cdrom.Info</span></tt> class contains information about a virtual CD-ROM
|
||
|
|
device.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.HostBusAdapterType" title="com.vmware.vcenter.vm.hardware_client.Cdrom.HostBusAdapterType"><tt class="xref py py-class docutils literal"><span class="pre">Cdrom.HostBusAdapterType</span></tt></a>) – Type of host bus adapter to which the device is attached.</li>
|
||
|
|
<li><strong>label</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Device label.</li>
|
||
|
|
<li><strong>ide</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.IdeAddressInfo" title="com.vmware.vcenter.vm.hardware_client.IdeAddressInfo"><tt class="xref py py-class docutils literal"><span class="pre">IdeAddressInfo</span></tt></a>) – Address of device attached to a virtual IDE adapter.
|
||
|
|
This attribute is optional and it is only relevant when the value
|
||
|
|
of <tt class="docutils literal"><span class="pre">type</span></tt> is <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.HostBusAdapterType.IDE" title="com.vmware.vcenter.vm.hardware_client.Cdrom.HostBusAdapterType.IDE"><tt class="xref py py-attr docutils literal"><span class="pre">Cdrom.HostBusAdapterType.IDE</span></tt></a>.</li>
|
||
|
|
<li><strong>sata</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.SataAddressInfo" title="com.vmware.vcenter.vm.hardware_client.SataAddressInfo"><tt class="xref py py-class docutils literal"><span class="pre">SataAddressInfo</span></tt></a>) – Address of device attached to a virtual SATA adapter.
|
||
|
|
This attribute is optional and it is only relevant when the value
|
||
|
|
of <tt class="docutils literal"><span class="pre">type</span></tt> is <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.HostBusAdapterType.SATA" title="com.vmware.vcenter.vm.hardware_client.Cdrom.HostBusAdapterType.SATA"><tt class="xref py py-attr docutils literal"><span class="pre">Cdrom.HostBusAdapterType.SATA</span></tt></a>.</li>
|
||
|
|
<li><strong>backing</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingInfo" title="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingInfo"><tt class="xref py py-class docutils literal"><span class="pre">Cdrom.BackingInfo</span></tt></a>) – Physical resource backing for the virtual CD-ROM device.</li>
|
||
|
|
<li><strong>state</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.ConnectionState" title="com.vmware.vcenter.vm.hardware_client.ConnectionState"><tt class="xref py py-class docutils literal"><span class="pre">ConnectionState</span></tt></a>) – Connection status of the virtual device.</li>
|
||
|
|
<li><strong>start_connected</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Flag indicating whether the virtual device should be connected
|
||
|
|
whenever the virtual machine is powered on.</li>
|
||
|
|
<li><strong>allow_guest_control</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Flag indicating whether the guest can connect and disconnect the
|
||
|
|
device.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.RESOURCE_TYPE">
|
||
|
|
<tt class="descclassname">Cdrom.</tt><tt class="descname">RESOURCE_TYPE</tt><em class="property"> = 'com.vmware.vcenter.vm.hardware.Cdrom'</em><a class="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>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.Summary">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Cdrom.</tt><tt class="descname">Summary</tt><big>(</big><em>cdrom=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.Summary" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Cdrom.Summary</span></tt> class contains commonly used information about a
|
||
|
|
virtual CD-ROM device.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>cdrom</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the virtual CD-ROM device.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.Cdrom</span></tt>. When methods return a
|
||
|
|
value of this class as a return value, the attribute will be an
|
||
|
|
identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.Cdrom</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.UpdateSpec">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Cdrom.</tt><tt class="descname">UpdateSpec</tt><big>(</big><em>backing=None</em>, <em>start_connected=None</em>, <em>allow_guest_control=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.UpdateSpec" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Cdrom.UpdateSpec</span></tt> class describes the updates to be made to the
|
||
|
|
configuration of a virtual CD-ROM device.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>backing</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingSpec" title="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingSpec"><tt class="xref py py-class docutils literal"><span class="pre">Cdrom.BackingSpec</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – <p>Physical resource backing for the virtual CD-ROM device.</p>
|
||
|
|
<p>This attribute may only be modified if the virtual machine is not
|
||
|
|
powered on or the virtual CD-ROM device is not connected.
|
||
|
|
If None, the value is unchanged.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>start_connected</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Flag indicating whether the virtual device should be connected
|
||
|
|
whenever the virtual machine is powered on.
|
||
|
|
If None, the value is unchanged.</li>
|
||
|
|
<li><strong>allow_guest_control</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Flag indicating whether the guest can connect and disconnect the
|
||
|
|
device.
|
||
|
|
If None, the value is unchanged.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.connect">
|
||
|
|
<tt class="descclassname">Cdrom.</tt><tt class="descname">connect</tt><big>(</big><em>vm</em>, <em>cdrom</em><big>)</big><a class="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 <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.update" title="com.vmware.vcenter.vm.hardware_client.Cdrom.update"><tt class="xref py py-func docutils literal"><span class="pre">Cdrom.update()</span></tt></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>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</li>
|
||
|
|
<li><strong>cdrom</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual CD-ROM device identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.Cdrom</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the virtual machine or virtual CD-ROM device is not found.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></tt>
|
||
|
|
if the virtual CD-ROM device is already connected.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></tt>
|
||
|
|
if the virtual machine is not powered on.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></tt>
|
||
|
|
if the virtual machine is busy performing another operation.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.create">
|
||
|
|
<tt class="descclassname">Cdrom.</tt><tt class="descname">create</tt><big>(</big><em>vm</em>, <em>spec</em><big>)</big><a class="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>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</li>
|
||
|
|
<li><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.CreateSpec" title="com.vmware.vcenter.vm.hardware_client.Cdrom.CreateSpec"><tt class="xref py py-class docutils literal"><span class="pre">Cdrom.CreateSpec</span></tt></a>) – Specification for the new virtual CD-ROM device.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">str</span></tt></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Virtual CD-ROM device identifier.
|
||
|
|
The return value will be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.Cdrom</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reported that the CD-ROM device was created but was
|
||
|
|
unable to confirm the creation because the identifier of the new
|
||
|
|
device could not be determined.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the virtual machine is not found.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></tt>
|
||
|
|
if the virtual machine is suspended or if the virtual machine is
|
||
|
|
powered on and virtual CD-ROM type is IDE.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></tt>
|
||
|
|
if the specified storage address is unavailable; for example, if
|
||
|
|
the SCSI adapter requested does not exist.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInUse</span></tt>
|
||
|
|
if the specified storage address is in use.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt>
|
||
|
|
if the specified storage address is out of bounds.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></tt>
|
||
|
|
if the virtual machine is busy performing another operation.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></tt>
|
||
|
|
if the guest operating system of the virtual machine is not
|
||
|
|
supported and spec includes None attributes that default to
|
||
|
|
guest-specific values.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.delete">
|
||
|
|
<tt class="descclassname">Cdrom.</tt><tt class="descname">delete</tt><big>(</big><em>vm</em>, <em>cdrom</em><big>)</big><a class="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>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</li>
|
||
|
|
<li><strong>cdrom</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual CD-ROM device identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.Cdrom</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the virtual machine or virtual CD-ROM device is not found.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></tt>
|
||
|
|
if the virtual machine is suspended or if the virtual machine is
|
||
|
|
powered on and virtual CD-ROM type is IDE.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></tt>
|
||
|
|
if the virtual machine is busy performing another operation.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.disconnect">
|
||
|
|
<tt class="descclassname">Cdrom.</tt><tt class="descname">disconnect</tt><big>(</big><em>vm</em>, <em>cdrom</em><big>)</big><a class="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 <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.update" title="com.vmware.vcenter.vm.hardware_client.Cdrom.update"><tt class="xref py py-func docutils literal"><span class="pre">Cdrom.update()</span></tt></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>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</li>
|
||
|
|
<li><strong>cdrom</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual CD-ROM device identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.Cdrom</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the virtual machine or virtual CD-ROM device is not found.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></tt>
|
||
|
|
if the virtual CD-ROM device is already disconnected.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></tt>
|
||
|
|
if the virtual machine is not powered on.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></tt>
|
||
|
|
if the virtual machine is busy performing another operation.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.get">
|
||
|
|
<tt class="descclassname">Cdrom.</tt><tt class="descname">get</tt><big>(</big><em>vm</em>, <em>cdrom</em><big>)</big><a class="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>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</li>
|
||
|
|
<li><strong>cdrom</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual CD-ROM device identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.Cdrom</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.Info" title="com.vmware.vcenter.vm.hardware_client.Cdrom.Info"><tt class="xref py py-class docutils literal"><span class="pre">Cdrom.Info</span></tt></a></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Information about the specified virtual CD-ROM device.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the virtual machine or virtual CD-ROM device is not found.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.list">
|
||
|
|
<tt class="descclassname">Cdrom.</tt><tt class="descname">list</tt><big>(</big><em>vm</em><big>)</big><a class="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
|
||
|
|
belonging to the virtual machine.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.list" title="com.vmware.vcenter.vm.hardware_client.Cdrom.list"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.Summary" title="com.vmware.vcenter.vm.hardware_client.Cdrom.Summary"><tt class="xref py py-class docutils literal"><span class="pre">Cdrom.Summary</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">List of commonly used information about virtual CD-ROM devices.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the virtual machine is not found.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the virtual machine’s configuration state cannot be accessed.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.update">
|
||
|
|
<tt class="descclassname">Cdrom.</tt><tt class="descname">update</tt><big>(</big><em>vm</em>, <em>cdrom</em>, <em>spec</em><big>)</big><a class="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>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</li>
|
||
|
|
<li><strong>cdrom</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual CD-ROM device identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.Cdrom</span></tt>.</li>
|
||
|
|
<li><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.UpdateSpec" title="com.vmware.vcenter.vm.hardware_client.Cdrom.UpdateSpec"><tt class="xref py py-class docutils literal"><span class="pre">Cdrom.UpdateSpec</span></tt></a>) – Specification for updating the virtual CD-ROM device.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the virtual machine or virtual CD-ROM device is not found.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></tt>
|
||
|
|
if one or more of the attributes specified in the <tt class="docutils literal"><span class="pre">spec</span></tt>
|
||
|
|
parameter cannot be modified due to the current power state of the
|
||
|
|
virtual machine or the connection state of the virtual CD-ROM
|
||
|
|
device.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></tt>
|
||
|
|
if the virtual machine is busy performing another operation.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.ConnectionCreateSpec">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter.vm.hardware_client.</tt><tt class="descname">ConnectionCreateSpec</tt><big>(</big><em>start_connected=None</em>, <em>allow_guest_control=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.ConnectionCreateSpec" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">ConnectionCreateSpec</span></tt> class provides a specification for the
|
||
|
|
configuration of a newly-created removable device.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>start_connected</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Flag indicating whether the virtual device should be connected
|
||
|
|
whenever the virtual machine is powered on.
|
||
|
|
Defaults to false if None.</li>
|
||
|
|
<li><strong>allow_guest_control</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Flag indicating whether the guest can connect and disconnect the
|
||
|
|
device.
|
||
|
|
Defaults to false if None.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.ConnectionInfo">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter.vm.hardware_client.</tt><tt class="descname">ConnectionInfo</tt><big>(</big><em>state=None</em>, <em>start_connected=None</em>, <em>allow_guest_control=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.ConnectionInfo" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">ConnectionInfo</span></tt> class provides information about the state and
|
||
|
|
configuration of a removable virtual device.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>state</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.ConnectionState" title="com.vmware.vcenter.vm.hardware_client.ConnectionState"><tt class="xref py py-class docutils literal"><span class="pre">ConnectionState</span></tt></a>) – Connection status of the virtual device.</li>
|
||
|
|
<li><strong>start_connected</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Flag indicating whether the virtual device should be connected
|
||
|
|
whenever the virtual machine is powered on.</li>
|
||
|
|
<li><strong>allow_guest_control</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Flag indicating whether the guest can connect and disconnect the
|
||
|
|
device.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.ConnectionState">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter.vm.hardware_client.</tt><tt class="descname">ConnectionState</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.ConnectionState" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">ConnectionState</span></tt> class defines the valid states for a removable
|
||
|
|
device that is configured to be connected.</p>
|
||
|
|
<div class="admonition note">
|
||
|
|
<p class="first admonition-title">Note</p>
|
||
|
|
<p class="last">This class represents an enumerated type in the interface language
|
||
|
|
definition. The class contains class attributes which represent the
|
||
|
|
values in the current version of the enumerated type. Newer versions of
|
||
|
|
the enumerated type may contain new values. To use new values of the
|
||
|
|
enumerated type in communication with a server that supports the newer
|
||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
||
|
|
type description page</em></a>.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.ConnectionState" title="com.vmware.vcenter.vm.hardware_client.ConnectionState"><tt class="xref py py-class docutils literal"><span class="pre">ConnectionState</span></tt></a> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.ConnectionState.CONNECTED">
|
||
|
|
<tt class="descname">CONNECTED</tt><em class="property"> = ConnectionState(string=u'CONNECTED')</em><a class="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>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.ConnectionState.NOT_CONNECTED">
|
||
|
|
<tt class="descname">NOT_CONNECTED</tt><em class="property"> = ConnectionState(string=u'NOT_CONNECTED')</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.ConnectionState.NOT_CONNECTED" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>The device is not connected.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.ConnectionState.RECOVERABLE_ERROR">
|
||
|
|
<tt class="descname">RECOVERABLE_ERROR</tt><em class="property"> = ConnectionState(string=u'RECOVERABLE_ERROR')</em><a class="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>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.ConnectionState.UNKNOWN">
|
||
|
|
<tt class="descname">UNKNOWN</tt><em class="property"> = ConnectionState(string=u'UNKNOWN')</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.ConnectionState.UNKNOWN" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>The device status is unknown.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.ConnectionState.UNRECOVERABLE_ERROR">
|
||
|
|
<tt class="descname">UNRECOVERABLE_ERROR</tt><em class="property"> = ConnectionState(string=u'UNRECOVERABLE_ERROR')</em><a class="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
|
||
|
|
virtual device backing does not exist.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.ConnectionUpdateSpec">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter.vm.hardware_client.</tt><tt class="descname">ConnectionUpdateSpec</tt><big>(</big><em>start_connected=None</em>, <em>allow_guest_control=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.ConnectionUpdateSpec" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">ConnectionUpdateSpec</span></tt> class describes the updates to be made to the
|
||
|
|
configuration of a removable virtual device.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>start_connected</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Flag indicating whether the virtual device should be connected
|
||
|
|
whenever the virtual machine is powered on.
|
||
|
|
If None, the value is unchanged.</li>
|
||
|
|
<li><strong>allow_guest_control</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Flag indicating whether the guest can connect and disconnect the
|
||
|
|
device.
|
||
|
|
If None, the value is unchanged.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cpu">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter.vm.hardware_client.</tt><tt class="descname">Cpu</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Cpu" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Cpu</span></tt> class provides methods for configuring the CPU settings of a
|
||
|
|
virtual machine.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cpu.Info">
|
||
|
|
<em class="property">class </em><tt class="descname">Info</tt><big>(</big><em>count=None</em>, <em>cores_per_socket=None</em>, <em>hot_add_enabled=None</em>, <em>hot_remove_enabled=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Cpu.Info" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Cpu.Info</span></tt> class contains CPU-related information about a virtual
|
||
|
|
machine.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>count</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – Number of CPU cores.</li>
|
||
|
|
<li><strong>cores_per_socket</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – Number of CPU cores per socket.</li>
|
||
|
|
<li><strong>hot_add_enabled</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Flag indicating whether adding CPUs while the virtual machine is
|
||
|
|
running is enabled.</li>
|
||
|
|
<li><strong>hot_remove_enabled</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Flag indicating whether removing CPUs while the virtual machine is
|
||
|
|
running is enabled.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cpu.UpdateSpec">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Cpu.</tt><tt class="descname">UpdateSpec</tt><big>(</big><em>count=None</em>, <em>cores_per_socket=None</em>, <em>hot_add_enabled=None</em>, <em>hot_remove_enabled=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Cpu.UpdateSpec" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Cpu.UpdateSpec</span></tt> class describes the updates to be made to the
|
||
|
|
CPU-related settings of a virtual machine.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>count</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – <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 <tt class="xref py py-attr docutils literal"><span class="pre">Cpu.Info.hot_add_enabled</span></tt> is true, and may
|
||
|
|
only be decreased if <tt class="xref py py-attr docutils literal"><span class="pre">Cpu.Info.hot_remove_enabled</span></tt> is true.
|
||
|
|
If None, the value is unchanged.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>cores_per_socket</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – New number of CPU cores per socket. The number of CPU cores in the
|
||
|
|
virtual machine must be a multiple of the number of cores per
|
||
|
|
socket.
|
||
|
|
If None, the value is unchanged.</li>
|
||
|
|
<li><strong>hot_add_enabled</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – <p>Flag indicating whether adding CPUs while the virtual machine is
|
||
|
|
running is enabled.</p>
|
||
|
|
<p>This attribute may only be modified if the virtual machine is
|
||
|
|
powered off.
|
||
|
|
If None, the value is unchanged.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>hot_remove_enabled</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – <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
|
||
|
|
powered off.
|
||
|
|
If None, the value is unchanged.</p>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cpu.get">
|
||
|
|
<tt class="descclassname">Cpu.</tt><tt class="descname">get</tt><big>(</big><em>vm</em><big>)</big><a class="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>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Cpu.Info" title="com.vmware.vcenter.vm.hardware_client.Cpu.Info"><tt class="xref py py-class docutils literal"><span class="pre">Cpu.Info</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">CPU-related settings of the virtual machine.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the virtual machine is not found.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the virtual machine’s configuration state cannot be accessed.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cpu.update">
|
||
|
|
<tt class="descclassname">Cpu.</tt><tt class="descname">update</tt><big>(</big><em>vm</em>, <em>spec</em><big>)</big><a class="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>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</li>
|
||
|
|
<li><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Cpu.UpdateSpec" title="com.vmware.vcenter.vm.hardware_client.Cpu.UpdateSpec"><tt class="xref py py-class docutils literal"><span class="pre">Cpu.UpdateSpec</span></tt></a>) – Specification for updating the CPU-related settings of the virtual
|
||
|
|
machine.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the virtual machine is not found.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt>
|
||
|
|
if one of the provided settings is not permitted; for example,
|
||
|
|
specifying a negative value for <tt class="docutils literal"><span class="pre">count</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></tt>
|
||
|
|
if <tt class="docutils literal"><span class="pre">hotAddEnabled</span></tt> or <tt class="docutils literal"><span class="pre">hotRemoveEnabled</span></tt> is specified and the
|
||
|
|
virtual machine is not powered off.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></tt>
|
||
|
|
if <tt class="docutils literal"><span class="pre">count</span></tt> is specified and is greater than <tt class="docutils literal"><span class="pre">count</span></tt>,
|
||
|
|
<tt class="docutils literal"><span class="pre">hotAddEnabled</span></tt> is false, and the virtual machine is not powered
|
||
|
|
off.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></tt>
|
||
|
|
if <tt class="docutils literal"><span class="pre">count</span></tt> is specified and is less than <tt class="docutils literal"><span class="pre">count</span></tt>,
|
||
|
|
<tt class="docutils literal"><span class="pre">hotRemoveEnabled</span></tt> is false, and the virtual machine is not
|
||
|
|
powered off.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></tt>
|
||
|
|
if the virtual machine is busy performing another operation.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter.vm.hardware_client.</tt><tt class="descname">Disk</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Disk" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Disk</span></tt> 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 <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Disk.create" title="com.vmware.vcenter.vm.hardware_client.Disk.create"><tt class="xref py py-func docutils literal"><span class="pre">Disk.create()</span></tt></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 <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Disk.delete" title="com.vmware.vcenter.vm.hardware_client.Disk.delete"><tt class="xref py py-func docutils literal"><span class="pre">Disk.delete()</span></tt></a> method
|
||
|
|
provides the ability to detach a VMDK file from the virtual machine. The
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Disk.delete" title="com.vmware.vcenter.vm.hardware_client.Disk.delete"><tt class="xref py py-func docutils literal"><span class="pre">Disk.delete()</span></tt></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>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.BackingInfo">
|
||
|
|
<em class="property">class </em><tt class="descname">BackingInfo</tt><big>(</big><em>type=None</em>, <em>vmdk_file=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Disk.BackingInfo" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Disk.BackingInfo</span></tt> class contains information about the physical
|
||
|
|
resource backing a virtual disk.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Disk.BackingType" title="com.vmware.vcenter.vm.hardware_client.Disk.BackingType"><tt class="xref py py-class docutils literal"><span class="pre">Disk.BackingType</span></tt></a>) – Backing type for the virtual disk.</li>
|
||
|
|
<li><strong>vmdk_file</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Path of the VMDK file backing the virtual disk.
|
||
|
|
This attribute is optional and it is only relevant when the value
|
||
|
|
of <tt class="docutils literal"><span class="pre">type</span></tt> is <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Disk.BackingType.VMDK_FILE" title="com.vmware.vcenter.vm.hardware_client.Disk.BackingType.VMDK_FILE"><tt class="xref py py-attr docutils literal"><span class="pre">Disk.BackingType.VMDK_FILE</span></tt></a>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.BackingSpec">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Disk.</tt><tt class="descname">BackingSpec</tt><big>(</big><em>type=None</em>, <em>vmdk_file=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Disk.BackingSpec" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Disk.BackingSpec</span></tt> class provides a specification of the physical
|
||
|
|
resource backing a virtual disk.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Disk.BackingType" title="com.vmware.vcenter.vm.hardware_client.Disk.BackingType"><tt class="xref py py-class docutils literal"><span class="pre">Disk.BackingType</span></tt></a>) – Backing type for the virtual disk.</li>
|
||
|
|
<li><strong>vmdk_file</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Path of the VMDK file backing the virtual disk.
|
||
|
|
This attribute is optional and it is only relevant when the value
|
||
|
|
of <tt class="docutils literal"><span class="pre">type</span></tt> is <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Disk.BackingType.VMDK_FILE" title="com.vmware.vcenter.vm.hardware_client.Disk.BackingType.VMDK_FILE"><tt class="xref py py-attr docutils literal"><span class="pre">Disk.BackingType.VMDK_FILE</span></tt></a>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.BackingType">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Disk.</tt><tt class="descname">BackingType</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Disk.BackingType" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Disk.BackingType</span></tt> class defines the valid backing types for a
|
||
|
|
virtual disk.</p>
|
||
|
|
<div class="admonition note">
|
||
|
|
<p class="first admonition-title">Note</p>
|
||
|
|
<p class="last">This class represents an enumerated type in the interface language
|
||
|
|
definition. The class contains class attributes which represent the
|
||
|
|
values in the current version of the enumerated type. Newer versions of
|
||
|
|
the enumerated type may contain new values. To use new values of the
|
||
|
|
enumerated type in communication with a server that supports the newer
|
||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
||
|
|
type description page</em></a>.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <tt class="xref py py-class docutils literal"><span class="pre">BackingType</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.BackingType.VMDK_FILE">
|
||
|
|
<tt class="descname">VMDK_FILE</tt><em class="property"> = BackingType(string=u'VMDK_FILE')</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Disk.BackingType.VMDK_FILE" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Virtual disk is backed by a VMDK file.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.CreateSpec">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Disk.</tt><tt class="descname">CreateSpec</tt><big>(</big><em>type=None</em>, <em>ide=None</em>, <em>scsi=None</em>, <em>sata=None</em>, <em>backing=None</em>, <em>new_vmdk=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Disk.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Disk.CreateSpec</span></tt> class provides a specification for the
|
||
|
|
configuration of a newly-created virtual disk.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Disk.HostBusAdapterType" title="com.vmware.vcenter.vm.hardware_client.Disk.HostBusAdapterType"><tt class="xref py py-class docutils literal"><span class="pre">Disk.HostBusAdapterType</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Type of host bus adapter to which the device should be attached.
|
||
|
|
If None, guest-specific default values will be used</li>
|
||
|
|
<li><strong>ide</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.IdeAddressSpec" title="com.vmware.vcenter.vm.hardware_client.IdeAddressSpec"><tt class="xref py py-class docutils literal"><span class="pre">IdeAddressSpec</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Address for attaching the device to a virtual IDE adapter.
|
||
|
|
If None, the server will choose an available address; if none is
|
||
|
|
available, the request will fail.</li>
|
||
|
|
<li><strong>scsi</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.ScsiAddressSpec" title="com.vmware.vcenter.vm.hardware_client.ScsiAddressSpec"><tt class="xref py py-class docutils literal"><span class="pre">ScsiAddressSpec</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Address for attaching the device to a virtual SCSI adapter.
|
||
|
|
If None, the server will choose an available address; if none is
|
||
|
|
available, the request will fail.</li>
|
||
|
|
<li><strong>sata</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.SataAddressSpec" title="com.vmware.vcenter.vm.hardware_client.SataAddressSpec"><tt class="xref py py-class docutils literal"><span class="pre">SataAddressSpec</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Address for attaching the device to a virtual SATA adapter.
|
||
|
|
If None, the server will choose an available address; if none is
|
||
|
|
available, the request will fail.</li>
|
||
|
|
<li><strong>backing</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Disk.BackingSpec" title="com.vmware.vcenter.vm.hardware_client.Disk.BackingSpec"><tt class="xref py py-class docutils literal"><span class="pre">Disk.BackingSpec</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Existing physical resource backing for the virtual disk. Exactly
|
||
|
|
one of <tt class="docutils literal"><span class="pre">backing</span></tt> or <tt class="docutils literal"><span class="pre">newVmdk</span></tt> must be specified.
|
||
|
|
If None, the virtual disk will not be connected to an existing
|
||
|
|
backing.</li>
|
||
|
|
<li><strong>new_vmdk</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Disk.VmdkCreateSpec" title="com.vmware.vcenter.vm.hardware_client.Disk.VmdkCreateSpec"><tt class="xref py py-class docutils literal"><span class="pre">Disk.VmdkCreateSpec</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Specification for creating a new VMDK backing for the virtual disk.
|
||
|
|
Exactly one of <tt class="docutils literal"><span class="pre">backing</span></tt> or <tt class="docutils literal"><span class="pre">newVmdk</span></tt> must be specified.
|
||
|
|
If None, a new VMDK backing will not be created.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.HostBusAdapterType">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Disk.</tt><tt class="descname">HostBusAdapterType</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Disk.HostBusAdapterType" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Disk.HostBusAdapterType</span></tt> class defines the valid types of host bus
|
||
|
|
adapters that may be used for attaching a virtual storage device to a
|
||
|
|
virtual machine.</p>
|
||
|
|
<div class="admonition note">
|
||
|
|
<p class="first admonition-title">Note</p>
|
||
|
|
<p class="last">This class represents an enumerated type in the interface language
|
||
|
|
definition. The class contains class attributes which represent the
|
||
|
|
values in the current version of the enumerated type. Newer versions of
|
||
|
|
the enumerated type may contain new values. To use new values of the
|
||
|
|
enumerated type in communication with a server that supports the newer
|
||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
||
|
|
type description page</em></a>.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <tt class="xref py py-class docutils literal"><span class="pre">HostBusAdapterType</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.HostBusAdapterType.IDE">
|
||
|
|
<tt class="descname">IDE</tt><em class="property"> = HostBusAdapterType(string=u'IDE')</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Disk.HostBusAdapterType.IDE" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Disk is attached to an IDE adapter.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.HostBusAdapterType.SATA">
|
||
|
|
<tt class="descname">SATA</tt><em class="property"> = HostBusAdapterType(string=u'SATA')</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Disk.HostBusAdapterType.SATA" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Disk is attached to a SATA adapter.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.HostBusAdapterType.SCSI">
|
||
|
|
<tt class="descname">SCSI</tt><em class="property"> = HostBusAdapterType(string=u'SCSI')</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Disk.HostBusAdapterType.SCSI" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Disk is attached to a SCSI adapter.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.Info">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Disk.</tt><tt class="descname">Info</tt><big>(</big><em>label=None</em>, <em>type=None</em>, <em>ide=None</em>, <em>scsi=None</em>, <em>sata=None</em>, <em>backing=None</em>, <em>capacity=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Disk.Info" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Disk.Info</span></tt> class contains information about a virtual disk.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>label</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Device label.</li>
|
||
|
|
<li><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Disk.HostBusAdapterType" title="com.vmware.vcenter.vm.hardware_client.Disk.HostBusAdapterType"><tt class="xref py py-class docutils literal"><span class="pre">Disk.HostBusAdapterType</span></tt></a>) – Type of host bus adapter to which the device is attached.</li>
|
||
|
|
<li><strong>ide</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.IdeAddressInfo" title="com.vmware.vcenter.vm.hardware_client.IdeAddressInfo"><tt class="xref py py-class docutils literal"><span class="pre">IdeAddressInfo</span></tt></a>) – Address of device attached to a virtual IDE adapter.
|
||
|
|
Workaround for PR1459646</li>
|
||
|
|
<li><strong>scsi</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.ScsiAddressInfo" title="com.vmware.vcenter.vm.hardware_client.ScsiAddressInfo"><tt class="xref py py-class docutils literal"><span class="pre">ScsiAddressInfo</span></tt></a>) – Address of device attached to a virtual SCSI adapter.
|
||
|
|
Workaround for PR1459646</li>
|
||
|
|
<li><strong>sata</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.SataAddressInfo" title="com.vmware.vcenter.vm.hardware_client.SataAddressInfo"><tt class="xref py py-class docutils literal"><span class="pre">SataAddressInfo</span></tt></a>) – Address of device attached to a virtual SATA adapter.
|
||
|
|
Workaround for PR1459646</li>
|
||
|
|
<li><strong>backing</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Disk.BackingInfo" title="com.vmware.vcenter.vm.hardware_client.Disk.BackingInfo"><tt class="xref py py-class docutils literal"><span class="pre">Disk.BackingInfo</span></tt></a>) – Physical resource backing for the virtual disk.</li>
|
||
|
|
<li><strong>capacity</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Capacity of the virtual disk in bytes.
|
||
|
|
If None, virtual disk is inaccessible or disk capacity is 0.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.RESOURCE_TYPE">
|
||
|
|
<tt class="descclassname">Disk.</tt><tt class="descname">RESOURCE_TYPE</tt><em class="property"> = 'com.vmware.vcenter.vm.hardware.Disk'</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Disk.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Resource type for the virtual disk.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.Summary">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Disk.</tt><tt class="descname">Summary</tt><big>(</big><em>disk=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Disk.Summary" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Disk.Summary</span></tt> class contains commonly used information about a
|
||
|
|
virtual disk.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>disk</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the virtual Disk.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></tt>. When methods return a
|
||
|
|
value of this class as a return value, the attribute will be an
|
||
|
|
identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.UpdateSpec">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Disk.</tt><tt class="descname">UpdateSpec</tt><big>(</big><em>backing=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Disk.UpdateSpec" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Disk.UpdateSpec</span></tt> class describes the updates to be made to the
|
||
|
|
configuration of a virtual disk.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>backing</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Disk.BackingSpec" title="com.vmware.vcenter.vm.hardware_client.Disk.BackingSpec"><tt class="xref py py-class docutils literal"><span class="pre">Disk.BackingSpec</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – <p>Physical resource backing for the virtual disk.</p>
|
||
|
|
<p>This attribute may only be modified if the virtual machine is not
|
||
|
|
powered on.
|
||
|
|
If None, the value is unchanged.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.VmdkCreateSpec">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Disk.</tt><tt class="descname">VmdkCreateSpec</tt><big>(</big><em>name=None</em>, <em>capacity=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Disk.VmdkCreateSpec" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Disk.VmdkCreateSpec</span></tt> class provides a specification for creating a
|
||
|
|
new VMDK file to be used as a backing for a virtual disk. The virtual disk
|
||
|
|
will be stored in the same directory as the virtual machine’s configuration
|
||
|
|
file.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Base name of the VMDK file. The name should not include the ‘.vmdk’
|
||
|
|
file extension.
|
||
|
|
If None, a name (derived from the name of the virtual machine) will
|
||
|
|
be chosen by the server.</li>
|
||
|
|
<li><strong>capacity</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Capacity of the virtual disk backing in bytes.
|
||
|
|
If None, defaults to a guest-specific capacity.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.create">
|
||
|
|
<tt class="descclassname">Disk.</tt><tt class="descname">create</tt><big>(</big><em>vm</em>, <em>spec</em><big>)</big><a class="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
|
||
|
|
used to back the virtual disk.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</li>
|
||
|
|
<li><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Disk.CreateSpec" title="com.vmware.vcenter.vm.hardware_client.Disk.CreateSpec"><tt class="xref py py-class docutils literal"><span class="pre">Disk.CreateSpec</span></tt></a>) – Specification for the new virtual disk.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">str</span></tt></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Virtual disk identifier.
|
||
|
|
The return value will be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if system reported that the disk device was created but was unable
|
||
|
|
to confirm the creation because the identifier of the new device
|
||
|
|
could not be determined.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the virtual machine is not found.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></tt>
|
||
|
|
if the virtual machine is suspended or if the virtual machine is
|
||
|
|
powered on and virtual disk type is IDE.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></tt>
|
||
|
|
if the specified storage address is unavailable; for example, if
|
||
|
|
the SCSI adapter requested does not exist.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInUse</span></tt>
|
||
|
|
if the specified storage address is in use.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt>
|
||
|
|
if the specified storage address is out of bounds.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></tt>
|
||
|
|
if the virtual machine is busy performing another operation.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></tt>
|
||
|
|
if the guest operating system of the virtual machine is not
|
||
|
|
supported and spec includes None attributes that default to
|
||
|
|
guest-specific values.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.delete">
|
||
|
|
<tt class="descclassname">Disk.</tt><tt class="descname">delete</tt><big>(</big><em>vm</em>, <em>disk</em><big>)</big><a class="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
|
||
|
|
deleted.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</li>
|
||
|
|
<li><strong>disk</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual disk identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the virtual machine or virtual disk is not found.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></tt>
|
||
|
|
if the virtual machine is suspended or if the virtual machine is
|
||
|
|
powered on and virtual disk type is IDE.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></tt>
|
||
|
|
if the virtual machine is busy performing another operation.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.get">
|
||
|
|
<tt class="descclassname">Disk.</tt><tt class="descname">get</tt><big>(</big><em>vm</em>, <em>disk</em><big>)</big><a class="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>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</li>
|
||
|
|
<li><strong>disk</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual disk identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Disk.Info" title="com.vmware.vcenter.vm.hardware_client.Disk.Info"><tt class="xref py py-class docutils literal"><span class="pre">Disk.Info</span></tt></a></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Information about the specified virtual disk.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the virtual machine or virtual disk is not found.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.list">
|
||
|
|
<tt class="descclassname">Disk.</tt><tt class="descname">list</tt><big>(</big><em>vm</em><big>)</big><a class="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
|
||
|
|
the virtual machine.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Disk.list" title="com.vmware.vcenter.vm.hardware_client.Disk.list"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Disk.Summary" title="com.vmware.vcenter.vm.hardware_client.Disk.Summary"><tt class="xref py py-class docutils literal"><span class="pre">Disk.Summary</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">List of commonly used information about the virtual disks.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the virtual machine is not found.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the virtual machine’s configuration state cannot be accessed.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.update">
|
||
|
|
<tt class="descclassname">Disk.</tt><tt class="descname">update</tt><big>(</big><em>vm</em>, <em>disk</em>, <em>spec</em><big>)</big><a class="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
|
||
|
|
the virtual machine.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</li>
|
||
|
|
<li><strong>disk</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual disk identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></tt>.</li>
|
||
|
|
<li><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Disk.UpdateSpec" title="com.vmware.vcenter.vm.hardware_client.Disk.UpdateSpec"><tt class="xref py py-class docutils literal"><span class="pre">Disk.UpdateSpec</span></tt></a>) – Specification for updating the virtual disk.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the virtual machine or virtual disk is not found.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></tt>
|
||
|
|
if one or more of the attributes specified in the <tt class="docutils literal"><span class="pre">spec</span></tt>
|
||
|
|
parameter cannot be modified due to the current power state of the
|
||
|
|
virtual machine or the connection state of the virtual disk.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></tt>
|
||
|
|
if the virtual machine is busy performing another operation.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter.vm.hardware_client.</tt><tt class="descname">Ethernet</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Ethernet" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Ethernet</span></tt> class provides methods for configuring the virtual
|
||
|
|
Ethernet adapters of a virtual machine.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingInfo">
|
||
|
|
<em class="property">class </em><tt class="descname">BackingInfo</tt><big>(</big><em>type=None</em>, <em>network=None</em>, <em>network_name=None</em>, <em>host_device=None</em>, <em>distributed_switch_uuid=None</em>, <em>distributed_port=None</em>, <em>connection_cookie=None</em>, <em>opaque_network_type=None</em>, <em>opaque_network_id=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingInfo" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Ethernet.BackingInfo</span></tt> class contains information about the physical
|
||
|
|
resource backing a virtual Ethernet adapter.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType" title="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType"><tt class="xref py py-class docutils literal"><span class="pre">Ethernet.BackingType</span></tt></a>) – Backing type for the virtual Ethernet adapter.</li>
|
||
|
|
<li><strong>network</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – 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: <tt class="docutils literal"><span class="pre">Network</span></tt>.
|
||
|
|
When methods return a value of this class as a return value, the
|
||
|
|
attribute will be an identifier for the resource type: <tt class="docutils literal"><span class="pre">Network</span></tt>.
|
||
|
|
If None, the identifier of the network backing could not be
|
||
|
|
determined.</li>
|
||
|
|
<li><strong>network_name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Name of the standard portgroup backing the virtual Ethernet
|
||
|
|
adapter.
|
||
|
|
This attribute is optional and it is only relevant when the value
|
||
|
|
of <tt class="docutils literal"><span class="pre">type</span></tt> is <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.STANDARD_PORTGROUP" title="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.STANDARD_PORTGROUP"><tt class="xref py py-attr docutils literal"><span class="pre">Ethernet.BackingType.STANDARD_PORTGROUP</span></tt></a>.</li>
|
||
|
|
<li><strong>host_device</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Name of the device backing the virtual Ethernet adapter.
|
||
|
|
This attribute is optional and it is only relevant when the value
|
||
|
|
of <tt class="docutils literal"><span class="pre">type</span></tt> is <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.HOST_DEVICE" title="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.HOST_DEVICE"><tt class="xref py py-attr docutils literal"><span class="pre">Ethernet.BackingType.HOST_DEVICE</span></tt></a>.</li>
|
||
|
|
<li><strong>distributed_switch_uuid</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – 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 <tt class="docutils literal"><span class="pre">type</span></tt> is <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.DISTRIBUTED_PORTGROUP" title="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.DISTRIBUTED_PORTGROUP"><tt class="xref py py-attr docutils literal"><span class="pre">Ethernet.BackingType.DISTRIBUTED_PORTGROUP</span></tt></a>.</li>
|
||
|
|
<li><strong>distributed_port</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Key of the distributed virtual port that backs the virtual Ethernet
|
||
|
|
adapter.
|
||
|
|
This attribute will be None if the virtual Ethernet device is not
|
||
|
|
bound to a distributed virtual port; this can happen if the virtual
|
||
|
|
machine is powered off or the virtual Ethernet device is not
|
||
|
|
connected.</li>
|
||
|
|
<li><strong>connection_cookie</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Server-generated cookie that identifies the connection to the port.
|
||
|
|
This ookie may be used to verify that the virtual machine is the
|
||
|
|
rightful owner of the port.
|
||
|
|
This attribute will be None if the virtual Ethernet device is not
|
||
|
|
bound to a distributed virtual port; this can happen if the virtual
|
||
|
|
machine is powered off or the virtual Ethernet device is not
|
||
|
|
connected.</li>
|
||
|
|
<li><strong>opaque_network_type</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Type of the opaque network that backs the virtual Ethernet adapter.
|
||
|
|
This attribute is optional and it is only relevant when the value
|
||
|
|
of <tt class="docutils literal"><span class="pre">type</span></tt> is <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.OPAQUE_NETWORK" title="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.OPAQUE_NETWORK"><tt class="xref py py-attr docutils literal"><span class="pre">Ethernet.BackingType.OPAQUE_NETWORK</span></tt></a>.</li>
|
||
|
|
<li><strong>opaque_network_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the opaque network that backs the virtual Ethernet
|
||
|
|
adapter.
|
||
|
|
This attribute is optional and it is only relevant when the value
|
||
|
|
of <tt class="docutils literal"><span class="pre">type</span></tt> is <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.OPAQUE_NETWORK" title="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.OPAQUE_NETWORK"><tt class="xref py py-attr docutils literal"><span class="pre">Ethernet.BackingType.OPAQUE_NETWORK</span></tt></a>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingSpec">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Ethernet.</tt><tt class="descname">BackingSpec</tt><big>(</big><em>type=None</em>, <em>network=None</em>, <em>distributed_port=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingSpec" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Ethernet.BackingSpec</span></tt> class provides a specification of the physical
|
||
|
|
resource that backs a virtual Ethernet adapter.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType" title="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType"><tt class="xref py py-class docutils literal"><span class="pre">Ethernet.BackingType</span></tt></a>) – Backing type for the virtual Ethernet adapter.</li>
|
||
|
|
<li><strong>network</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – 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: <tt class="docutils literal"><span class="pre">Network</span></tt>.
|
||
|
|
When methods return a value of this class as a return value, the
|
||
|
|
attribute will be an identifier for the resource type: <tt class="docutils literal"><span class="pre">Network</span></tt>.
|
||
|
|
This attribute is optional and it is only relevant when the value
|
||
|
|
of <tt class="docutils literal"><span class="pre">type</span></tt> is one of
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.STANDARD_PORTGROUP" title="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.STANDARD_PORTGROUP"><tt class="xref py py-attr docutils literal"><span class="pre">Ethernet.BackingType.STANDARD_PORTGROUP</span></tt></a>,
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.DISTRIBUTED_PORTGROUP" title="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.DISTRIBUTED_PORTGROUP"><tt class="xref py py-attr docutils literal"><span class="pre">Ethernet.BackingType.DISTRIBUTED_PORTGROUP</span></tt></a>, or
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.OPAQUE_NETWORK" title="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.OPAQUE_NETWORK"><tt class="xref py py-attr docutils literal"><span class="pre">Ethernet.BackingType.OPAQUE_NETWORK</span></tt></a>.</li>
|
||
|
|
<li><strong>distributed_port</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – 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
|
||
|
|
<tt class="docutils literal"><span class="pre">network</span></tt> 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
|
||
|
|
type.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Ethernet.</tt><tt class="descname">BackingType</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Ethernet.BackingType</span></tt> class defines the valid backing types for a
|
||
|
|
virtual Ethernet adapter.</p>
|
||
|
|
<div class="admonition note">
|
||
|
|
<p class="first admonition-title">Note</p>
|
||
|
|
<p class="last">This class represents an enumerated type in the interface language
|
||
|
|
definition. The class contains class attributes which represent the
|
||
|
|
values in the current version of the enumerated type. Newer versions of
|
||
|
|
the enumerated type may contain new values. To use new values of the
|
||
|
|
enumerated type in communication with a server that supports the newer
|
||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
||
|
|
type description page</em></a>.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <tt class="xref py py-class docutils literal"><span class="pre">BackingType</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.DISTRIBUTED_PORTGROUP">
|
||
|
|
<tt class="descname">DISTRIBUTED_PORTGROUP</tt><em class="property"> = BackingType(string=u'DISTRIBUTED_PORTGROUP')</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.DISTRIBUTED_PORTGROUP" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Distributed virtual switch backing.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.HOST_DEVICE">
|
||
|
|
<tt class="descname">HOST_DEVICE</tt><em class="property"> = BackingType(string=u'HOST_DEVICE')</em><a class="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>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.OPAQUE_NETWORK">
|
||
|
|
<tt class="descname">OPAQUE_NETWORK</tt><em class="property"> = BackingType(string=u'OPAQUE_NETWORK')</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.OPAQUE_NETWORK" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Opaque network backing.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.STANDARD_PORTGROUP">
|
||
|
|
<tt class="descname">STANDARD_PORTGROUP</tt><em class="property"> = BackingType(string=u'STANDARD_PORTGROUP')</em><a class="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>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.CreateSpec">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Ethernet.</tt><tt class="descname">CreateSpec</tt><big>(</big><em>type=None</em>, <em>upt_compatibility_enabled=None</em>, <em>mac_type=None</em>, <em>mac_address=None</em>, <em>pci_slot_number=None</em>, <em>wake_on_lan_enabled=None</em>, <em>backing=None</em>, <em>start_connected=None</em>, <em>allow_guest_control=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Ethernet.CreateSpec</span></tt> class provides a specification for the
|
||
|
|
configuration of a newly-created virtual Ethernet adapter.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType" title="com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType"><tt class="xref py py-class docutils literal"><span class="pre">Ethernet.EmulationType</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Ethernet adapter emulation type.
|
||
|
|
If None, defaults to a guest-specific type.</li>
|
||
|
|
<li><strong>upt_compatibility_enabled</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Flag indicating whether Universal Pass-Through (UPT) compatibility
|
||
|
|
is enabled on this virtual Ethernet adapter.
|
||
|
|
If None, defaults to false.</li>
|
||
|
|
<li><strong>mac_type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType" title="com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType"><tt class="xref py py-class docutils literal"><span class="pre">Ethernet.MacAddressType</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – MAC address type.
|
||
|
|
If None, defaults to <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType.GENERATED" title="com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType.GENERATED"><tt class="xref py py-attr docutils literal"><span class="pre">Ethernet.MacAddressType.GENERATED</span></tt></a>.</li>
|
||
|
|
<li><strong>mac_address</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – MAC address.
|
||
|
|
Workaround for PR1459647</li>
|
||
|
|
<li><strong>pci_slot_number</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Address of the virtual Ethernet adapter on the PCI bus. If the PCI
|
||
|
|
address is invalid, the server will change when it the VM is
|
||
|
|
started or as the device is hot added.
|
||
|
|
If None, the server will choose an available address when the
|
||
|
|
virtual machine is powered on.</li>
|
||
|
|
<li><strong>wake_on_lan_enabled</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Flag indicating whether wake-on-LAN is enabled on this virtual
|
||
|
|
Ethernet adapter.
|
||
|
|
Defaults to false if None.</li>
|
||
|
|
<li><strong>backing</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingSpec" title="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingSpec"><tt class="xref py py-class docutils literal"><span class="pre">Ethernet.BackingSpec</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Physical resource backing for the virtual Ethernet adapter.
|
||
|
|
If None, the system may try to find an appropriate backing. If one
|
||
|
|
is not found, the request will fail.</li>
|
||
|
|
<li><strong>start_connected</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Flag indicating whether the virtual device should be connected
|
||
|
|
whenever the virtual machine is powered on.
|
||
|
|
Defaults to false if None.</li>
|
||
|
|
<li><strong>allow_guest_control</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Flag indicating whether the guest can connect and disconnect the
|
||
|
|
device.
|
||
|
|
Defaults to false if None.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Ethernet.</tt><tt class="descname">EmulationType</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Ethernet.EmulationType</span></tt> class defines the valid emulation types for
|
||
|
|
a virtual Ethernet adapter.</p>
|
||
|
|
<div class="admonition note">
|
||
|
|
<p class="first admonition-title">Note</p>
|
||
|
|
<p class="last">This class represents an enumerated type in the interface language
|
||
|
|
definition. The class contains class attributes which represent the
|
||
|
|
values in the current version of the enumerated type. Newer versions of
|
||
|
|
the enumerated type may contain new values. To use new values of the
|
||
|
|
enumerated type in communication with a server that supports the newer
|
||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
||
|
|
type description page</em></a>.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <tt class="xref py py-class docutils literal"><span class="pre">EmulationType</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType.E1000">
|
||
|
|
<tt class="descname">E1000</tt><em class="property"> = EmulationType(string=u'E1000')</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType.E1000" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>E1000 ethernet adapter.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType.E1000E">
|
||
|
|
<tt class="descname">E1000E</tt><em class="property"> = EmulationType(string=u'E1000E')</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType.E1000E" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>E1000e ethernet adapter.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType.PCNET32">
|
||
|
|
<tt class="descname">PCNET32</tt><em class="property"> = EmulationType(string=u'PCNET32')</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType.PCNET32" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>AMD Lance PCNet32 Ethernet adapter.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType.VMXNET">
|
||
|
|
<tt class="descname">VMXNET</tt><em class="property"> = EmulationType(string=u'VMXNET')</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType.VMXNET" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>VMware Vmxnet virtual Ethernet adapter.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType.VMXNET2">
|
||
|
|
<tt class="descname">VMXNET2</tt><em class="property"> = EmulationType(string=u'VMXNET2')</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType.VMXNET2" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>VMware Vmxnet2 virtual Ethernet adapter.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType.VMXNET3">
|
||
|
|
<tt class="descname">VMXNET3</tt><em class="property"> = EmulationType(string=u'VMXNET3')</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType.VMXNET3" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>VMware Vmxnet3 virtual Ethernet adapter.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.Info">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Ethernet.</tt><tt class="descname">Info</tt><big>(</big><em>label=None</em>, <em>type=None</em>, <em>upt_compatibility_enabled=None</em>, <em>mac_type=None</em>, <em>mac_address=None</em>, <em>pci_slot_number=None</em>, <em>wake_on_lan_enabled=None</em>, <em>backing=None</em>, <em>state=None</em>, <em>start_connected=None</em>, <em>allow_guest_control=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.Info" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Ethernet.Info</span></tt> class contains information about a virtual Ethernet
|
||
|
|
adapter.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>label</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Device label.</li>
|
||
|
|
<li><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType" title="com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType"><tt class="xref py py-class docutils literal"><span class="pre">Ethernet.EmulationType</span></tt></a>) – Ethernet adapter emulation type.</li>
|
||
|
|
<li><strong>upt_compatibility_enabled</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Flag indicating whether Universal Pass-Through (UPT) compatibility
|
||
|
|
is enabled on this virtual Ethernet adapter.
|
||
|
|
This attribute is optional and it is only relevant when the value
|
||
|
|
of <tt class="docutils literal"><span class="pre">type</span></tt> is <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType.VMXNET3" title="com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType.VMXNET3"><tt class="xref py py-attr docutils literal"><span class="pre">Ethernet.EmulationType.VMXNET3</span></tt></a>.</li>
|
||
|
|
<li><strong>mac_type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType" title="com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType"><tt class="xref py py-class docutils literal"><span class="pre">Ethernet.MacAddressType</span></tt></a>) – MAC address type.</li>
|
||
|
|
<li><strong>mac_address</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – MAC address.
|
||
|
|
May be None if <tt class="xref py py-attr docutils literal"><span class="pre">Ethernet.Info.mac_type</span></tt> is
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType.MANUAL" title="com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType.MANUAL"><tt class="xref py py-attr docutils literal"><span class="pre">Ethernet.MacAddressType.MANUAL</span></tt></a> and has not been specified,
|
||
|
|
or if <tt class="xref py py-attr docutils literal"><span class="pre">Ethernet.Info.mac_type</span></tt> is
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType.GENERATED" title="com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType.GENERATED"><tt class="xref py py-attr docutils literal"><span class="pre">Ethernet.MacAddressType.GENERATED</span></tt></a> and the virtual machine
|
||
|
|
has never been powered on since the Ethernet adapter was created.</li>
|
||
|
|
<li><strong>pci_slot_number</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Address of the virtual Ethernet adapter on the PCI bus. If the PCI
|
||
|
|
address is invalid, the server will change it when the VM is
|
||
|
|
started or as the device is hot added.
|
||
|
|
May be None if the virtual machine has never been powered on since
|
||
|
|
the adapter was created.</li>
|
||
|
|
<li><strong>wake_on_lan_enabled</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Flag indicating whether wake-on-LAN is enabled on this virtual
|
||
|
|
Ethernet adapter.</li>
|
||
|
|
<li><strong>backing</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingInfo" title="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingInfo"><tt class="xref py py-class docutils literal"><span class="pre">Ethernet.BackingInfo</span></tt></a>) – Physical resource backing for the virtual Ethernet adapter.</li>
|
||
|
|
<li><strong>state</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.ConnectionState" title="com.vmware.vcenter.vm.hardware_client.ConnectionState"><tt class="xref py py-class docutils literal"><span class="pre">ConnectionState</span></tt></a>) – Connection status of the virtual device.</li>
|
||
|
|
<li><strong>start_connected</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Flag indicating whether the virtual device should be connected
|
||
|
|
whenever the virtual machine is powered on.</li>
|
||
|
|
<li><strong>allow_guest_control</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Flag indicating whether the guest can connect and disconnect the
|
||
|
|
device.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Ethernet.</tt><tt class="descname">MacAddressType</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Ethernet.MacAddressType</span></tt> class defines the valid MAC address origins
|
||
|
|
for a virtual Ethernet adapter.</p>
|
||
|
|
<div class="admonition note">
|
||
|
|
<p class="first admonition-title">Note</p>
|
||
|
|
<p class="last">This class represents an enumerated type in the interface language
|
||
|
|
definition. The class contains class attributes which represent the
|
||
|
|
values in the current version of the enumerated type. Newer versions of
|
||
|
|
the enumerated type may contain new values. To use new values of the
|
||
|
|
enumerated type in communication with a server that supports the newer
|
||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
||
|
|
type description page</em></a>.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <tt class="xref py py-class docutils literal"><span class="pre">MacAddressType</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType.ASSIGNED">
|
||
|
|
<tt class="descname">ASSIGNED</tt><em class="property"> = MacAddressType(string=u'ASSIGNED')</em><a class="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>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType.GENERATED">
|
||
|
|
<tt class="descname">GENERATED</tt><em class="property"> = MacAddressType(string=u'GENERATED')</em><a class="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>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType.MANUAL">
|
||
|
|
<tt class="descname">MANUAL</tt><em class="property"> = MacAddressType(string=u'MANUAL')</em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType.MANUAL" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>MAC address is assigned statically.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.RESOURCE_TYPE">
|
||
|
|
<tt class="descclassname">Ethernet.</tt><tt class="descname">RESOURCE_TYPE</tt><em class="property"> = 'com.vmware.vcenter.vm.hardware.Ethernet'</em><a class="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>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.Summary">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Ethernet.</tt><tt class="descname">Summary</tt><big>(</big><em>nic=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.Summary" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Ethernet.Summary</span></tt> class contains commonly used information about a
|
||
|
|
virtual Ethernet adapter.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>nic</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of 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:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.Ethernet</span></tt>. When methods return a
|
||
|
|
value of this class as a return value, the attribute will be an
|
||
|
|
identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.Ethernet</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.UpdateSpec">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Ethernet.</tt><tt class="descname">UpdateSpec</tt><big>(</big><em>upt_compatibility_enabled=None</em>, <em>mac_type=None</em>, <em>mac_address=None</em>, <em>wake_on_lan_enabled=None</em>, <em>backing=None</em>, <em>start_connected=None</em>, <em>allow_guest_control=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.UpdateSpec" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Ethernet.UpdateSpec</span></tt> class describes the updates to be made to the
|
||
|
|
configuration of a virtual Ethernet adapter.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>upt_compatibility_enabled</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – <p>Flag indicating whether Universal Pass-Through (UPT) compatibility
|
||
|
|
should 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. Must be None if the emulation type
|
||
|
|
of the virtual Ethernet adapter is not
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType.VMXNET3" title="com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType.VMXNET3"><tt class="xref py py-attr docutils literal"><span class="pre">Ethernet.EmulationType.VMXNET3</span></tt></a>.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>mac_type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType" title="com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType"><tt class="xref py py-class docutils literal"><span class="pre">Ethernet.MacAddressType</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – <p>MAC address type.</p>
|
||
|
|
<p>This attribute may be modified at any time, and changes will be
|
||
|
|
applied the next time the virtual machine is powered on.
|
||
|
|
If None, the value is unchanged.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>mac_address</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – <p>MAC address.</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. Must be specified if
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">Ethernet.UpdateSpec.mac_type</span></tt> is
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType.MANUAL" title="com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType.MANUAL"><tt class="xref py py-attr docutils literal"><span class="pre">Ethernet.MacAddressType.MANUAL</span></tt></a>. Must be None if the MAC
|
||
|
|
address type is not <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType.MANUAL" title="com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType.MANUAL"><tt class="xref py py-attr docutils literal"><span class="pre">Ethernet.MacAddressType.MANUAL</span></tt></a>.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>wake_on_lan_enabled</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – <p>Flag indicating whether wake-on-LAN shoud be enabled on this
|
||
|
|
virtual Ethernet adapter.</p>
|
||
|
|
<p>This attribute may be modified at any time, and changes will be
|
||
|
|
applied the next time the virtual machine is powered on.
|
||
|
|
If None, the value is unchanged.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>backing</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingSpec" title="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingSpec"><tt class="xref py py-class docutils literal"><span class="pre">Ethernet.BackingSpec</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – <p>Physical resource backing for the virtual Ethernet adapter.</p>
|
||
|
|
<p>This attribute may be modified at any time, and changes will be
|
||
|
|
applied the next time the virtual machine is powered on.
|
||
|
|
If None, the value is unchanged.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>start_connected</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Flag indicating whether the virtual device should be connected
|
||
|
|
whenever the virtual machine is powered on.
|
||
|
|
If None, the value is unchanged.</li>
|
||
|
|
<li><strong>allow_guest_control</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Flag indicating whether the guest can connect and disconnect the
|
||
|
|
device.
|
||
|
|
If None, the value is unchanged.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.connect">
|
||
|
|
<tt class="descclassname">Ethernet.</tt><tt class="descname">connect</tt><big>(</big><em>vm</em>, <em>nic</em><big>)</big><a class="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 <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.update" title="com.vmware.vcenter.vm.hardware_client.Ethernet.update"><tt class="xref py py-func docutils literal"><span class="pre">Ethernet.update()</span></tt></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>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</li>
|
||
|
|
<li><strong>nic</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual Ethernet adapter identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.Ethernet</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the virtual machine or virtual Ethernet adapter is not found.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></tt>
|
||
|
|
if the virtual Ethernet adapter is already connected.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></tt>
|
||
|
|
if the virtual machine is not powered on.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></tt>
|
||
|
|
if the virtual machine is busy performing another operation.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.create">
|
||
|
|
<tt class="descclassname">Ethernet.</tt><tt class="descname">create</tt><big>(</big><em>vm</em>, <em>spec</em><big>)</big><a class="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>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</li>
|
||
|
|
<li><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.CreateSpec" title="com.vmware.vcenter.vm.hardware_client.Ethernet.CreateSpec"><tt class="xref py py-class docutils literal"><span class="pre">Ethernet.CreateSpec</span></tt></a>) – Specification for the new virtual Ethernet adapter.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">str</span></tt></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Virtual Ethernet adapter identifier.
|
||
|
|
The return value will be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.Ethernet</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reported that the Ethernet adapter was created but
|
||
|
|
was unable to confirm the creation because the identifier of the
|
||
|
|
new adapter could not be determined.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the virtual machine or network backing is not found.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></tt>
|
||
|
|
if the virtual machine already has the maximum number of supported
|
||
|
|
Ethernet adapters.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt>
|
||
|
|
if the specified PCI address is out of bounds, HOST_DEVICE is
|
||
|
|
specified as the type, or a backing cannot be found in the case
|
||
|
|
that backing is left None.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></tt>
|
||
|
|
if the virtual machine is busy performing another operation.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></tt>
|
||
|
|
if the guest operating system of the virtual machine is not
|
||
|
|
supported and spec includes None attributes that default to
|
||
|
|
guest-specific values.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.delete">
|
||
|
|
<tt class="descclassname">Ethernet.</tt><tt class="descname">delete</tt><big>(</big><em>vm</em>, <em>nic</em><big>)</big><a class="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>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</li>
|
||
|
|
<li><strong>nic</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual Ethernet adapter identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.Ethernet</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the virtual machine or virtual Ethernet adapter is not found.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></tt>
|
||
|
|
if the virtual machine is busy performing another operation.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.disconnect">
|
||
|
|
<tt class="descclassname">Ethernet.</tt><tt class="descname">disconnect</tt><big>(</big><em>vm</em>, <em>nic</em><big>)</big><a class="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 <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.update" title="com.vmware.vcenter.vm.hardware_client.Ethernet.update"><tt class="xref py py-func docutils literal"><span class="pre">Ethernet.update()</span></tt></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>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</li>
|
||
|
|
<li><strong>nic</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual Ethernet adapter identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.Ethernet</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the virtual machine or virtual Ethernet adapter is not found.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></tt>
|
||
|
|
if the virtual Ethernet adapter is already disconnected.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></tt>
|
||
|
|
if the virtual machine is not powered on.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></tt>
|
||
|
|
if the virtual machine is busy performing another operation.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.get">
|
||
|
|
<tt class="descclassname">Ethernet.</tt><tt class="descname">get</tt><big>(</big><em>vm</em>, <em>nic</em><big>)</big><a class="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>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</li>
|
||
|
|
<li><strong>nic</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual Ethernet adapter identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.Ethernet</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.Info" title="com.vmware.vcenter.vm.hardware_client.Ethernet.Info"><tt class="xref py py-class docutils literal"><span class="pre">Ethernet.Info</span></tt></a></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Information about the specified virtual Ethernet adapter.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the virtual machine or virtual Ethernet adapter is not found.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.list">
|
||
|
|
<tt class="descclassname">Ethernet.</tt><tt class="descname">list</tt><big>(</big><em>vm</em><big>)</big><a class="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
|
||
|
|
belonging to the virtual machine.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.list" title="com.vmware.vcenter.vm.hardware_client.Ethernet.list"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.Summary" title="com.vmware.vcenter.vm.hardware_client.Ethernet.Summary"><tt class="xref py py-class docutils literal"><span class="pre">Ethernet.Summary</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">List of commonly used information about virtual Ethernet adapters.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the virtual machine is not found.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the virtual machine’s configuration state cannot be accessed.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.update">
|
||
|
|
<tt class="descclassname">Ethernet.</tt><tt class="descname">update</tt><big>(</big><em>vm</em>, <em>nic</em>, <em>spec</em><big>)</big><a class="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>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</li>
|
||
|
|
<li><strong>nic</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual Ethernet adapter identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.Ethernet</span></tt>.</li>
|
||
|
|
<li><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.UpdateSpec" title="com.vmware.vcenter.vm.hardware_client.Ethernet.UpdateSpec"><tt class="xref py py-class docutils literal"><span class="pre">Ethernet.UpdateSpec</span></tt></a>) – Specification for updating the virtual Ethernet adapter.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt>
|
||
|
|
if HOST_DEVICE is specified as the type.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the virtual machine, virtual Ethernet adapter, or backing
|
||
|
|
network is not found.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></tt>
|
||
|
|
if the virtual machine is busy performing another operation.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Floppy">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter.vm.hardware_client.</tt><tt class="descname">Floppy</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Floppy" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Floppy</span></tt> class provides methods for configuring the virtual floppy
|
||
|
|
drives of a virtual machine.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Floppy.BackingInfo">
|
||
|
|
<em class="property">class </em><tt class="descname">BackingInfo</tt><big>(</big><em>type=None</em>, <em>image_file=None</em>, <em>host_device=None</em>, <em>auto_detect=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Floppy.BackingInfo" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Floppy.BackingInfo</span></tt> class contains information about the physical
|
||
|
|
resource backing a virtual floppy drive.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Floppy.BackingType" title="com.vmware.vcenter.vm.hardware_client.Floppy.BackingType"><tt class="xref py py-class docutils literal"><span class="pre">Floppy.BackingType</span></tt></a>) – Backing type for the virtual floppy drive.</li>
|
||
|
|
<li><strong>image_file</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Path of the image file backing the virtual floppy drive.
|
||
|
|
This attribute is optional and it is only relevant when the value
|
||
|
|
of <tt class="docutils literal"><span class="pre">type</span></tt> is <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Floppy.BackingType.IMAGE_FILE" title="com.vmware.vcenter.vm.hardware_client.Floppy.BackingType.IMAGE_FILE"><tt class="xref py py-attr docutils literal"><span class="pre">Floppy.BackingType.IMAGE_FILE</span></tt></a>.</li>
|
||
|
|
<li><strong>host_device</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Name of the host device backing the virtual floppy drive.
|
||
|
|
This attribute will be None if <tt class="docutils literal"><span class="pre">autoDetect</span></tt> is true and the
|
||
|
|
virtual floppy drive is not connected or no suitable device is
|
||
|
|
available on the host.</li>
|
||
|
|
<li><strong>auto_detect</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – 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 <tt class="docutils literal"><span class="pre">type</span></tt> is <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Floppy.BackingType.HOST_DEVICE" title="com.vmware.vcenter.vm.hardware_client.Floppy.BackingType.HOST_DEVICE"><tt class="xref py py-attr docutils literal"><span class="pre">Floppy.BackingType.HOST_DEVICE</span></tt></a>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Floppy.BackingSpec">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Floppy.</tt><tt class="descname">BackingSpec</tt><big>(</big><em>type=None</em>, <em>image_file=None</em>, <em>host_device=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Floppy.BackingSpec" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Floppy.BackingSpec</span></tt> class provides a specification of the physical
|
||
|
|
resource backing a virtual floppy drive.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Floppy.BackingType" title="com.vmware.vcenter.vm.hardware_client.Floppy.BackingType"><tt class="xref py py-class docutils literal"><span class="pre">Floppy.BackingType</span></tt></a>) – Backing type for the virtual floppy drive.</li>
|
||
|
|
<li><strong>image_file</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – 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 <tt class="docutils literal"><span class="pre">type</span></tt> is <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Floppy.BackingType.IMAGE_FILE" title="com.vmware.vcenter.vm.hardware_client.Floppy.BackingType.IMAGE_FILE"><tt class="xref py py-attr docutils literal"><span class="pre">Floppy.BackingType.IMAGE_FILE</span></tt></a>.</li>
|
||
|
|
<li><strong>host_device</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – 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.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Floppy.BackingType">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Floppy.</tt><tt class="descname">BackingType</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Floppy.BackingType" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Floppy.BackingType</span></tt> class defines the valid backing types for a
|
||
|
|
virtual floppy drive.</p>
|
||
|
|
<div class="admonition note">
|
||
|
|
<p class="first admonition-title">Note</p>
|
||
|
|
<p class="last">This class represents an enumerated type in the interface language
|
||
|
|
definition. The class contains class attributes which represent the
|
||
|
|
values in the current version of the enumerated type. Newer versions of
|
||
|
|
the enumerated type may contain new values. To use new values of the
|
||
|
|
enumerated type in communication with a server that supports the newer
|
||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
||
|
|
type description page</em></a>.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <tt class="xref py py-class docutils literal"><span class="pre">BackingType</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Floppy.BackingType.CLIENT_DEVICE">
|
||
|
|
<tt class="descname">CLIENT_DEVICE</tt><em class="property"> = BackingType(string=u'CLIENT_DEVICE')</em><a class="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
|
||
|
|
to the virtual machine console.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Floppy.BackingType.HOST_DEVICE">
|
||
|
|
<tt class="descname">HOST_DEVICE</tt><em class="property"> = BackingType(string=u'HOST_DEVICE')</em><a class="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
|
||
|
|
machine is running.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Floppy.BackingType.IMAGE_FILE">
|
||
|
|
<tt class="descname">IMAGE_FILE</tt><em class="property"> = BackingType(string=u'IMAGE_FILE')</em><a class="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>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Floppy.CreateSpec">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Floppy.</tt><tt class="descname">CreateSpec</tt><big>(</big><em>backing=None</em>, <em>start_connected=None</em>, <em>allow_guest_control=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Floppy.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Floppy.CreateSpec</span></tt> class provides a specification for the
|
||
|
|
configuration of a newly-created virtual floppy drive.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>backing</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Floppy.BackingSpec" title="com.vmware.vcenter.vm.hardware_client.Floppy.BackingSpec"><tt class="xref py py-class docutils literal"><span class="pre">Floppy.BackingSpec</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Physical resource backing for the virtual floppy drive.
|
||
|
|
If None, defaults to automatic detection of a suitable host device.</li>
|
||
|
|
<li><strong>start_connected</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Flag indicating whether the virtual device should be connected
|
||
|
|
whenever the virtual machine is powered on.
|
||
|
|
Defaults to false if None.</li>
|
||
|
|
<li><strong>allow_guest_control</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Flag indicating whether the guest can connect and disconnect the
|
||
|
|
device.
|
||
|
|
Defaults to false if None.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Floppy.Info">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Floppy.</tt><tt class="descname">Info</tt><big>(</big><em>label=None</em>, <em>backing=None</em>, <em>state=None</em>, <em>start_connected=None</em>, <em>allow_guest_control=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Floppy.Info" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Floppy.Info</span></tt> class contains information about a virtual floppy
|
||
|
|
drive.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>label</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Device label.</li>
|
||
|
|
<li><strong>backing</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Floppy.BackingInfo" title="com.vmware.vcenter.vm.hardware_client.Floppy.BackingInfo"><tt class="xref py py-class docutils literal"><span class="pre">Floppy.BackingInfo</span></tt></a>) – Physical resource backing for the virtual floppy drive.</li>
|
||
|
|
<li><strong>state</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.ConnectionState" title="com.vmware.vcenter.vm.hardware_client.ConnectionState"><tt class="xref py py-class docutils literal"><span class="pre">ConnectionState</span></tt></a>) – Connection status of the virtual device.</li>
|
||
|
|
<li><strong>start_connected</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Flag indicating whether the virtual device should be connected
|
||
|
|
whenever the virtual machine is powered on.</li>
|
||
|
|
<li><strong>allow_guest_control</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Flag indicating whether the guest can connect and disconnect the
|
||
|
|
device.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Floppy.RESOURCE_TYPE">
|
||
|
|
<tt class="descclassname">Floppy.</tt><tt class="descname">RESOURCE_TYPE</tt><em class="property"> = 'com.vmware.vcenter.vm.hardware.Floppy'</em><a class="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>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Floppy.Summary">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Floppy.</tt><tt class="descname">Summary</tt><big>(</big><em>floppy=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Floppy.Summary" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Floppy.Summary</span></tt> class contains commonly used information about a
|
||
|
|
virtual floppy drive.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>floppy</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the virtual floppy drive.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.Floppy</span></tt>. When methods return a
|
||
|
|
value of this class as a return value, the attribute will be an
|
||
|
|
identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.Floppy</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Floppy.UpdateSpec">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Floppy.</tt><tt class="descname">UpdateSpec</tt><big>(</big><em>backing=None</em>, <em>start_connected=None</em>, <em>allow_guest_control=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Floppy.UpdateSpec" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Floppy.UpdateSpec</span></tt> class describes the updates to be made to the
|
||
|
|
configuration of a virtual floppy drive.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>backing</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Floppy.BackingSpec" title="com.vmware.vcenter.vm.hardware_client.Floppy.BackingSpec"><tt class="xref py py-class docutils literal"><span class="pre">Floppy.BackingSpec</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – <p>Physical resource backing for the virtual floppy drive.</p>
|
||
|
|
<p>This attribute may only be modified if the virtual machine is not
|
||
|
|
powered on or the virtual floppy drive is not connected.
|
||
|
|
If None, the value is unchanged.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>start_connected</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Flag indicating whether the virtual device should be connected
|
||
|
|
whenever the virtual machine is powered on.
|
||
|
|
If None, the value is unchanged.</li>
|
||
|
|
<li><strong>allow_guest_control</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Flag indicating whether the guest can connect and disconnect the
|
||
|
|
device.
|
||
|
|
If None, the value is unchanged.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Floppy.connect">
|
||
|
|
<tt class="descclassname">Floppy.</tt><tt class="descname">connect</tt><big>(</big><em>vm</em>, <em>floppy</em><big>)</big><a class="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 <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Floppy.update" title="com.vmware.vcenter.vm.hardware_client.Floppy.update"><tt class="xref py py-func docutils literal"><span class="pre">Floppy.update()</span></tt></a> method may
|
||
|
|
be used to configure the virtual floppy drive to start in the connected
|
||
|
|
state when the virtual machine is powered on.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</li>
|
||
|
|
<li><strong>floppy</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual floppy drive identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.Floppy</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the virtual machine or virtual floppy drive is not found.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></tt>
|
||
|
|
if the virtual floppy drive is already connected.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></tt>
|
||
|
|
if the virtual machine is not powered on.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></tt>
|
||
|
|
if the virtual machine is busy performing another operation.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Floppy.create">
|
||
|
|
<tt class="descclassname">Floppy.</tt><tt class="descname">create</tt><big>(</big><em>vm</em>, <em>spec</em><big>)</big><a class="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>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</li>
|
||
|
|
<li><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Floppy.CreateSpec" title="com.vmware.vcenter.vm.hardware_client.Floppy.CreateSpec"><tt class="xref py py-class docutils literal"><span class="pre">Floppy.CreateSpec</span></tt></a>) – Specification for the new virtual floppy drive.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">str</span></tt></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Virtual floppy drive identifier.
|
||
|
|
The return value will be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.Floppy</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reported that the floppy device was created but was
|
||
|
|
unable to confirm the creation because the identifier of the new
|
||
|
|
device could not be determined.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the virtual machine is not found.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></tt>
|
||
|
|
if the virtual machine is not powered off.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></tt>
|
||
|
|
if the virtual machine already has the maximum number of supported
|
||
|
|
floppy drives.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></tt>
|
||
|
|
if the virtual machine is busy performing another operation.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Floppy.delete">
|
||
|
|
<tt class="descclassname">Floppy.</tt><tt class="descname">delete</tt><big>(</big><em>vm</em>, <em>floppy</em><big>)</big><a class="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>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</li>
|
||
|
|
<li><strong>floppy</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual floppy drive identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.Floppy</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the virtual machine or virtual floppy drive is not found.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></tt>
|
||
|
|
if the virtual machine is not powered off.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></tt>
|
||
|
|
if the virtual machine is busy performing another operation.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Floppy.disconnect">
|
||
|
|
<tt class="descclassname">Floppy.</tt><tt class="descname">disconnect</tt><big>(</big><em>vm</em>, <em>floppy</em><big>)</big><a class="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 <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Floppy.update" title="com.vmware.vcenter.vm.hardware_client.Floppy.update"><tt class="xref py py-func docutils literal"><span class="pre">Floppy.update()</span></tt></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>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</li>
|
||
|
|
<li><strong>floppy</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual floppy drive identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.Floppy</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the virtual machine or virtual floppy drive is not found.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></tt>
|
||
|
|
if the virtual floppy drive is already disconnected.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></tt>
|
||
|
|
if the virtual machine is not powered on.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></tt>
|
||
|
|
if the virtual machine is busy performing another operation.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Floppy.get">
|
||
|
|
<tt class="descclassname">Floppy.</tt><tt class="descname">get</tt><big>(</big><em>vm</em>, <em>floppy</em><big>)</big><a class="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>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</li>
|
||
|
|
<li><strong>floppy</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual floppy drive identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.Floppy</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Floppy.Info" title="com.vmware.vcenter.vm.hardware_client.Floppy.Info"><tt class="xref py py-class docutils literal"><span class="pre">Floppy.Info</span></tt></a></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Information about the specified virtual floppy drive.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the virtual machine or virtual floppy drive is not found.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Floppy.list">
|
||
|
|
<tt class="descclassname">Floppy.</tt><tt class="descname">list</tt><big>(</big><em>vm</em><big>)</big><a class="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
|
||
|
|
belonging to the virtual machine.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Floppy.list" title="com.vmware.vcenter.vm.hardware_client.Floppy.list"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Floppy.Summary" title="com.vmware.vcenter.vm.hardware_client.Floppy.Summary"><tt class="xref py py-class docutils literal"><span class="pre">Floppy.Summary</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">List of commonly used information about virtual floppy drives.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the virtual machine is not found.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the virtual machine’s configuration state cannot be accessed.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Floppy.update">
|
||
|
|
<tt class="descclassname">Floppy.</tt><tt class="descname">update</tt><big>(</big><em>vm</em>, <em>floppy</em>, <em>spec</em><big>)</big><a class="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>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</li>
|
||
|
|
<li><strong>floppy</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual floppy drive identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.Floppy</span></tt>.</li>
|
||
|
|
<li><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Floppy.UpdateSpec" title="com.vmware.vcenter.vm.hardware_client.Floppy.UpdateSpec"><tt class="xref py py-class docutils literal"><span class="pre">Floppy.UpdateSpec</span></tt></a>) – Specification for updating the virtual floppy drive.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the virtual machine or virtual floppy drive is not found.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></tt>
|
||
|
|
if one or more of the attributes specified in the <tt class="docutils literal"><span class="pre">spec</span></tt>
|
||
|
|
parameter cannot be modified due to the current power state of the
|
||
|
|
virtual machine or the connection state of the virtual floppy
|
||
|
|
drive.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></tt>
|
||
|
|
if the virtual machine is busy performing another operation.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.IdeAddressInfo">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter.vm.hardware_client.</tt><tt class="descname">IdeAddressInfo</tt><big>(</big><em>primary=None</em>, <em>master=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.IdeAddressInfo" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">IdeAddressInfo</span></tt> class contains information about the address of a
|
||
|
|
virtual device that is attached to a virtual IDE adapter of a virtual
|
||
|
|
machine.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>primary</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Flag specifying whether the device is attached to the primary or
|
||
|
|
secondary IDE adapter of the virtual machine.</li>
|
||
|
|
<li><strong>master</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Flag specifying whether the device is the master or slave device on
|
||
|
|
the IDE adapter.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.IdeAddressSpec">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter.vm.hardware_client.</tt><tt class="descname">IdeAddressSpec</tt><big>(</big><em>primary=None</em>, <em>master=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.IdeAddressSpec" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">IdeAddressSpec</span></tt> class contains information for specifying the
|
||
|
|
address of a virtual device that is attached to a virtual IDE adapter of a
|
||
|
|
virtual machine.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>primary</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Flag specifying whether the device should be attached to the
|
||
|
|
primary or secondary IDE adapter of the virtual machine.
|
||
|
|
If None, the server will choose a adapter with an available
|
||
|
|
connection. If no IDE connections are available, the request will
|
||
|
|
be rejected.</li>
|
||
|
|
<li><strong>master</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Flag specifying whether the device should be the master or slave
|
||
|
|
device on the IDE adapter.
|
||
|
|
If None, the server will choose an available connection type. If no
|
||
|
|
IDE connections are available, the request will be rejected.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Memory">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter.vm.hardware_client.</tt><tt class="descname">Memory</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Memory" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Memory</span></tt> class provides methods for configuring the memory settings
|
||
|
|
of a virtual machine.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Memory.Info">
|
||
|
|
<em class="property">class </em><tt class="descname">Info</tt><big>(</big><em>size_mib=None</em>, <em>hot_add_enabled=None</em>, <em>hot_add_increment_size_mib=None</em>, <em>hot_add_limit_mib=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Memory.Info" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Memory.Info</span></tt> class contains memory-related information about a
|
||
|
|
virtual machine.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>size_mib</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – Memory size in mebibytes.</li>
|
||
|
|
<li><strong>hot_add_enabled</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – <p>Flag indicating whether adding memory while the virtual machine is
|
||
|
|
running is enabled.</p>
|
||
|
|
<p>Some guest operating systems may consume more resources or perform
|
||
|
|
less efficiently when they run on hardware that supports adding
|
||
|
|
memory while the machine is running.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>hot_add_increment_size_mib</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – <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
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">Memory.Info.hot_add_increment_size_mib</span></tt> and the total memory
|
||
|
|
size of the virtual machine must be a multiple of
|
||
|
|
{\@link>hotAddIncrementSize}.
|
||
|
|
Only set when <tt class="xref py py-attr docutils literal"><span class="pre">Memory.Info.hot_add_enabled</span></tt> is true and the
|
||
|
|
virtual machine is running.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>hot_add_limit_mib</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – The maximum amount of memory, in mebibytes, that can be added to a
|
||
|
|
running virtual machine.
|
||
|
|
Only set when <tt class="xref py py-attr docutils literal"><span class="pre">Memory.Info.hot_add_enabled</span></tt> is true and the
|
||
|
|
virtual machine is running.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Memory.UpdateSpec">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Memory.</tt><tt class="descname">UpdateSpec</tt><big>(</big><em>size_mib=None</em>, <em>hot_add_enabled=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Memory.UpdateSpec" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Memory.UpdateSpec</span></tt> class describes the updates to be made to the
|
||
|
|
memory-related settings of a virtual machine.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>size_mib</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – <p>New memory size in mebibytes.</p>
|
||
|
|
<p>The supported range of memory sizes is constrained by the
|
||
|
|
configured guest operating system and virtual hardware version of
|
||
|
|
the virtual machine.</p>
|
||
|
|
<p>If the virtual machine is running, this value may only be changed
|
||
|
|
if <tt class="xref py py-attr docutils literal"><span class="pre">Memory.Info.hot_add_enabled</span></tt> is true, and the new memory
|
||
|
|
size must satisfy the constraints specified by
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">Memory.Info.hot_add_increment_size_mib</span></tt> and
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">Memory.Info.hot_add_limit_mib</span></tt>.
|
||
|
|
If None, the value is unchanged.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>hot_add_enabled</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – <p>Flag indicating whether adding memory while the virtual machine is
|
||
|
|
running should be 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>This attribute may only be modified if the virtual machine is not
|
||
|
|
powered on.
|
||
|
|
If None, the value is unchanged.</p>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Memory.get">
|
||
|
|
<tt class="descclassname">Memory.</tt><tt class="descname">get</tt><big>(</big><em>vm</em><big>)</big><a class="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>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Memory.Info" title="com.vmware.vcenter.vm.hardware_client.Memory.Info"><tt class="xref py py-class docutils literal"><span class="pre">Memory.Info</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Memory-related settings of the virtual machine.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the virtual machine is not found.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the virtual machine’s configuration state cannot be accessed.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Memory.update">
|
||
|
|
<tt class="descclassname">Memory.</tt><tt class="descname">update</tt><big>(</big><em>vm</em>, <em>spec</em><big>)</big><a class="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>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</li>
|
||
|
|
<li><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Memory.UpdateSpec" title="com.vmware.vcenter.vm.hardware_client.Memory.UpdateSpec"><tt class="xref py py-class docutils literal"><span class="pre">Memory.UpdateSpec</span></tt></a>) – Specification for updating the memory-related settings of the
|
||
|
|
virtual machine.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the virtual machine is not found.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt>
|
||
|
|
if one of the provided settings is not permitted; for example,
|
||
|
|
specifying a negative value for <tt class="docutils literal"><span class="pre">sizeMiB</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></tt>
|
||
|
|
if <tt class="docutils literal"><span class="pre">hotAddEnabled</span></tt> is specified and the virtual machine is not
|
||
|
|
powered off.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></tt>
|
||
|
|
if <tt class="docutils literal"><span class="pre">sizeMiB</span></tt> is specified, <tt class="docutils literal"><span class="pre">hotAddEnabled</span></tt> is false, and the
|
||
|
|
virtual machine is not powered off.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></tt>
|
||
|
|
if the virtual machine is busy performing another operation.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Parallel">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter.vm.hardware_client.</tt><tt class="descname">Parallel</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Parallel" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Parallel</span></tt> class provides methods for configuring the virtual
|
||
|
|
parallel ports of a virtual machine.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Parallel.BackingInfo">
|
||
|
|
<em class="property">class </em><tt class="descname">BackingInfo</tt><big>(</big><em>type=None</em>, <em>file=None</em>, <em>host_device=None</em>, <em>auto_detect=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Parallel.BackingInfo" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Parallel.BackingInfo</span></tt> class contains information about the physical
|
||
|
|
resource backing a virtual parallel port.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Parallel.BackingType" title="com.vmware.vcenter.vm.hardware_client.Parallel.BackingType"><tt class="xref py py-class docutils literal"><span class="pre">Parallel.BackingType</span></tt></a>) – Backing type for the virtual parallel port.</li>
|
||
|
|
<li><strong>file</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Path of the file backing the virtual parallel port.
|
||
|
|
This attribute is optional and it is only relevant when the value
|
||
|
|
of <tt class="docutils literal"><span class="pre">type</span></tt> is <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Parallel.BackingType.FILE" title="com.vmware.vcenter.vm.hardware_client.Parallel.BackingType.FILE"><tt class="xref py py-attr docutils literal"><span class="pre">Parallel.BackingType.FILE</span></tt></a>.</li>
|
||
|
|
<li><strong>host_device</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Name of the device backing the virtual parallel port.
|
||
|
|
This attribute will be None if <tt class="docutils literal"><span class="pre">autoDetect</span></tt> is true and the
|
||
|
|
virtual parallel port is not connected or no suitable device is
|
||
|
|
available on the host.</li>
|
||
|
|
<li><strong>auto_detect</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – 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 <tt class="docutils literal"><span class="pre">type</span></tt> is <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Parallel.BackingType.HOST_DEVICE" title="com.vmware.vcenter.vm.hardware_client.Parallel.BackingType.HOST_DEVICE"><tt class="xref py py-attr docutils literal"><span class="pre">Parallel.BackingType.HOST_DEVICE</span></tt></a>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Parallel.BackingSpec">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Parallel.</tt><tt class="descname">BackingSpec</tt><big>(</big><em>type=None</em>, <em>file=None</em>, <em>host_device=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Parallel.BackingSpec" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Parallel.BackingSpec</span></tt> class provides a specification of the physical
|
||
|
|
resource backing a virtual parallel port.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Parallel.BackingType" title="com.vmware.vcenter.vm.hardware_client.Parallel.BackingType"><tt class="xref py py-class docutils literal"><span class="pre">Parallel.BackingType</span></tt></a>) – Backing type for the virtual parallel port.</li>
|
||
|
|
<li><strong>file</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – 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 <tt class="docutils literal"><span class="pre">type</span></tt> is <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Parallel.BackingType.FILE" title="com.vmware.vcenter.vm.hardware_client.Parallel.BackingType.FILE"><tt class="xref py py-attr docutils literal"><span class="pre">Parallel.BackingType.FILE</span></tt></a>.</li>
|
||
|
|
<li><strong>host_device</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – 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.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Parallel.BackingType">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Parallel.</tt><tt class="descname">BackingType</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Parallel.BackingType" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Parallel.BackingType</span></tt> class defines the valid backing types for a
|
||
|
|
virtual parallel port.</p>
|
||
|
|
<div class="admonition note">
|
||
|
|
<p class="first admonition-title">Note</p>
|
||
|
|
<p class="last">This class represents an enumerated type in the interface language
|
||
|
|
definition. The class contains class attributes which represent the
|
||
|
|
values in the current version of the enumerated type. Newer versions of
|
||
|
|
the enumerated type may contain new values. To use new values of the
|
||
|
|
enumerated type in communication with a server that supports the newer
|
||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
||
|
|
type description page</em></a>.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <tt class="xref py py-class docutils literal"><span class="pre">BackingType</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Parallel.BackingType.FILE">
|
||
|
|
<tt class="descname">FILE</tt><em class="property"> = BackingType(string=u'FILE')</em><a class="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>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Parallel.BackingType.HOST_DEVICE">
|
||
|
|
<tt class="descname">HOST_DEVICE</tt><em class="property"> = BackingType(string=u'HOST_DEVICE')</em><a class="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
|
||
|
|
machine is running.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Parallel.CreateSpec">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Parallel.</tt><tt class="descname">CreateSpec</tt><big>(</big><em>backing=None</em>, <em>start_connected=None</em>, <em>allow_guest_control=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Parallel.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Parallel.CreateSpec</span></tt> class provides a specification for the
|
||
|
|
configuration of a newly-created virtual parallel port.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>backing</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Parallel.BackingSpec" title="com.vmware.vcenter.vm.hardware_client.Parallel.BackingSpec"><tt class="xref py py-class docutils literal"><span class="pre">Parallel.BackingSpec</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Physical resource backing for the virtual parallel port.
|
||
|
|
If None, defaults to automatic detection of a suitable host device.</li>
|
||
|
|
<li><strong>start_connected</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Flag indicating whether the virtual device should be connected
|
||
|
|
whenever the virtual machine is powered on.
|
||
|
|
Defaults to false if None.</li>
|
||
|
|
<li><strong>allow_guest_control</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Flag indicating whether the guest can connect and disconnect the
|
||
|
|
device.
|
||
|
|
Defaults to false if None.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Parallel.Info">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Parallel.</tt><tt class="descname">Info</tt><big>(</big><em>label=None</em>, <em>backing=None</em>, <em>state=None</em>, <em>start_connected=None</em>, <em>allow_guest_control=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Parallel.Info" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Parallel.Info</span></tt> class contains information about a virtual parallel
|
||
|
|
port.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>label</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Device label.</li>
|
||
|
|
<li><strong>backing</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Parallel.BackingInfo" title="com.vmware.vcenter.vm.hardware_client.Parallel.BackingInfo"><tt class="xref py py-class docutils literal"><span class="pre">Parallel.BackingInfo</span></tt></a>) – Physical resource backing for the virtual parallel port.</li>
|
||
|
|
<li><strong>state</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.ConnectionState" title="com.vmware.vcenter.vm.hardware_client.ConnectionState"><tt class="xref py py-class docutils literal"><span class="pre">ConnectionState</span></tt></a>) – Connection status of the virtual device.</li>
|
||
|
|
<li><strong>start_connected</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Flag indicating whether the virtual device should be connected
|
||
|
|
whenever the virtual machine is powered on.</li>
|
||
|
|
<li><strong>allow_guest_control</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Flag indicating whether the guest can connect and disconnect the
|
||
|
|
device.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Parallel.RESOURCE_TYPE">
|
||
|
|
<tt class="descclassname">Parallel.</tt><tt class="descname">RESOURCE_TYPE</tt><em class="property"> = 'com.vmware.vcenter.vm.hardware.ParallelPort'</em><a class="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>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Parallel.Summary">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Parallel.</tt><tt class="descname">Summary</tt><big>(</big><em>port=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Parallel.Summary" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Parallel.Summary</span></tt> class contains commonly used information about a
|
||
|
|
virtual parallel port.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>port</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the virtual parallel port.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.ParallelPort</span></tt>. When methods
|
||
|
|
return a value of this class as a return value, the attribute will
|
||
|
|
be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.ParallelPort</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Parallel.UpdateSpec">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Parallel.</tt><tt class="descname">UpdateSpec</tt><big>(</big><em>backing=None</em>, <em>start_connected=None</em>, <em>allow_guest_control=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Parallel.UpdateSpec" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Parallel.UpdateSpec</span></tt> class describes the updates to be made to the
|
||
|
|
configuration of a virtual parallel port.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>backing</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Parallel.BackingSpec" title="com.vmware.vcenter.vm.hardware_client.Parallel.BackingSpec"><tt class="xref py py-class docutils literal"><span class="pre">Parallel.BackingSpec</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – <p>Physical resource backing for the virtual parallel port.</p>
|
||
|
|
<p>This attribute may only be modified if the virtual machine is not
|
||
|
|
powered on or the virtual parallel port is not connected.
|
||
|
|
If None, the value is unchanged.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>start_connected</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Flag indicating whether the virtual device should be connected
|
||
|
|
whenever the virtual machine is powered on.
|
||
|
|
If None, the value is unchanged.</li>
|
||
|
|
<li><strong>allow_guest_control</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Flag indicating whether the guest can connect and disconnect the
|
||
|
|
device.
|
||
|
|
If None, the value is unchanged.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Parallel.connect">
|
||
|
|
<tt class="descclassname">Parallel.</tt><tt class="descname">connect</tt><big>(</big><em>vm</em>, <em>port</em><big>)</big><a class="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 <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Parallel.update" title="com.vmware.vcenter.vm.hardware_client.Parallel.update"><tt class="xref py py-func docutils literal"><span class="pre">Parallel.update()</span></tt></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>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</li>
|
||
|
|
<li><strong>port</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual parallel port identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.ParallelPort</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the virtual machine or virtual parallel port is not found.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></tt>
|
||
|
|
if the virtual parallel port is already connected.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></tt>
|
||
|
|
if the virtual machine is not powered on.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></tt>
|
||
|
|
if the virtual machine is busy performing another operation.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Parallel.create">
|
||
|
|
<tt class="descclassname">Parallel.</tt><tt class="descname">create</tt><big>(</big><em>vm</em>, <em>spec</em><big>)</big><a class="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>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</li>
|
||
|
|
<li><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Parallel.CreateSpec" title="com.vmware.vcenter.vm.hardware_client.Parallel.CreateSpec"><tt class="xref py py-class docutils literal"><span class="pre">Parallel.CreateSpec</span></tt></a>) – Specification for the new virtual parallel port.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">str</span></tt></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Virtual parallel port identifier.
|
||
|
|
The return value will be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.ParallelPort</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reported that the parallel port device was created
|
||
|
|
but was unable to confirm the creation because the identifier of
|
||
|
|
the new device could not be determined.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the virtual machine is not found.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></tt>
|
||
|
|
if the virtual machine is not powered off.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></tt>
|
||
|
|
if the virtual machine already has the maximum number of supported
|
||
|
|
parallel ports.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></tt>
|
||
|
|
if the virtual machine is busy performing another operation.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Parallel.delete">
|
||
|
|
<tt class="descclassname">Parallel.</tt><tt class="descname">delete</tt><big>(</big><em>vm</em>, <em>port</em><big>)</big><a class="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>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</li>
|
||
|
|
<li><strong>port</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual parallel port identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.ParallelPort</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the virtual machine or virtual parallel port is not found.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></tt>
|
||
|
|
if the virtual machine is not powered off.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></tt>
|
||
|
|
if the virtual machine is busy performing another operation.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Parallel.disconnect">
|
||
|
|
<tt class="descclassname">Parallel.</tt><tt class="descname">disconnect</tt><big>(</big><em>vm</em>, <em>port</em><big>)</big><a class="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 <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Parallel.update" title="com.vmware.vcenter.vm.hardware_client.Parallel.update"><tt class="xref py py-func docutils literal"><span class="pre">Parallel.update()</span></tt></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>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</li>
|
||
|
|
<li><strong>port</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual parallel port identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.ParallelPort</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the virtual machine or virtual parallel port is not found.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></tt>
|
||
|
|
if the virtual parallel port is already disconnected.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></tt>
|
||
|
|
if the virtual machine is not powered on.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></tt>
|
||
|
|
if the virtual machine is busy performing another operation.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Parallel.get">
|
||
|
|
<tt class="descclassname">Parallel.</tt><tt class="descname">get</tt><big>(</big><em>vm</em>, <em>port</em><big>)</big><a class="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>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</li>
|
||
|
|
<li><strong>port</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual parallel port identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.ParallelPort</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Parallel.Info" title="com.vmware.vcenter.vm.hardware_client.Parallel.Info"><tt class="xref py py-class docutils literal"><span class="pre">Parallel.Info</span></tt></a></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Information about the specified virtual parallel port.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the virtual machine or virtual parallel port is not found.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Parallel.list">
|
||
|
|
<tt class="descclassname">Parallel.</tt><tt class="descname">list</tt><big>(</big><em>vm</em><big>)</big><a class="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
|
||
|
|
belonging to the virtual machine.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Parallel.list" title="com.vmware.vcenter.vm.hardware_client.Parallel.list"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Parallel.Summary" title="com.vmware.vcenter.vm.hardware_client.Parallel.Summary"><tt class="xref py py-class docutils literal"><span class="pre">Parallel.Summary</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">List of commonly used information about virtual parallel ports.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the virtual machine is not found.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the virtual machine’s configuration state cannot be accessed.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Parallel.update">
|
||
|
|
<tt class="descclassname">Parallel.</tt><tt class="descname">update</tt><big>(</big><em>vm</em>, <em>port</em>, <em>spec</em><big>)</big><a class="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>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</li>
|
||
|
|
<li><strong>port</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual parallel port identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.ParallelPort</span></tt>.</li>
|
||
|
|
<li><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Parallel.UpdateSpec" title="com.vmware.vcenter.vm.hardware_client.Parallel.UpdateSpec"><tt class="xref py py-class docutils literal"><span class="pre">Parallel.UpdateSpec</span></tt></a>) – Specification for updating the virtual parallel port.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the virtual machine or virtual parallel port is not found.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></tt>
|
||
|
|
if one or more of the attributes specified in the <tt class="docutils literal"><span class="pre">spec</span></tt>
|
||
|
|
parameter cannot be modified due to the current power state of the
|
||
|
|
virtual machine or the connection state of the virtual parallel
|
||
|
|
port.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></tt>
|
||
|
|
if the virtual machine is busy performing another operation.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.SataAddressInfo">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter.vm.hardware_client.</tt><tt class="descname">SataAddressInfo</tt><big>(</big><em>bus=None</em>, <em>unit=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.SataAddressInfo" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">SataAddressInfo</span></tt> class contains information about the address of a
|
||
|
|
virtual device that is attached to a virtual SATA adapter of a virtual
|
||
|
|
machine.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>bus</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – Bus number of the adapter to which the device is attached.</li>
|
||
|
|
<li><strong>unit</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – Unit number of the device.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.SataAddressSpec">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter.vm.hardware_client.</tt><tt class="descname">SataAddressSpec</tt><big>(</big><em>bus=None</em>, <em>unit=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.SataAddressSpec" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">SataAddressSpec</span></tt> class contains information for specifying the
|
||
|
|
address of a virtual device that is attached to a virtual SATA adapter of a
|
||
|
|
virtual machine.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>bus</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – Bus number of the adapter to which the device should be attached.</li>
|
||
|
|
<li><strong>unit</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – 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
|
||
|
|
adapter, the request will be rejected.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.ScsiAddressInfo">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter.vm.hardware_client.</tt><tt class="descname">ScsiAddressInfo</tt><big>(</big><em>bus=None</em>, <em>unit=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.ScsiAddressInfo" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">ScsiAddressInfo</span></tt> class contains information about the address of a
|
||
|
|
virtual device that is attached to a virtual SCSI adapter of a virtual
|
||
|
|
machine.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>bus</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – Bus number of the adapter to which the device is attached.</li>
|
||
|
|
<li><strong>unit</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – Unit number of the device.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.ScsiAddressSpec">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter.vm.hardware_client.</tt><tt class="descname">ScsiAddressSpec</tt><big>(</big><em>bus=None</em>, <em>unit=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.ScsiAddressSpec" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">ScsiAddressSpec</span></tt> class contains information for specifying the
|
||
|
|
address of a virtual device that is attached to a virtual SCSI adapter of a
|
||
|
|
virtual machine.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>bus</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – Bus number of the adapter to which the device should be attached.</li>
|
||
|
|
<li><strong>unit</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – 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
|
||
|
|
adapter, the request will be rejected.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.vcenter.vm.hardware_client.</tt><tt class="descname">Serial</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Serial" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Serial</span></tt> class provides methods for configuring the virtual serial
|
||
|
|
ports of a virtual machine.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.BackingInfo">
|
||
|
|
<em class="property">class </em><tt class="descname">BackingInfo</tt><big>(</big><em>type=None</em>, <em>file=None</em>, <em>host_device=None</em>, <em>auto_detect=None</em>, <em>pipe=None</em>, <em>no_rx_loss=None</em>, <em>network_location=None</em>, <em>proxy=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingInfo" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Serial.BackingInfo</span></tt> class contains information about the physical
|
||
|
|
resource backing a virtual serial port.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType" title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType"><tt class="xref py py-class docutils literal"><span class="pre">Serial.BackingType</span></tt></a>) – Backing type for the virtual serial port.</li>
|
||
|
|
<li><strong>file</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Path of the file backing the virtual serial port.
|
||
|
|
This attribute is optional and it is only relevant when the value
|
||
|
|
of <tt class="docutils literal"><span class="pre">type</span></tt> is <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.FILE" title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.FILE"><tt class="xref py py-attr docutils literal"><span class="pre">Serial.BackingType.FILE</span></tt></a>.</li>
|
||
|
|
<li><strong>host_device</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Name of the device backing the virtual serial port.
|
||
|
|
This attribute will be None if <tt class="docutils literal"><span class="pre">autoDetect</span></tt> is true and the
|
||
|
|
virtual serial port is not connected or no suitable device is
|
||
|
|
available on the host.</li>
|
||
|
|
<li><strong>auto_detect</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – 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 <tt class="docutils literal"><span class="pre">type</span></tt> is <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.HOST_DEVICE" title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.HOST_DEVICE"><tt class="xref py py-attr docutils literal"><span class="pre">Serial.BackingType.HOST_DEVICE</span></tt></a>.</li>
|
||
|
|
<li><strong>pipe</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Name of the pipe backing the virtual serial port.
|
||
|
|
This attribute is optional and it is only relevant when the value
|
||
|
|
of <tt class="docutils literal"><span class="pre">type</span></tt> is one of <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.PIPE_SERVER" title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.PIPE_SERVER"><tt class="xref py py-attr docutils literal"><span class="pre">Serial.BackingType.PIPE_SERVER</span></tt></a> or
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.PIPE_CLIENT" title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.PIPE_CLIENT"><tt class="xref py py-attr docutils literal"><span class="pre">Serial.BackingType.PIPE_CLIENT</span></tt></a>.</li>
|
||
|
|
<li><strong>no_rx_loss</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – 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 <tt class="docutils literal"><span class="pre">type</span></tt> is one of <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.PIPE_SERVER" title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.PIPE_SERVER"><tt class="xref py py-attr docutils literal"><span class="pre">Serial.BackingType.PIPE_SERVER</span></tt></a> or
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.PIPE_CLIENT" title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.PIPE_CLIENT"><tt class="xref py py-attr docutils literal"><span class="pre">Serial.BackingType.PIPE_CLIENT</span></tt></a>.</li>
|
||
|
|
<li><strong>network_location</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – <p>URI specifying the location of the network service backing the
|
||
|
|
virtual serial port.</p>
|
||
|
|
<ul>
|
||
|
|
<li>If <tt class="xref py py-attr docutils literal"><span class="pre">Serial.BackingInfo.type</span></tt> is
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_SERVER" title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_SERVER"><tt class="xref py py-attr docutils literal"><span class="pre">Serial.BackingType.NETWORK_SERVER</span></tt></a>, this attribute is the
|
||
|
|
location used by clients to connect to this server. The hostname
|
||
|
|
part of the URI should either be empty or should specify the
|
||
|
|
address of the host on which the virtual machine is running.</li>
|
||
|
|
<li>If <tt class="xref py py-attr docutils literal"><span class="pre">Serial.BackingInfo.type</span></tt> is
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_CLIENT" title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_CLIENT"><tt class="xref py py-attr docutils literal"><span class="pre">Serial.BackingType.NETWORK_CLIENT</span></tt></a>, this attribute is the
|
||
|
|
location used by the virtual machine to connect to the remote
|
||
|
|
server.</li>
|
||
|
|
</ul>
|
||
|
|
<p>This attribute is optional and it is only relevant when the value
|
||
|
|
of <tt class="docutils literal"><span class="pre">type</span></tt> is one of <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_SERVER" title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_SERVER"><tt class="xref py py-attr docutils literal"><span class="pre">Serial.BackingType.NETWORK_SERVER</span></tt></a> or
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_CLIENT" title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_CLIENT"><tt class="xref py py-attr docutils literal"><span class="pre">Serial.BackingType.NETWORK_CLIENT</span></tt></a>.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>proxy</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – 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 is configured.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.BackingSpec">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Serial.</tt><tt class="descname">BackingSpec</tt><big>(</big><em>type=None</em>, <em>file=None</em>, <em>host_device=None</em>, <em>pipe=None</em>, <em>no_rx_loss=None</em>, <em>network_location=None</em>, <em>proxy=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingSpec" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Serial.BackingSpec</span></tt> class provides a specification of the physical
|
||
|
|
resource backing a virtual serial port.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType" title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType"><tt class="xref py py-class docutils literal"><span class="pre">Serial.BackingType</span></tt></a>) – Backing type for the virtual serial port.</li>
|
||
|
|
<li><strong>file</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Path of the file backing the virtual serial port.
|
||
|
|
This attribute is optional and it is only relevant when the value
|
||
|
|
of <tt class="docutils literal"><span class="pre">type</span></tt> is <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.FILE" title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.FILE"><tt class="xref py py-attr docutils literal"><span class="pre">Serial.BackingType.FILE</span></tt></a>.</li>
|
||
|
|
<li><strong>host_device</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Name of the device backing the virtual serial port.
|
||
|
|
If None, the virtual serial port will be configured to
|
||
|
|
automatically detect a suitable host device.</li>
|
||
|
|
<li><strong>pipe</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Name of the pipe backing the virtual serial port.
|
||
|
|
This attribute is optional and it is only relevant when the value
|
||
|
|
of <tt class="docutils literal"><span class="pre">type</span></tt> is one of <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.PIPE_SERVER" title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.PIPE_SERVER"><tt class="xref py py-attr docutils literal"><span class="pre">Serial.BackingType.PIPE_SERVER</span></tt></a> or
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.PIPE_CLIENT" title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.PIPE_CLIENT"><tt class="xref py py-attr docutils literal"><span class="pre">Serial.BackingType.PIPE_CLIENT</span></tt></a>.</li>
|
||
|
|
<li><strong>no_rx_loss</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Flag that enables optimized data transfer over the pipe. When the
|
||
|
|
value is true, the host buffers data to prevent data overrun. This
|
||
|
|
allows the virtual machine to read all of the data transferred over
|
||
|
|
the pipe with no data loss.
|
||
|
|
If None, defaults to false.</li>
|
||
|
|
<li><strong>network_location</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – <p>URI specifying the location of the network service backing the
|
||
|
|
virtual serial port.</p>
|
||
|
|
<ul>
|
||
|
|
<li>If <tt class="xref py py-attr docutils literal"><span class="pre">Serial.BackingSpec.type</span></tt> is
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_SERVER" title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_SERVER"><tt class="xref py py-attr docutils literal"><span class="pre">Serial.BackingType.NETWORK_SERVER</span></tt></a>, this attribute is the
|
||
|
|
location used by clients to connect to this server. The hostname
|
||
|
|
part of the URI should either be empty or should specify the
|
||
|
|
address of the host on which the virtual machine is running.</li>
|
||
|
|
<li>If <tt class="xref py py-attr docutils literal"><span class="pre">Serial.BackingSpec.type</span></tt> is
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_CLIENT" title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_CLIENT"><tt class="xref py py-attr docutils literal"><span class="pre">Serial.BackingType.NETWORK_CLIENT</span></tt></a>, this attribute is the
|
||
|
|
location used by the virtual machine to connect to the remote
|
||
|
|
server.</li>
|
||
|
|
</ul>
|
||
|
|
<p>This attribute is optional and it is only relevant when the value
|
||
|
|
of <tt class="docutils literal"><span class="pre">type</span></tt> is one of <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_SERVER" title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_SERVER"><tt class="xref py py-attr docutils literal"><span class="pre">Serial.BackingType.NETWORK_SERVER</span></tt></a> or
|
||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_CLIENT" title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_CLIENT"><tt class="xref py py-attr docutils literal"><span class="pre">Serial.BackingType.NETWORK_CLIENT</span></tt></a>.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>proxy</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – 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.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.BackingType">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Serial.</tt><tt class="descname">BackingType</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Serial.BackingType</span></tt> class defines the valid backing types for a
|
||
|
|
virtual serial port.</p>
|
||
|
|
<div class="admonition note">
|
||
|
|
<p class="first admonition-title">Note</p>
|
||
|
|
<p class="last">This class represents an enumerated type in the interface language
|
||
|
|
definition. The class contains class attributes which represent the
|
||
|
|
values in the current version of the enumerated type. Newer versions of
|
||
|
|
the enumerated type may contain new values. To use new values of the
|
||
|
|
enumerated type in communication with a server that supports the newer
|
||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
||
|
|
type description page</em></a>.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <tt class="xref py py-class docutils literal"><span class="pre">BackingType</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.FILE">
|
||
|
|
<tt class="descname">FILE</tt><em class="property"> = BackingType(string=u'FILE')</em><a class="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>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.HOST_DEVICE">
|
||
|
|
<tt class="descname">HOST_DEVICE</tt><em class="property"> = BackingType(string=u'HOST_DEVICE')</em><a class="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
|
||
|
|
machine is running.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_CLIENT">
|
||
|
|
<tt class="descname">NETWORK_CLIENT</tt><em class="property"> = BackingType(string=u'NETWORK_CLIENT')</em><a class="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,
|
||
|
|
initiating a connection to a remote system.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_SERVER">
|
||
|
|
<tt class="descname">NETWORK_SERVER</tt><em class="property"> = BackingType(string=u'NETWORK_SERVER')</em><a class="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,
|
||
|
|
accepting a connection from a remote system.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.PIPE_CLIENT">
|
||
|
|
<tt class="descname">PIPE_CLIENT</tt><em class="property"> = BackingType(string=u'PIPE_CLIENT')</em><a class="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>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.PIPE_SERVER">
|
||
|
|
<tt class="descname">PIPE_SERVER</tt><em class="property"> = BackingType(string=u'PIPE_SERVER')</em><a class="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
|
||
|
|
through the virtual serial port.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.CreateSpec">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Serial.</tt><tt class="descname">CreateSpec</tt><big>(</big><em>yield_on_poll=None</em>, <em>backing=None</em>, <em>start_connected=None</em>, <em>allow_guest_control=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Serial.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Serial.CreateSpec</span></tt> class provides a specification for the
|
||
|
|
configuration of a newly-created virtual serial port.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>yield_on_poll</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – CPU yield behavior. If set to true, the virtual machine will
|
||
|
|
periodically relinquish the processor if its sole task is polling
|
||
|
|
the virtual serial port. The amount of time it takes to regain the
|
||
|
|
processor will depend on the degree of other virtual machine
|
||
|
|
activity on the host.
|
||
|
|
If None, defaults to false.</li>
|
||
|
|
<li><strong>backing</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingSpec" title="com.vmware.vcenter.vm.hardware_client.Serial.BackingSpec"><tt class="xref py py-class docutils literal"><span class="pre">Serial.BackingSpec</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Physical resource backing for the virtual serial port.
|
||
|
|
If None, defaults to automatic detection of a suitable host device.</li>
|
||
|
|
<li><strong>start_connected</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Flag indicating whether the virtual device should be connected
|
||
|
|
whenever the virtual machine is powered on.
|
||
|
|
Defaults to false if None.</li>
|
||
|
|
<li><strong>allow_guest_control</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Flag indicating whether the guest can connect and disconnect the
|
||
|
|
device.
|
||
|
|
Defaults to false if None.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.Info">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Serial.</tt><tt class="descname">Info</tt><big>(</big><em>label=None</em>, <em>yield_on_poll=None</em>, <em>backing=None</em>, <em>state=None</em>, <em>start_connected=None</em>, <em>allow_guest_control=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Serial.Info" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Serial.Info</span></tt> class contains information about a virtual serial port.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>label</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Device label.</li>
|
||
|
|
<li><strong>yield_on_poll</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – CPU yield behavior. If set to true, the virtual machine will
|
||
|
|
periodically relinquish the processor if its sole task is polling
|
||
|
|
the virtual serial port. The amount of time it takes to regain the
|
||
|
|
processor will depend on the degree of other virtual machine
|
||
|
|
activity on the host.</li>
|
||
|
|
<li><strong>backing</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingInfo" title="com.vmware.vcenter.vm.hardware_client.Serial.BackingInfo"><tt class="xref py py-class docutils literal"><span class="pre">Serial.BackingInfo</span></tt></a>) – Physical resource backing for the virtual serial port.</li>
|
||
|
|
<li><strong>state</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.ConnectionState" title="com.vmware.vcenter.vm.hardware_client.ConnectionState"><tt class="xref py py-class docutils literal"><span class="pre">ConnectionState</span></tt></a>) – Connection status of the virtual device.</li>
|
||
|
|
<li><strong>start_connected</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Flag indicating whether the virtual device should be connected
|
||
|
|
whenever the virtual machine is powered on.</li>
|
||
|
|
<li><strong>allow_guest_control</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Flag indicating whether the guest can connect and disconnect the
|
||
|
|
device.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.RESOURCE_TYPE">
|
||
|
|
<tt class="descclassname">Serial.</tt><tt class="descname">RESOURCE_TYPE</tt><em class="property"> = 'com.vmware.vcenter.vm.hardware.SerialPort'</em><a class="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>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.Summary">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Serial.</tt><tt class="descname">Summary</tt><big>(</big><em>port=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Serial.Summary" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Serial.Summary</span></tt> class contains commonly used information about a
|
||
|
|
virtual serial port.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>port</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – 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:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.SerialPort</span></tt>. When methods return
|
||
|
|
a value of this class as a return value, the attribute will be an
|
||
|
|
identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.SerialPort</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.UpdateSpec">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Serial.</tt><tt class="descname">UpdateSpec</tt><big>(</big><em>yield_on_poll=None</em>, <em>backing=None</em>, <em>start_connected=None</em>, <em>allow_guest_control=None</em><big>)</big><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Serial.UpdateSpec" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Serial.UpdateSpec</span></tt> class describes the updates to be made to the
|
||
|
|
configuration of a virtual serial port.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>yield_on_poll</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – <p>CPU yield behavior. If set to true, the virtual machine will
|
||
|
|
periodically relinquish the processor if its sole task is polling
|
||
|
|
the virtual serial port. The amount of time it takes to regain the
|
||
|
|
processor will depend on the degree of other virtual machine
|
||
|
|
activity on the host.</p>
|
||
|
|
<p>This attribute may be modified at any time, and changes applied to
|
||
|
|
a connected virtual serial port take effect immediately.
|
||
|
|
If None, the value is unchanged.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>backing</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingSpec" title="com.vmware.vcenter.vm.hardware_client.Serial.BackingSpec"><tt class="xref py py-class docutils literal"><span class="pre">Serial.BackingSpec</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – <p>Physical resource backing for the virtual serial port.</p>
|
||
|
|
<p>This attribute may only be modified if the virtual machine is not
|
||
|
|
powered on or the virtual serial port is not connected.
|
||
|
|
If None, the value is unchanged.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>start_connected</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Flag indicating whether the virtual device should be connected
|
||
|
|
whenever the virtual machine is powered on.
|
||
|
|
If None, the value is unchanged.</li>
|
||
|
|
<li><strong>allow_guest_control</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Flag indicating whether the guest can connect and disconnect the
|
||
|
|
device.
|
||
|
|
If None, the value is unchanged.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.connect">
|
||
|
|
<tt class="descclassname">Serial.</tt><tt class="descname">connect</tt><big>(</big><em>vm</em>, <em>port</em><big>)</big><a class="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 <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.update" title="com.vmware.vcenter.vm.hardware_client.Serial.update"><tt class="xref py py-func docutils literal"><span class="pre">Serial.update()</span></tt></a> method may
|
||
|
|
be used to configure the virtual serial port to start in the connected
|
||
|
|
state when the virtual machine is powered on.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</li>
|
||
|
|
<li><strong>port</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual serial port identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.SerialPort</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the virtual machine or virtual serial port is not found.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></tt>
|
||
|
|
if the virtual serial port is already connected.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></tt>
|
||
|
|
if the virtual machine is not powered on.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></tt>
|
||
|
|
if the virtual machine is busy performing another operation.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.create">
|
||
|
|
<tt class="descclassname">Serial.</tt><tt class="descname">create</tt><big>(</big><em>vm</em>, <em>spec</em><big>)</big><a class="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>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</li>
|
||
|
|
<li><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.CreateSpec" title="com.vmware.vcenter.vm.hardware_client.Serial.CreateSpec"><tt class="xref py py-class docutils literal"><span class="pre">Serial.CreateSpec</span></tt></a>) – Specification for the new virtual serial port.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">str</span></tt></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Virtual serial port identifier.
|
||
|
|
The return value will be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.SerialPort</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reported that the serial port device was created but
|
||
|
|
was unable to confirm the creation because the identifier of the
|
||
|
|
new device could not be determined.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the virtual machine is not found.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></tt>
|
||
|
|
if the virtual machine is not powered off.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></tt>
|
||
|
|
if the virtual machine already has the maximum number of supported
|
||
|
|
serial ports.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></tt>
|
||
|
|
if the virtual machine is busy performing another operation.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.delete">
|
||
|
|
<tt class="descclassname">Serial.</tt><tt class="descname">delete</tt><big>(</big><em>vm</em>, <em>port</em><big>)</big><a class="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>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</li>
|
||
|
|
<li><strong>port</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual serial port identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.SerialPort</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the virtual machine or virtual serial port is not found.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></tt>
|
||
|
|
if the virtual machine is not powered off.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></tt>
|
||
|
|
if the virtual machine is busy performing another operation.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.disconnect">
|
||
|
|
<tt class="descclassname">Serial.</tt><tt class="descname">disconnect</tt><big>(</big><em>vm</em>, <em>port</em><big>)</big><a class="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 <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.update" title="com.vmware.vcenter.vm.hardware_client.Serial.update"><tt class="xref py py-func docutils literal"><span class="pre">Serial.update()</span></tt></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>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</li>
|
||
|
|
<li><strong>port</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual serial port identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.SerialPort</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the virtual machine or virtual serial port is not found.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></tt>
|
||
|
|
if the virtual serial port is already disconnected.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></tt>
|
||
|
|
if the virtual machine is not powered on.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></tt>
|
||
|
|
if the virtual machine is busy performing another operation.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.get">
|
||
|
|
<tt class="descclassname">Serial.</tt><tt class="descname">get</tt><big>(</big><em>vm</em>, <em>port</em><big>)</big><a class="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>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</li>
|
||
|
|
<li><strong>port</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual serial port identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.SerialPort</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.Info" title="com.vmware.vcenter.vm.hardware_client.Serial.Info"><tt class="xref py py-class docutils literal"><span class="pre">Serial.Info</span></tt></a></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Information about the specified virtual serial port.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the virtual machine or virtual serial port is not found.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.list">
|
||
|
|
<tt class="descclassname">Serial.</tt><tt class="descname">list</tt><big>(</big><em>vm</em><big>)</big><a class="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
|
||
|
|
belonging to the virtual machine.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.list" title="com.vmware.vcenter.vm.hardware_client.Serial.list"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.Summary" title="com.vmware.vcenter.vm.hardware_client.Serial.Summary"><tt class="xref py py-class docutils literal"><span class="pre">Serial.Summary</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">List of commonly used information about virtual serial ports.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the virtual machine is not found.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the virtual machine’s configuration state cannot be accessed.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.update">
|
||
|
|
<tt class="descclassname">Serial.</tt><tt class="descname">update</tt><big>(</big><em>vm</em>, <em>port</em>, <em>spec</em><big>)</big><a class="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>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>vm</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual machine identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">VirtualMachine</span></tt>.</li>
|
||
|
|
<li><strong>port</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Virtual serial port identifier.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.vcenter.vm.hardware.SerialPort</span></tt>.</li>
|
||
|
|
<li><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.UpdateSpec" title="com.vmware.vcenter.vm.hardware_client.Serial.UpdateSpec"><tt class="xref py py-class docutils literal"><span class="pre">Serial.UpdateSpec</span></tt></a>) – Specification for updating the virtual serial port.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if the system reports an error while responding to the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the virtual machine or virtual serial port is not found.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></tt>
|
||
|
|
if one or more of the attributes specified in the <tt class="docutils literal"><span class="pre">spec</span></tt>
|
||
|
|
parameter cannot be modified due to the current power state of the
|
||
|
|
virtual machine or the connection state of the virtual serial port.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></tt>
|
||
|
|
if the virtual machine is busy performing another operation.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></tt>
|
||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></tt>
|
||
|
|
if the system is unable to communicate with a service to complete
|
||
|
|
the request.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></tt>
|
||
|
|
if the user can not be authenticated.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user doesn’t have the required privileges.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="section" id="module-com.vmware.vcenter.vm">
|
||
|
|
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-com.vmware.vcenter.vm" title="Permalink to this headline">¶</a></h2>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="sphinxsidebar">
|
||
|
|
<div class="sphinxsidebarwrapper">
|
||
|
|
<h3><a href="index.html">Table Of Contents</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li><a class="reference internal" href="#">com.vmware.vcenter.vm package</a><ul>
|
||
|
|
<li><a class="reference internal" href="#subpackages">Subpackages</a></li>
|
||
|
|
<li><a class="reference internal" href="#submodules">Submodules</a></li>
|
||
|
|
<li><a class="reference internal" href="#module-com.vmware.vcenter.vm.hardware_client">com.vmware.vcenter.vm.hardware_client module</a></li>
|
||
|
|
<li><a class="reference internal" href="#module-com.vmware.vcenter.vm">Module contents</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<h4>Previous topic</h4>
|
||
|
|
<p class="topless"><a href="com.vmware.vcenter.hvc.html"
|
||
|
|
title="previous chapter">com.vmware.vcenter.hvc package</a></p>
|
||
|
|
<h4>Next topic</h4>
|
||
|
|
<p class="topless"><a href="com.vmware.vcenter.vm.hardware.html"
|
||
|
|
title="next chapter">com.vmware.vcenter.vm.hardware package</a></p>
|
||
|
|
<h3>This Page</h3>
|
||
|
|
<ul class="this-page-menu">
|
||
|
|
<li><a href="_sources/com.vmware.vcenter.vm.txt"
|
||
|
|
rel="nofollow">Show Source</a></li>
|
||
|
|
</ul>
|
||
|
|
<div id="searchbox" style="display: none">
|
||
|
|
<h3>Quick search</h3>
|
||
|
|
<form class="search" action="search.html" method="get">
|
||
|
|
<input type="text" name="q" />
|
||
|
|
<input type="submit" value="Go" />
|
||
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
||
|
|
<input type="hidden" name="area" value="default" />
|
||
|
|
</form>
|
||
|
|
<p class="searchtip" style="font-size: 90%">
|
||
|
|
Enter search terms or a module, class or function name.
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="clearer"></div>
|
||
|
|
</div>
|
||
|
|
<div class="related">
|
||
|
|
<h3>Navigation</h3>
|
||
|
|
<ul>
|
||
|
|
<li class="right" style="margin-right: 10px">
|
||
|
|
<a href="genindex.html" title="General Index"
|
||
|
|
>index</a></li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="py-modindex.html" title="Python Module Index"
|
||
|
|
>modules</a> |</li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="com.vmware.vcenter.vm.hardware.html" title="com.vmware.vcenter.vm.hardware package"
|
||
|
|
>next</a> |</li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="com.vmware.vcenter.hvc.html" title="com.vmware.vcenter.hvc package"
|
||
|
|
>previous</a> |</li>
|
||
|
|
<li><a href="index.html">vSphere Automation SDK for Python 6.6.1 documentation</a> »</li>
|
||
|
|
<li><a href="com.html" >com package</a> »</li>
|
||
|
|
<li><a href="com.vmware.html" >com.vmware package</a> »</li>
|
||
|
|
<li><a href="com.vmware.vcenter.html" >com.vmware.vcenter package</a> »</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div class="footer">
|
||
|
|
© Copyright 2014-2017, VMware, Inc. All rights reserved.
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|