mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-29 20:09:58 -05:00
4917 lines
352 KiB
HTML
4917 lines
352 KiB
HTML
|
|
|||
|
|
|
|||
|
|
<!DOCTYPE html>
|
|||
|
|
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
|||
|
|
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
|||
|
|
<head>
|
|||
|
|
<meta charset="utf-8">
|
|||
|
|
|
|||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|||
|
|
|
|||
|
|
<title>com.vmware.vcenter.vm package — vSphere Automation SDK for Python 6.7.0 documentation</title>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<link rel="index" title="Index"
|
|||
|
|
href="genindex.html"/>
|
|||
|
|
<link rel="search" title="Search" href="search.html"/>
|
|||
|
|
<link rel="top" title="vSphere Automation SDK for Python 6.7.0 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.storage.policies package" href="com.vmware.vcenter.storage.policies.html"/>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script src="_static/js/modernizr.min.js"></script>
|
|||
|
|
|
|||
|
|
</head>
|
|||
|
|
|
|||
|
|
<body class="wy-body-for-nav" role="document">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="wy-grid-for-nav">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|||
|
|
<div class="wy-side-scroll">
|
|||
|
|
<div class="wy-side-nav-search">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="version">
|
|||
|
|
6.7.0
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div role="search">
|
|||
|
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
|||
|
|
<input type="text" name="q" placeholder="Search docs" />
|
|||
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|||
|
|
<input type="hidden" name="area" value="default" />
|
|||
|
|
</form>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<p class="caption"><span class="caption-text">Contents:</span></p>
|
|||
|
|
<ul class="current">
|
|||
|
|
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
|
|||
|
|
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
|
|||
|
|
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
|||
|
|
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="vmware.html">vmware package</a></li>
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
|
|||
|
|
|
|||
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|||
|
|
<a href="index.html">vSphere Automation SDK for Python</a>
|
|||
|
|
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="wy-nav-content">
|
|||
|
|
<div class="rst-content">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
|||
|
|
|
|||
|
|
<ul class="wy-breadcrumbs">
|
|||
|
|
|
|||
|
|
<li><a href="index.html">Docs</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>
|
|||
|
|
|
|||
|
|
<li>com.vmware.vcenter.vm package</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="wy-breadcrumbs-aside">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a href="_sources/com.vmware.vcenter.vm.rst.txt" rel="nofollow"> View page source</a>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<hr/>
|
|||
|
|
</div>
|
|||
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|||
|
|
<div itemprop="articleBody">
|
|||
|
|
|
|||
|
|
<div class="section" id="module-com.vmware.vcenter.vm">
|
|||
|
|
<span id="com-vmware-vcenter-vm-package"></span><h1>com.vmware.vcenter.vm package<a class="headerlink" href="#module-com.vmware.vcenter.vm" 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>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vcenter.vm.storage.html">com.vmware.vcenter.vm.storage package</a><ul>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.vm.storage.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.vm.storage.html#module-com.vmware.vcenter.vm.storage.policy_client">com.vmware.vcenter.vm.storage.policy_client module</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.guest_client">
|
|||
|
|
<span id="com-vmware-vcenter-vm-guest-client-module"></span><h2>com.vmware.vcenter.vm.guest_client module<a class="headerlink" href="#module-com.vmware.vcenter.vm.guest_client" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.guest_client</span></code> module provides classes for dealing
|
|||
|
|
with the guest operating system. This includes information about the state of
|
|||
|
|
local file systems and network interfaces and methods to manipulate the guest
|
|||
|
|
file system and processes.</p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.Identity">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.vm.guest_client.</code><code class="descname">Identity</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest_client.Identity" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Identity</span></code> class provides methods for retrieving guest operating
|
|||
|
|
system identification information. This class was added in vSphere API 6.7</p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.Identity.Info">
|
|||
|
|
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>name=None</em>, <em>family=None</em>, <em>full_name=None</em>, <em>host_name=None</em>, <em>ip_address=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest_client.Identity.Info" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Identity.Info</span></code> class contains information describing the guest
|
|||
|
|
operating system identification. This class was added in vSphere API 6.7</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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.Identity.get">
|
|||
|
|
<code class="descname">get</code><span class="sig-paren">(</span><em>vm</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest_client.Identity.get" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Return information about the guest. This method was added in vSphere
|
|||
|
|
API 6.7</p>
|
|||
|
|
<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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the virtual machine.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</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.guest_client.Identity.Info" title="com.vmware.vcenter.vm.guest_client.Identity.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Identity.Info</span></code></a></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">guest identification information.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if the virtual machine is not found.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
if VMware Tools is not running.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
if VMware Tools has not provided any values.</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.LocalFilesystem">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.vm.guest_client.</code><code class="descname">LocalFilesystem</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest_client.LocalFilesystem" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">LocalFilesystem</span></code> class provides methods for retrieving information
|
|||
|
|
about the guest operating system local file systems. This class was added
|
|||
|
|
in vSphere API 6.7</p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.LocalFilesystem.Info">
|
|||
|
|
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>capacity=None</em>, <em>free_space=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest_client.LocalFilesystem.Info" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">LocalFilesystem.Info</span></code> class contains information about a local file
|
|||
|
|
system configured in the guest operating system. This class was added in
|
|||
|
|
vSphere API 6.7</p>
|
|||
|
|
<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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.LocalFilesystem.get">
|
|||
|
|
<code class="descname">get</code><span class="sig-paren">(</span><em>vm</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest_client.LocalFilesystem.get" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Returns details of the local file systems in the guest operating
|
|||
|
|
system. This method was added in vSphere API 6.7</p>
|
|||
|
|
<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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the virtual machine.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vcenter.vm.guest_client.LocalFilesystem.Info" title="com.vmware.vcenter.vm.guest_client.LocalFilesystem.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">LocalFilesystem.Info</span></code></a></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Information about the local file systems configured in the guest
|
|||
|
|
operating system.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if the virtual machine is not found.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
if VMware Tools is not running.</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.Power">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.vm.guest_client.</code><code class="descname">Power</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest_client.Power" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Power</span></code> class provides methods for managing the guest operating
|
|||
|
|
system power state of a virtual machine. This class was added in vSphere
|
|||
|
|
API 6.7</p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.Power.Info">
|
|||
|
|
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>state=None</em>, <em>operations_ready=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest_client.Power.Info" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>Information about the guest operating system power state. This class was
|
|||
|
|
added in vSphere API 6.7</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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.Power.State">
|
|||
|
|
<em class="property">class </em><code class="descname">State</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest_client.Power.State" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>Possible guest power states. This enumeration was added in vSphere API 6.7</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="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.Power.State.NOT_RUNNING">
|
|||
|
|
<code class="descname">NOT_RUNNING</code><em class="property"> = State(string='NOT_RUNNING')</em><a class="headerlink" href="#com.vmware.vcenter.vm.guest_client.Power.State.NOT_RUNNING" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The guest OS is not running. This class attribute was added in vSphere API
|
|||
|
|
6.7</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.Power.State.RESETTING">
|
|||
|
|
<code class="descname">RESETTING</code><em class="property"> = State(string='RESETTING')</em><a class="headerlink" href="#com.vmware.vcenter.vm.guest_client.Power.State.RESETTING" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The guest OS is resetting. This class attribute was added in vSphere API
|
|||
|
|
6.7</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.Power.State.RUNNING">
|
|||
|
|
<code class="descname">RUNNING</code><em class="property"> = State(string='RUNNING')</em><a class="headerlink" href="#com.vmware.vcenter.vm.guest_client.Power.State.RUNNING" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The guest OS is running. This class attribute was added in vSphere API 6.7</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.Power.State.SHUTTING_DOWN">
|
|||
|
|
<code class="descname">SHUTTING_DOWN</code><em class="property"> = State(string='SHUTTING_DOWN')</em><a class="headerlink" href="#com.vmware.vcenter.vm.guest_client.Power.State.SHUTTING_DOWN" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The guest OS is shutting down. This class attribute was added in vSphere
|
|||
|
|
API 6.7</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.Power.State.STANDBY">
|
|||
|
|
<code class="descname">STANDBY</code><em class="property"> = State(string='STANDBY')</em><a class="headerlink" href="#com.vmware.vcenter.vm.guest_client.Power.State.STANDBY" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The guest OS is in standby. This class attribute was added in vSphere API
|
|||
|
|
6.7</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.Power.State.UNAVAILABLE">
|
|||
|
|
<code class="descname">UNAVAILABLE</code><em class="property"> = State(string='UNAVAILABLE')</em><a class="headerlink" href="#com.vmware.vcenter.vm.guest_client.Power.State.UNAVAILABLE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The guest OS power state is unknown. This class attribute was added in
|
|||
|
|
vSphere API 6.7</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.Power.get">
|
|||
|
|
<code class="descname">get</code><span class="sig-paren">(</span><em>vm</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest_client.Power.get" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Returns information about the guest operating system power state. This
|
|||
|
|
method was added in vSphere API 6.7</p>
|
|||
|
|
<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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the virtual machine.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</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.guest_client.Power.Info" title="com.vmware.vcenter.vm.guest_client.Power.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Power.Info</span></code></a></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Guest OS powerstate information.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if the virtual machine is not found.</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.Power.reboot">
|
|||
|
|
<code class="descname">reboot</code><span class="sig-paren">(</span><em>vm</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest_client.Power.reboot" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Issues a request to the guest operating system asking it to perform a
|
|||
|
|
reboot. This request returns immediately and does not wait for the
|
|||
|
|
guest operating system to complete the operation. This method was added
|
|||
|
|
in vSphere API 6.7</p>
|
|||
|
|
<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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the virtual machine.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if the virtual machine is not found.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
if the virtual machine is not powered on.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
if VMware Tools is not running.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code>
|
|||
|
|
if the virtual machine is performing another operation.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code>
|
|||
|
|
if the virtual machine does not support being powered on (e.g.
|
|||
|
|
marked as a template, serving as a fault-tolerance secondary
|
|||
|
|
virtual machine).</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.Power.shutdown">
|
|||
|
|
<code class="descname">shutdown</code><span class="sig-paren">(</span><em>vm</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest_client.Power.shutdown" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Issues a request to the guest operating system asking it to perform a
|
|||
|
|
clean shutdown of all services. This request returns immediately and
|
|||
|
|
does not wait for the guest operating system to complete the operation.
|
|||
|
|
This method was added in vSphere API 6.7</p>
|
|||
|
|
<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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the virtual machine.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if the virtual machine is not found.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code>
|
|||
|
|
if the virtual machine is not powered on.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
if VMware Tools is not running.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
if the virtual machine is suspended.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code>
|
|||
|
|
if the virtual machine is performing another operation.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code>
|
|||
|
|
if the virtual machine does not support being powered on (e.g.
|
|||
|
|
marked as a template, serving as a fault-tolerance secondary
|
|||
|
|
virtual machine).</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.Power.standby">
|
|||
|
|
<code class="descname">standby</code><span class="sig-paren">(</span><em>vm</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest_client.Power.standby" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Issues a request to the guest operating system asking it to perform a
|
|||
|
|
suspend operation. This method was added in vSphere API 6.7</p>
|
|||
|
|
<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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the virtual machine.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code>
|
|||
|
|
if the virtual machine is suspended.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if the virtual machine is not found.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
if VMware Tools is not running.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
if the virtual machine is not powered on.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code>
|
|||
|
|
if the virtual machine is performing another operation.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code>
|
|||
|
|
if the virtual machine does not support being powered on (e.g.
|
|||
|
|
marked as a template, serving as a fault-tolerance secondary
|
|||
|
|
virtual machine).</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.StubFactory">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.vm.guest_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</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 <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware_client</span></code> module provides classes for
|
|||
|
|
managing the virtual hardware configuration and state of a virtual machine.
|
|||
|
|
This includes methods for reading and manipulating virtual device configuration
|
|||
|
|
and for querying the runtime state of the devices.</p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Boot">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.vm.hardware_client.</code><code class="descname">Boot</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Boot" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Boot</span></code> class provides methods for configuring the settings used when
|
|||
|
|
booting a virtual machine.</p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Boot.CreateSpec">
|
|||
|
|
<em class="property">class </em><code class="descname">CreateSpec</code><span class="sig-paren">(</span><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><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Boot.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Boot.CreateSpec</span></code> 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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Boot.Info">
|
|||
|
|
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><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><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Boot.Info" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Boot.Info</span></code> 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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Boot.NetworkProtocol">
|
|||
|
|
<em class="property">class </em><code class="descname">NetworkProtocol</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Boot.NetworkProtocol" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Boot.NetworkProtocol</span></code> 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"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Boot.Type.EFI</span></code></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="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Boot.NetworkProtocol.IPV4">
|
|||
|
|
<code class="descname">IPV4</code><em class="property"> = NetworkProtocol(string='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">
|
|||
|
|
<code class="descname">IPV6</code><em class="property"> = NetworkProtocol(string='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><code class="descname">Type</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Boot.Type" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Boot.Type</span></code> 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="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Boot.Type.BIOS">
|
|||
|
|
<code class="descname">BIOS</code><em class="property"> = Type(string='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">
|
|||
|
|
<code class="descname">EFI</code><em class="property"> = Type(string='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><code class="descname">UpdateSpec</code><span class="sig-paren">(</span><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><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Boot.UpdateSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Boot.UpdateSpec</span></code> 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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Boot.get">
|
|||
|
|
<code class="descname">get</code><span class="sig-paren">(</span><em>vm</em><span class="sig-paren">)</span><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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Boot.Info</span></code></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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if the virtual machine is not found.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
if the user can not be authenticated.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
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">
|
|||
|
|
<code class="descname">update</code><span class="sig-paren">(</span><em>vm</em>, <em>spec</em><span class="sig-paren">)</span><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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Boot.UpdateSpec</span></code></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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
|
|||
|
|
if one of the provided settings is not permitted; for example,
|
|||
|
|
specifying a negative value for <code class="docutils literal notranslate"><span class="pre">delay</span></code>.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
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><code class="descclassname">com.vmware.vcenter.vm.hardware_client.</code><code class="descname">Cdrom</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Cdrom" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Cdrom</span></code> class provides methods for configuring the virtual CD-ROM
|
|||
|
|
devices of a virtual machine.</p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingInfo">
|
|||
|
|
<em class="property">class </em><code class="descname">BackingInfo</code><span class="sig-paren">(</span><em>type=None</em>, <em>iso_file=None</em>, <em>host_device=None</em>, <em>auto_detect=None</em>, <em>device_access_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingInfo" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Cdrom.BackingInfo</span></code> 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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingSpec">
|
|||
|
|
<em class="property">class </em><code class="descname">BackingSpec</code><span class="sig-paren">(</span><em>type=None</em>, <em>iso_file=None</em>, <em>host_device=None</em>, <em>device_access_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Cdrom.BackingSpec</span></code> 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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType">
|
|||
|
|
<em class="property">class </em><code class="descname">BackingType</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Cdrom.BackingType</span></code> 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="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType.CLIENT_DEVICE">
|
|||
|
|
<code class="descname">CLIENT_DEVICE</code><em class="property"> = BackingType(string='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">
|
|||
|
|
<code class="descname">HOST_DEVICE</code><em class="property"> = BackingType(string='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">
|
|||
|
|
<code class="descname">ISO_FILE</code><em class="property"> = BackingType(string='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><code class="descname">CreateSpec</code><span class="sig-paren">(</span><em>type=None</em>, <em>ide=None</em>, <em>sata=None</em>, <em>backing=None</em>, <em>start_connected=None</em>, <em>allow_guest_control=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Cdrom.CreateSpec</span></code> 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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.DeviceAccessType">
|
|||
|
|
<em class="property">class </em><code class="descname">DeviceAccessType</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.DeviceAccessType" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Cdrom.DeviceAccessType</span></code> 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="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.DeviceAccessType.EMULATION">
|
|||
|
|
<code class="descname">EMULATION</code><em class="property"> = DeviceAccessType(string='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">
|
|||
|
|
<code class="descname">PASSTHRU</code><em class="property"> = DeviceAccessType(string='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">
|
|||
|
|
<code class="descname">PASSTHRU_EXCLUSIVE</code><em class="property"> = DeviceAccessType(string='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><code class="descname">HostBusAdapterType</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.HostBusAdapterType" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Cdrom.HostBusAdapterType</span></code> class defines the valid types of host bus
|
|||
|
|
adapters that may be used for attaching a Cdrom to a virtual machine.</p>
|
|||
|
|
<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="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.HostBusAdapterType.IDE">
|
|||
|
|
<code class="descname">IDE</code><em class="property"> = HostBusAdapterType(string='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">
|
|||
|
|
<code class="descname">SATA</code><em class="property"> = HostBusAdapterType(string='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><code class="descname">Info</code><span class="sig-paren">(</span><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><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.Info" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Cdrom.Info</span></code> 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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.RESOURCE_TYPE">
|
|||
|
|
<code class="descname">RESOURCE_TYPE</code><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><code class="descname">Summary</code><span class="sig-paren">(</span><em>cdrom=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.Summary" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Cdrom.Summary</span></code> 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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.UpdateSpec">
|
|||
|
|
<em class="property">class </em><code class="descname">UpdateSpec</code><span class="sig-paren">(</span><em>backing=None</em>, <em>start_connected=None</em>, <em>allow_guest_control=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.UpdateSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Cdrom.UpdateSpec</span></code> 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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.connect">
|
|||
|
|
<code class="descname">connect</code><span class="sig-paren">(</span><em>vm</em>, <em>cdrom</em><span class="sig-paren">)</span><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"><code class="xref py py-func docutils literal notranslate"><span class="pre">Cdrom.update()</span></code></a> method may
|
|||
|
|
be used to configure the virtual CD-ROM device to start in the
|
|||
|
|
connected state when the virtual machine is powered on.</p>
|
|||
|
|
<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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</li>
|
|||
|
|
<li><strong>cdrom</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual CD-ROM device identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Cdrom</span></code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
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">
|
|||
|
|
<code class="descname">create</code><span class="sig-paren">(</span><em>vm</em>, <em>spec</em><span class="sig-paren">)</span><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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cdrom.CreateSpec</span></code></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"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Cdrom</span></code>.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInUse</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code>
|
|||
|
|
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">
|
|||
|
|
<code class="descname">delete</code><span class="sig-paren">(</span><em>vm</em>, <em>cdrom</em><span class="sig-paren">)</span><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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</li>
|
|||
|
|
<li><strong>cdrom</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual CD-ROM device identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Cdrom</span></code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
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">
|
|||
|
|
<code class="descname">disconnect</code><span class="sig-paren">(</span><em>vm</em>, <em>cdrom</em><span class="sig-paren">)</span><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"><code class="xref py py-func docutils literal notranslate"><span class="pre">Cdrom.update()</span></code></a> method may
|
|||
|
|
be used to configure the virtual CD-ROM device to start in the
|
|||
|
|
disconnected state when the virtual machine is powered on.</p>
|
|||
|
|
<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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</li>
|
|||
|
|
<li><strong>cdrom</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual CD-ROM device identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Cdrom</span></code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
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">
|
|||
|
|
<code class="descname">get</code><span class="sig-paren">(</span><em>vm</em>, <em>cdrom</em><span class="sig-paren">)</span><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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</li>
|
|||
|
|
<li><strong>cdrom</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual CD-ROM device identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Cdrom</span></code>.</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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cdrom.Info</span></code></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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
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">
|
|||
|
|
<code class="descname">list</code><span class="sig-paren">(</span><em>vm</em><span class="sig-paren">)</span><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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</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"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.Summary" title="com.vmware.vcenter.vm.hardware_client.Cdrom.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cdrom.Summary</span></code></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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if the virtual machine is not found.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
if the user can not be authenticated.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
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">
|
|||
|
|
<code class="descname">update</code><span class="sig-paren">(</span><em>vm</em>, <em>cdrom</em>, <em>spec</em><span class="sig-paren">)</span><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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</li>
|
|||
|
|
<li><strong>cdrom</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual CD-ROM device identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Cdrom</span></code>.</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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cdrom.UpdateSpec</span></code></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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
if one or more of the attributes specified in the <code class="docutils literal notranslate"><span class="pre">spec</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
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><code class="descclassname">com.vmware.vcenter.vm.hardware_client.</code><code class="descname">ConnectionCreateSpec</code><span class="sig-paren">(</span><em>start_connected=None</em>, <em>allow_guest_control=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.ConnectionCreateSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">ConnectionCreateSpec</span></code> 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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.ConnectionInfo">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.vm.hardware_client.</code><code class="descname">ConnectionInfo</code><span class="sig-paren">(</span><em>state=None</em>, <em>start_connected=None</em>, <em>allow_guest_control=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.ConnectionInfo" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">ConnectionInfo</span></code> 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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.ConnectionState">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.vm.hardware_client.</code><code class="descname">ConnectionState</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.ConnectionState" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">ConnectionState</span></code> 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="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.ConnectionState.CONNECTED">
|
|||
|
|
<code class="descname">CONNECTED</code><em class="property"> = ConnectionState(string='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">
|
|||
|
|
<code class="descname">NOT_CONNECTED</code><em class="property"> = ConnectionState(string='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">
|
|||
|
|
<code class="descname">RECOVERABLE_ERROR</code><em class="property"> = ConnectionState(string='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">
|
|||
|
|
<code class="descname">UNKNOWN</code><em class="property"> = ConnectionState(string='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">
|
|||
|
|
<code class="descname">UNRECOVERABLE_ERROR</code><em class="property"> = ConnectionState(string='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><code class="descclassname">com.vmware.vcenter.vm.hardware_client.</code><code class="descname">ConnectionUpdateSpec</code><span class="sig-paren">(</span><em>start_connected=None</em>, <em>allow_guest_control=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.ConnectionUpdateSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">ConnectionUpdateSpec</span></code> 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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cpu">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.vm.hardware_client.</code><code class="descname">Cpu</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Cpu" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Cpu</span></code> class provides methods for configuring the CPU settings of a
|
|||
|
|
virtual machine.</p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cpu.Info">
|
|||
|
|
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>count=None</em>, <em>cores_per_socket=None</em>, <em>hot_add_enabled=None</em>, <em>hot_remove_enabled=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Cpu.Info" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Cpu.Info</span></code> 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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cpu.UpdateSpec">
|
|||
|
|
<em class="property">class </em><code class="descname">UpdateSpec</code><span class="sig-paren">(</span><em>count=None</em>, <em>cores_per_socket=None</em>, <em>hot_add_enabled=None</em>, <em>hot_remove_enabled=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Cpu.UpdateSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Cpu.UpdateSpec</span></code> 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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cpu.get">
|
|||
|
|
<code class="descname">get</code><span class="sig-paren">(</span><em>vm</em><span class="sig-paren">)</span><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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cpu.Info</span></code></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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if the virtual machine is not found.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
if the user can not be authenticated.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
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">
|
|||
|
|
<code class="descname">update</code><span class="sig-paren">(</span><em>vm</em>, <em>spec</em><span class="sig-paren">)</span><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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cpu.UpdateSpec</span></code></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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
|
|||
|
|
if one of the provided settings is not permitted; for example,
|
|||
|
|
specifying a negative value for <code class="docutils literal notranslate"><span class="pre">count</span></code>.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">hotAddEnabled</span></code> or <code class="docutils literal notranslate"><span class="pre">hotRemoveEnabled</span></code> 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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">count</span></code> is specified and is greater than <code class="docutils literal notranslate"><span class="pre">count</span></code>,
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">hotAddEnabled</span></code> 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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">count</span></code> is specified and is less than <code class="docutils literal notranslate"><span class="pre">count</span></code>,
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">hotRemoveEnabled</span></code> 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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
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><code class="descclassname">com.vmware.vcenter.vm.hardware_client.</code><code class="descname">Disk</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Disk" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Disk</span></code> class provides methods for configuring the virtual disks of a
|
|||
|
|
virtual machine. A virtual disk has a backing such as a VMDK file. The
|
|||
|
|
backing has an independent lifecycle from the virtual machine when it is
|
|||
|
|
detached from the virtual machine. The <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Disk.create" title="com.vmware.vcenter.vm.hardware_client.Disk.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">Disk.create()</span></code></a> method provides
|
|||
|
|
the ability to create a new virtual disk. When creating a virtual disk, a
|
|||
|
|
new VMDK file may be created or an existing VMDK file may used as a
|
|||
|
|
backing. Once a VMDK file is associated with a virtual machine, its
|
|||
|
|
lifecycle will be bound to the virtual machine. In other words, it will be
|
|||
|
|
deleted when the virtual machine is deleted. The <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Disk.delete" title="com.vmware.vcenter.vm.hardware_client.Disk.delete"><code class="xref py py-func docutils literal notranslate"><span class="pre">Disk.delete()</span></code></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"><code class="xref py py-func docutils literal notranslate"><span class="pre">Disk.delete()</span></code></a> method does not delete the VMDK file that backs the
|
|||
|
|
virtual disk. Once detached, the VMDK file will not be destroyed when the
|
|||
|
|
virtual machine to which it was associated is deleted.</p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.BackingInfo">
|
|||
|
|
<em class="property">class </em><code class="descname">BackingInfo</code><span class="sig-paren">(</span><em>type=None</em>, <em>vmdk_file=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Disk.BackingInfo" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Disk.BackingInfo</span></code> 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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.BackingSpec">
|
|||
|
|
<em class="property">class </em><code class="descname">BackingSpec</code><span class="sig-paren">(</span><em>type=None</em>, <em>vmdk_file=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Disk.BackingSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Disk.BackingSpec</span></code> 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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.BackingType">
|
|||
|
|
<em class="property">class </em><code class="descname">BackingType</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Disk.BackingType" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Disk.BackingType</span></code> 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="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.BackingType.VMDK_FILE">
|
|||
|
|
<code class="descname">VMDK_FILE</code><em class="property"> = BackingType(string='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><code class="descname">CreateSpec</code><span class="sig-paren">(</span><em>type=None</em>, <em>ide=None</em>, <em>scsi=None</em>, <em>sata=None</em>, <em>backing=None</em>, <em>new_vmdk=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Disk.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Disk.CreateSpec</span></code> 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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.HostBusAdapterType">
|
|||
|
|
<em class="property">class </em><code class="descname">HostBusAdapterType</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Disk.HostBusAdapterType" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Disk.HostBusAdapterType</span></code> class defines the valid types of host bus
|
|||
|
|
adapters that may be used for attaching a virtual storage device to a
|
|||
|
|
virtual machine.</p>
|
|||
|
|
<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="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.HostBusAdapterType.IDE">
|
|||
|
|
<code class="descname">IDE</code><em class="property"> = HostBusAdapterType(string='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">
|
|||
|
|
<code class="descname">SATA</code><em class="property"> = HostBusAdapterType(string='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">
|
|||
|
|
<code class="descname">SCSI</code><em class="property"> = HostBusAdapterType(string='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><code class="descname">Info</code><span class="sig-paren">(</span><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><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Disk.Info" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Disk.Info</span></code> 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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.RESOURCE_TYPE">
|
|||
|
|
<code class="descname">RESOURCE_TYPE</code><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.StoragePolicySpec">
|
|||
|
|
<em class="property">class </em><code class="descname">StoragePolicySpec</code><span class="sig-paren">(</span><em>policy=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Disk.StoragePolicySpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Disk.StoragePolicySpec</span></code> class contains information about the storage
|
|||
|
|
policy be associated with a VMDK file. This class was added in vSphere API
|
|||
|
|
6.7</p>
|
|||
|
|
<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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.Summary">
|
|||
|
|
<em class="property">class </em><code class="descname">Summary</code><span class="sig-paren">(</span><em>disk=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Disk.Summary" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Disk.Summary</span></code> 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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.UpdateSpec">
|
|||
|
|
<em class="property">class </em><code class="descname">UpdateSpec</code><span class="sig-paren">(</span><em>backing=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Disk.UpdateSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Disk.UpdateSpec</span></code> 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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.VmdkCreateSpec">
|
|||
|
|
<em class="property">class </em><code class="descname">VmdkCreateSpec</code><span class="sig-paren">(</span><em>name=None</em>, <em>capacity=None</em>, <em>storage_policy=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Disk.VmdkCreateSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Disk.VmdkCreateSpec</span></code> 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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.create">
|
|||
|
|
<code class="descname">create</code><span class="sig-paren">(</span><em>vm</em>, <em>spec</em><span class="sig-paren">)</span><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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Disk.CreateSpec</span></code></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"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInUse</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
|
|||
|
|
if the specified storage address is out of bounds or if the
|
|||
|
|
specified storage policy is invalid.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code>
|
|||
|
|
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">
|
|||
|
|
<code class="descname">delete</code><span class="sig-paren">(</span><em>vm</em>, <em>disk</em><span class="sig-paren">)</span><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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</li>
|
|||
|
|
<li><strong>disk</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual disk identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
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">
|
|||
|
|
<code class="descname">get</code><span class="sig-paren">(</span><em>vm</em>, <em>disk</em><span class="sig-paren">)</span><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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</li>
|
|||
|
|
<li><strong>disk</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual disk identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>.</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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Disk.Info</span></code></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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
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">
|
|||
|
|
<code class="descname">list</code><span class="sig-paren">(</span><em>vm</em><span class="sig-paren">)</span><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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</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"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Disk.Summary" title="com.vmware.vcenter.vm.hardware_client.Disk.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Disk.Summary</span></code></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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if the virtual machine is not found.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
if the user can not be authenticated.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
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">
|
|||
|
|
<code class="descname">update</code><span class="sig-paren">(</span><em>vm</em>, <em>disk</em>, <em>spec</em><span class="sig-paren">)</span><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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</li>
|
|||
|
|
<li><strong>disk</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual disk identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>.</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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Disk.UpdateSpec</span></code></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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
if one or more of the attributes specified in the <code class="docutils literal notranslate"><span class="pre">spec</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
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><code class="descclassname">com.vmware.vcenter.vm.hardware_client.</code><code class="descname">Ethernet</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Ethernet" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Ethernet</span></code> class provides methods for configuring the virtual
|
|||
|
|
Ethernet adapters of a virtual machine.</p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingInfo">
|
|||
|
|
<em class="property">class </em><code class="descname">BackingInfo</code><span class="sig-paren">(</span><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><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingInfo" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Ethernet.BackingInfo</span></code> 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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingSpec">
|
|||
|
|
<em class="property">class </em><code class="descname">BackingSpec</code><span class="sig-paren">(</span><em>type=None</em>, <em>network=None</em>, <em>distributed_port=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Ethernet.BackingSpec</span></code> 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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType">
|
|||
|
|
<em class="property">class </em><code class="descname">BackingType</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Ethernet.BackingType</span></code> 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="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.DISTRIBUTED_PORTGROUP">
|
|||
|
|
<code class="descname">DISTRIBUTED_PORTGROUP</code><em class="property"> = BackingType(string='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">
|
|||
|
|
<code class="descname">HOST_DEVICE</code><em class="property"> = BackingType(string='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">
|
|||
|
|
<code class="descname">OPAQUE_NETWORK</code><em class="property"> = BackingType(string='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">
|
|||
|
|
<code class="descname">STANDARD_PORTGROUP</code><em class="property"> = BackingType(string='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><code class="descname">CreateSpec</code><span class="sig-paren">(</span><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><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Ethernet.CreateSpec</span></code> 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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType">
|
|||
|
|
<em class="property">class </em><code class="descname">EmulationType</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Ethernet.EmulationType</span></code> 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="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType.E1000">
|
|||
|
|
<code class="descname">E1000</code><em class="property"> = EmulationType(string='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">
|
|||
|
|
<code class="descname">E1000E</code><em class="property"> = EmulationType(string='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">
|
|||
|
|
<code class="descname">PCNET32</code><em class="property"> = EmulationType(string='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">
|
|||
|
|
<code class="descname">VMXNET</code><em class="property"> = EmulationType(string='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">
|
|||
|
|
<code class="descname">VMXNET2</code><em class="property"> = EmulationType(string='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">
|
|||
|
|
<code class="descname">VMXNET3</code><em class="property"> = EmulationType(string='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><code class="descname">Info</code><span class="sig-paren">(</span><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><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.Info" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Ethernet.Info</span></code> 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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType">
|
|||
|
|
<em class="property">class </em><code class="descname">MacAddressType</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Ethernet.MacAddressType</span></code> 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="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType.ASSIGNED">
|
|||
|
|
<code class="descname">ASSIGNED</code><em class="property"> = MacAddressType(string='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">
|
|||
|
|
<code class="descname">GENERATED</code><em class="property"> = MacAddressType(string='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">
|
|||
|
|
<code class="descname">MANUAL</code><em class="property"> = MacAddressType(string='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">
|
|||
|
|
<code class="descname">RESOURCE_TYPE</code><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><code class="descname">Summary</code><span class="sig-paren">(</span><em>nic=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.Summary" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Ethernet.Summary</span></code> 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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.UpdateSpec">
|
|||
|
|
<em class="property">class </em><code class="descname">UpdateSpec</code><span class="sig-paren">(</span><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><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.UpdateSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Ethernet.UpdateSpec</span></code> 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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.connect">
|
|||
|
|
<code class="descname">connect</code><span class="sig-paren">(</span><em>vm</em>, <em>nic</em><span class="sig-paren">)</span><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"><code class="xref py py-func docutils literal notranslate"><span class="pre">Ethernet.update()</span></code></a> method
|
|||
|
|
may be used to configure the virtual Ethernet adapter to start in the
|
|||
|
|
connected state when the virtual machine is powered on.</p>
|
|||
|
|
<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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</li>
|
|||
|
|
<li><strong>nic</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual Ethernet adapter identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Ethernet</span></code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
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">
|
|||
|
|
<code class="descname">create</code><span class="sig-paren">(</span><em>vm</em>, <em>spec</em><span class="sig-paren">)</span><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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ethernet.CreateSpec</span></code></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"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Ethernet</span></code>.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code>
|
|||
|
|
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">
|
|||
|
|
<code class="descname">delete</code><span class="sig-paren">(</span><em>vm</em>, <em>nic</em><span class="sig-paren">)</span><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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</li>
|
|||
|
|
<li><strong>nic</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual Ethernet adapter identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Ethernet</span></code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
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">
|
|||
|
|
<code class="descname">disconnect</code><span class="sig-paren">(</span><em>vm</em>, <em>nic</em><span class="sig-paren">)</span><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"><code class="xref py py-func docutils literal notranslate"><span class="pre">Ethernet.update()</span></code></a> method
|
|||
|
|
may be used to configure the virtual Ethernet adapter to start in the
|
|||
|
|
disconnected state when the virtual machine is powered on.</p>
|
|||
|
|
<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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</li>
|
|||
|
|
<li><strong>nic</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual Ethernet adapter identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Ethernet</span></code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
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">
|
|||
|
|
<code class="descname">get</code><span class="sig-paren">(</span><em>vm</em>, <em>nic</em><span class="sig-paren">)</span><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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</li>
|
|||
|
|
<li><strong>nic</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual Ethernet adapter identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Ethernet</span></code>.</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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ethernet.Info</span></code></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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
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">
|
|||
|
|
<code class="descname">list</code><span class="sig-paren">(</span><em>vm</em><span class="sig-paren">)</span><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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</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"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.Summary" title="com.vmware.vcenter.vm.hardware_client.Ethernet.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ethernet.Summary</span></code></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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if the virtual machine is not found.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
if the user can not be authenticated.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
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">
|
|||
|
|
<code class="descname">update</code><span class="sig-paren">(</span><em>vm</em>, <em>nic</em>, <em>spec</em><span class="sig-paren">)</span><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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</li>
|
|||
|
|
<li><strong>nic</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual Ethernet adapter identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Ethernet</span></code>.</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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ethernet.UpdateSpec</span></code></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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
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><code class="descclassname">com.vmware.vcenter.vm.hardware_client.</code><code class="descname">Floppy</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Floppy" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Floppy</span></code> class provides methods for configuring the virtual floppy
|
|||
|
|
drives of a virtual machine.</p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Floppy.BackingInfo">
|
|||
|
|
<em class="property">class </em><code class="descname">BackingInfo</code><span class="sig-paren">(</span><em>type=None</em>, <em>image_file=None</em>, <em>host_device=None</em>, <em>auto_detect=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Floppy.BackingInfo" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Floppy.BackingInfo</span></code> 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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Floppy.BackingSpec">
|
|||
|
|
<em class="property">class </em><code class="descname">BackingSpec</code><span class="sig-paren">(</span><em>type=None</em>, <em>image_file=None</em>, <em>host_device=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Floppy.BackingSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Floppy.BackingSpec</span></code> 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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Floppy.BackingType">
|
|||
|
|
<em class="property">class </em><code class="descname">BackingType</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Floppy.BackingType" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Floppy.BackingType</span></code> 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="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Floppy.BackingType.CLIENT_DEVICE">
|
|||
|
|
<code class="descname">CLIENT_DEVICE</code><em class="property"> = BackingType(string='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">
|
|||
|
|
<code class="descname">HOST_DEVICE</code><em class="property"> = BackingType(string='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">
|
|||
|
|
<code class="descname">IMAGE_FILE</code><em class="property"> = BackingType(string='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><code class="descname">CreateSpec</code><span class="sig-paren">(</span><em>backing=None</em>, <em>start_connected=None</em>, <em>allow_guest_control=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Floppy.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Floppy.CreateSpec</span></code> 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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Floppy.Info">
|
|||
|
|
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>label=None</em>, <em>backing=None</em>, <em>state=None</em>, <em>start_connected=None</em>, <em>allow_guest_control=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Floppy.Info" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Floppy.Info</span></code> 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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Floppy.RESOURCE_TYPE">
|
|||
|
|
<code class="descname">RESOURCE_TYPE</code><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><code class="descname">Summary</code><span class="sig-paren">(</span><em>floppy=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Floppy.Summary" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Floppy.Summary</span></code> 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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Floppy.UpdateSpec">
|
|||
|
|
<em class="property">class </em><code class="descname">UpdateSpec</code><span class="sig-paren">(</span><em>backing=None</em>, <em>start_connected=None</em>, <em>allow_guest_control=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Floppy.UpdateSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Floppy.UpdateSpec</span></code> 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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Floppy.connect">
|
|||
|
|
<code class="descname">connect</code><span class="sig-paren">(</span><em>vm</em>, <em>floppy</em><span class="sig-paren">)</span><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"><code class="xref py py-func docutils literal notranslate"><span class="pre">Floppy.update()</span></code></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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</li>
|
|||
|
|
<li><strong>floppy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual floppy drive identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Floppy</span></code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
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">
|
|||
|
|
<code class="descname">create</code><span class="sig-paren">(</span><em>vm</em>, <em>spec</em><span class="sig-paren">)</span><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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Floppy.CreateSpec</span></code></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"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Floppy</span></code>.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
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">
|
|||
|
|
<code class="descname">delete</code><span class="sig-paren">(</span><em>vm</em>, <em>floppy</em><span class="sig-paren">)</span><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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</li>
|
|||
|
|
<li><strong>floppy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual floppy drive identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Floppy</span></code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
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">
|
|||
|
|
<code class="descname">disconnect</code><span class="sig-paren">(</span><em>vm</em>, <em>floppy</em><span class="sig-paren">)</span><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"><code class="xref py py-func docutils literal notranslate"><span class="pre">Floppy.update()</span></code></a> method may
|
|||
|
|
be used to configure the virtual floppy floppy to start in the
|
|||
|
|
disconnected state when the virtual machine is powered on.</p>
|
|||
|
|
<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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</li>
|
|||
|
|
<li><strong>floppy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual floppy drive identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Floppy</span></code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
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">
|
|||
|
|
<code class="descname">get</code><span class="sig-paren">(</span><em>vm</em>, <em>floppy</em><span class="sig-paren">)</span><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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</li>
|
|||
|
|
<li><strong>floppy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual floppy drive identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Floppy</span></code>.</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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Floppy.Info</span></code></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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
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">
|
|||
|
|
<code class="descname">list</code><span class="sig-paren">(</span><em>vm</em><span class="sig-paren">)</span><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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</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"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Floppy.Summary" title="com.vmware.vcenter.vm.hardware_client.Floppy.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Floppy.Summary</span></code></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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if the virtual machine is not found.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
if the user can not be authenticated.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
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">
|
|||
|
|
<code class="descname">update</code><span class="sig-paren">(</span><em>vm</em>, <em>floppy</em>, <em>spec</em><span class="sig-paren">)</span><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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</li>
|
|||
|
|
<li><strong>floppy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual floppy drive identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Floppy</span></code>.</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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Floppy.UpdateSpec</span></code></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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
if one or more of the attributes specified in the <code class="docutils literal notranslate"><span class="pre">spec</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
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><code class="descclassname">com.vmware.vcenter.vm.hardware_client.</code><code class="descname">IdeAddressInfo</code><span class="sig-paren">(</span><em>primary=None</em>, <em>master=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.IdeAddressInfo" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">IdeAddressInfo</span></code> class contains information about the address of a
|
|||
|
|
virtual device that is attached to a virtual IDE adapter of a virtual
|
|||
|
|
machine.</p>
|
|||
|
|
<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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.IdeAddressSpec">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.vm.hardware_client.</code><code class="descname">IdeAddressSpec</code><span class="sig-paren">(</span><em>primary=None</em>, <em>master=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.IdeAddressSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">IdeAddressSpec</span></code> class contains information for specifying the
|
|||
|
|
address of a virtual device that is attached to a virtual IDE adapter of a
|
|||
|
|
virtual machine.</p>
|
|||
|
|
<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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Memory">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.vm.hardware_client.</code><code class="descname">Memory</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Memory" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Memory</span></code> class provides methods for configuring the memory settings
|
|||
|
|
of a virtual machine.</p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Memory.Info">
|
|||
|
|
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>size_mib=None</em>, <em>hot_add_enabled=None</em>, <em>hot_add_increment_size_mib=None</em>, <em>hot_add_limit_mib=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Memory.Info" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Memory.Info</span></code> 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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Memory.UpdateSpec">
|
|||
|
|
<em class="property">class </em><code class="descname">UpdateSpec</code><span class="sig-paren">(</span><em>size_mib=None</em>, <em>hot_add_enabled=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Memory.UpdateSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Memory.UpdateSpec</span></code> 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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Memory.get">
|
|||
|
|
<code class="descname">get</code><span class="sig-paren">(</span><em>vm</em><span class="sig-paren">)</span><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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Memory.Info</span></code></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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if the virtual machine is not found.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
if the user can not be authenticated.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
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">
|
|||
|
|
<code class="descname">update</code><span class="sig-paren">(</span><em>vm</em>, <em>spec</em><span class="sig-paren">)</span><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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Memory.UpdateSpec</span></code></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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
|
|||
|
|
if one of the provided settings is not permitted; for example,
|
|||
|
|
specifying a negative value for <code class="docutils literal notranslate"><span class="pre">sizeMiB</span></code>.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">hotAddEnabled</span></code> 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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">sizeMiB</span></code> is specified, <code class="docutils literal notranslate"><span class="pre">hotAddEnabled</span></code> 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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
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><code class="descclassname">com.vmware.vcenter.vm.hardware_client.</code><code class="descname">Parallel</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Parallel" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Parallel</span></code> class provides methods for configuring the virtual
|
|||
|
|
parallel ports of a virtual machine.</p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Parallel.BackingInfo">
|
|||
|
|
<em class="property">class </em><code class="descname">BackingInfo</code><span class="sig-paren">(</span><em>type=None</em>, <em>file=None</em>, <em>host_device=None</em>, <em>auto_detect=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Parallel.BackingInfo" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Parallel.BackingInfo</span></code> 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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Parallel.BackingSpec">
|
|||
|
|
<em class="property">class </em><code class="descname">BackingSpec</code><span class="sig-paren">(</span><em>type=None</em>, <em>file=None</em>, <em>host_device=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Parallel.BackingSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Parallel.BackingSpec</span></code> 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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Parallel.BackingType">
|
|||
|
|
<em class="property">class </em><code class="descname">BackingType</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Parallel.BackingType" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Parallel.BackingType</span></code> 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="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Parallel.BackingType.FILE">
|
|||
|
|
<code class="descname">FILE</code><em class="property"> = BackingType(string='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">
|
|||
|
|
<code class="descname">HOST_DEVICE</code><em class="property"> = BackingType(string='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><code class="descname">CreateSpec</code><span class="sig-paren">(</span><em>backing=None</em>, <em>start_connected=None</em>, <em>allow_guest_control=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Parallel.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Parallel.CreateSpec</span></code> 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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Parallel.Info">
|
|||
|
|
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>label=None</em>, <em>backing=None</em>, <em>state=None</em>, <em>start_connected=None</em>, <em>allow_guest_control=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Parallel.Info" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Parallel.Info</span></code> 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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Parallel.RESOURCE_TYPE">
|
|||
|
|
<code class="descname">RESOURCE_TYPE</code><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><code class="descname">Summary</code><span class="sig-paren">(</span><em>port=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Parallel.Summary" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Parallel.Summary</span></code> 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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Parallel.UpdateSpec">
|
|||
|
|
<em class="property">class </em><code class="descname">UpdateSpec</code><span class="sig-paren">(</span><em>backing=None</em>, <em>start_connected=None</em>, <em>allow_guest_control=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Parallel.UpdateSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Parallel.UpdateSpec</span></code> 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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Parallel.connect">
|
|||
|
|
<code class="descname">connect</code><span class="sig-paren">(</span><em>vm</em>, <em>port</em><span class="sig-paren">)</span><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"><code class="xref py py-func docutils literal notranslate"><span class="pre">Parallel.update()</span></code></a> method
|
|||
|
|
may be used to configure the virtual parallel port to start in the
|
|||
|
|
connected state when the virtual machine is powered on.</p>
|
|||
|
|
<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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</li>
|
|||
|
|
<li><strong>port</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual parallel port identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.ParallelPort</span></code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
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">
|
|||
|
|
<code class="descname">create</code><span class="sig-paren">(</span><em>vm</em>, <em>spec</em><span class="sig-paren">)</span><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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Parallel.CreateSpec</span></code></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"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.ParallelPort</span></code>.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
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">
|
|||
|
|
<code class="descname">delete</code><span class="sig-paren">(</span><em>vm</em>, <em>port</em><span class="sig-paren">)</span><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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</li>
|
|||
|
|
<li><strong>port</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual parallel port identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.ParallelPort</span></code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
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">
|
|||
|
|
<code class="descname">disconnect</code><span class="sig-paren">(</span><em>vm</em>, <em>port</em><span class="sig-paren">)</span><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"><code class="xref py py-func docutils literal notranslate"><span class="pre">Parallel.update()</span></code></a> method
|
|||
|
|
may be used to configure the virtual parallel port to start in the
|
|||
|
|
disconnected state when the virtual machine is powered on.</p>
|
|||
|
|
<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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</li>
|
|||
|
|
<li><strong>port</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual parallel port identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.ParallelPort</span></code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
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">
|
|||
|
|
<code class="descname">get</code><span class="sig-paren">(</span><em>vm</em>, <em>port</em><span class="sig-paren">)</span><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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</li>
|
|||
|
|
<li><strong>port</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual parallel port identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.ParallelPort</span></code>.</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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Parallel.Info</span></code></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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
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">
|
|||
|
|
<code class="descname">list</code><span class="sig-paren">(</span><em>vm</em><span class="sig-paren">)</span><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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</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"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Parallel.Summary" title="com.vmware.vcenter.vm.hardware_client.Parallel.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Parallel.Summary</span></code></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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if the virtual machine is not found.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
if the user can not be authenticated.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
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">
|
|||
|
|
<code class="descname">update</code><span class="sig-paren">(</span><em>vm</em>, <em>port</em>, <em>spec</em><span class="sig-paren">)</span><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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</li>
|
|||
|
|
<li><strong>port</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual parallel port identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.ParallelPort</span></code>.</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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Parallel.UpdateSpec</span></code></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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
if one or more of the attributes specified in the <code class="docutils literal notranslate"><span class="pre">spec</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
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><code class="descclassname">com.vmware.vcenter.vm.hardware_client.</code><code class="descname">SataAddressInfo</code><span class="sig-paren">(</span><em>bus=None</em>, <em>unit=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.SataAddressInfo" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">SataAddressInfo</span></code> class contains information about the address of a
|
|||
|
|
virtual device that is attached to a virtual SATA adapter of a virtual
|
|||
|
|
machine.</p>
|
|||
|
|
<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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.SataAddressSpec">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.vm.hardware_client.</code><code class="descname">SataAddressSpec</code><span class="sig-paren">(</span><em>bus=None</em>, <em>unit=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.SataAddressSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">SataAddressSpec</span></code> class contains information for specifying the
|
|||
|
|
address of a virtual device that is attached to a virtual SATA adapter of a
|
|||
|
|
virtual machine.</p>
|
|||
|
|
<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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.ScsiAddressInfo">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.vm.hardware_client.</code><code class="descname">ScsiAddressInfo</code><span class="sig-paren">(</span><em>bus=None</em>, <em>unit=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.ScsiAddressInfo" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">ScsiAddressInfo</span></code> class contains information about the address of a
|
|||
|
|
virtual device that is attached to a virtual SCSI adapter of a virtual
|
|||
|
|
machine.</p>
|
|||
|
|
<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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.ScsiAddressSpec">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.vm.hardware_client.</code><code class="descname">ScsiAddressSpec</code><span class="sig-paren">(</span><em>bus=None</em>, <em>unit=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.ScsiAddressSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">ScsiAddressSpec</span></code> class contains information for specifying the
|
|||
|
|
address of a virtual device that is attached to a virtual SCSI adapter of a
|
|||
|
|
virtual machine.</p>
|
|||
|
|
<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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.vm.hardware_client.</code><code class="descname">Serial</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Serial" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Serial</span></code> class provides methods for configuring the virtual serial
|
|||
|
|
ports of a virtual machine.</p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.BackingInfo">
|
|||
|
|
<em class="property">class </em><code class="descname">BackingInfo</code><span class="sig-paren">(</span><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><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingInfo" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Serial.BackingInfo</span></code> 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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.BackingSpec">
|
|||
|
|
<em class="property">class </em><code class="descname">BackingSpec</code><span class="sig-paren">(</span><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><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Serial.BackingSpec</span></code> 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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.BackingType">
|
|||
|
|
<em class="property">class </em><code class="descname">BackingType</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Serial.BackingType</span></code> 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="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.FILE">
|
|||
|
|
<code class="descname">FILE</code><em class="property"> = BackingType(string='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">
|
|||
|
|
<code class="descname">HOST_DEVICE</code><em class="property"> = BackingType(string='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">
|
|||
|
|
<code class="descname">NETWORK_CLIENT</code><em class="property"> = BackingType(string='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">
|
|||
|
|
<code class="descname">NETWORK_SERVER</code><em class="property"> = BackingType(string='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">
|
|||
|
|
<code class="descname">PIPE_CLIENT</code><em class="property"> = BackingType(string='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">
|
|||
|
|
<code class="descname">PIPE_SERVER</code><em class="property"> = BackingType(string='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><code class="descname">CreateSpec</code><span class="sig-paren">(</span><em>yield_on_poll=None</em>, <em>backing=None</em>, <em>start_connected=None</em>, <em>allow_guest_control=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Serial.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Serial.CreateSpec</span></code> 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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.Info">
|
|||
|
|
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>label=None</em>, <em>yield_on_poll=None</em>, <em>backing=None</em>, <em>state=None</em>, <em>start_connected=None</em>, <em>allow_guest_control=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Serial.Info" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Serial.Info</span></code> 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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.RESOURCE_TYPE">
|
|||
|
|
<code class="descname">RESOURCE_TYPE</code><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><code class="descname">Summary</code><span class="sig-paren">(</span><em>port=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Serial.Summary" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Serial.Summary</span></code> 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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.UpdateSpec">
|
|||
|
|
<em class="property">class </em><code class="descname">UpdateSpec</code><span class="sig-paren">(</span><em>yield_on_poll=None</em>, <em>backing=None</em>, <em>start_connected=None</em>, <em>allow_guest_control=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.Serial.UpdateSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Serial.UpdateSpec</span></code> 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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.connect">
|
|||
|
|
<code class="descname">connect</code><span class="sig-paren">(</span><em>vm</em>, <em>port</em><span class="sig-paren">)</span><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"><code class="xref py py-func docutils literal notranslate"><span class="pre">Serial.update()</span></code></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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</li>
|
|||
|
|
<li><strong>port</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual serial port identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.SerialPort</span></code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
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">
|
|||
|
|
<code class="descname">create</code><span class="sig-paren">(</span><em>vm</em>, <em>spec</em><span class="sig-paren">)</span><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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Serial.CreateSpec</span></code></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"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.SerialPort</span></code>.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
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">
|
|||
|
|
<code class="descname">delete</code><span class="sig-paren">(</span><em>vm</em>, <em>port</em><span class="sig-paren">)</span><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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</li>
|
|||
|
|
<li><strong>port</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual serial port identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.SerialPort</span></code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
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">
|
|||
|
|
<code class="descname">disconnect</code><span class="sig-paren">(</span><em>vm</em>, <em>port</em><span class="sig-paren">)</span><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"><code class="xref py py-func docutils literal notranslate"><span class="pre">Serial.update()</span></code></a> method may
|
|||
|
|
be used to configure the virtual serial port to start in the
|
|||
|
|
disconnected state when the virtual machine is powered on.</p>
|
|||
|
|
<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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</li>
|
|||
|
|
<li><strong>port</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual serial port identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.SerialPort</span></code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
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">
|
|||
|
|
<code class="descname">get</code><span class="sig-paren">(</span><em>vm</em>, <em>port</em><span class="sig-paren">)</span><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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</li>
|
|||
|
|
<li><strong>port</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual serial port identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.SerialPort</span></code>.</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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Serial.Info</span></code></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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
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">
|
|||
|
|
<code class="descname">list</code><span class="sig-paren">(</span><em>vm</em><span class="sig-paren">)</span><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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</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"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.Summary" title="com.vmware.vcenter.vm.hardware_client.Serial.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Serial.Summary</span></code></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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if the virtual machine is not found.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
if the user can not be authenticated.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
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">
|
|||
|
|
<code class="descname">update</code><span class="sig-paren">(</span><em>vm</em>, <em>port</em>, <em>spec</em><span class="sig-paren">)</span><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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</li>
|
|||
|
|
<li><strong>port</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual serial port identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.SerialPort</span></code>.</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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Serial.UpdateSpec</span></code></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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
if one or more of the attributes specified in the <code class="docutils literal notranslate"><span class="pre">spec</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
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.StubFactory">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.vm.hardware_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div class="section" id="module-com.vmware.vcenter.vm.storage_client">
|
|||
|
|
<span id="com-vmware-vcenter-vm-storage-client-module"></span><h2>com.vmware.vcenter.vm.storage_client module<a class="headerlink" href="#module-com.vmware.vcenter.vm.storage_client" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.storage_client.Policy">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.vm.storage_client.</code><code class="descname">Policy</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.storage_client.Policy" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Policy</span></code> class provides methods to configure the storage policies
|
|||
|
|
associated with the virtual machine home and/or its virtual disks. This
|
|||
|
|
class was added in vSphere API 6.7</p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.storage_client.Policy.DiskPolicySpec">
|
|||
|
|
<em class="property">class </em><code class="descname">DiskPolicySpec</code><span class="sig-paren">(</span><em>type=None</em>, <em>policy=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.storage_client.Policy.DiskPolicySpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Policy.DiskPolicySpec</span></code> class provides a specification for the
|
|||
|
|
storage policy to be associated with the virtual disks. This class was
|
|||
|
|
added in vSphere API 6.7</p>
|
|||
|
|
<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>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.storage_client.Policy.DiskPolicySpec.PolicyType">
|
|||
|
|
<em class="property">class </em><code class="descname">PolicyType</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.storage_client.Policy.DiskPolicySpec.PolicyType" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Policy.DiskPolicySpec</span></code> class defines the choices for how to specify
|
|||
|
|
the policy to be associated with a virtual disk. This enumeration was added
|
|||
|
|
in vSphere API 6.7</p>
|
|||
|
|
<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="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.storage_client.Policy.DiskPolicySpec.PolicyType.USE_DEFAULT_POLICY">
|
|||
|
|
<code class="descname">USE_DEFAULT_POLICY</code><em class="property"> = PolicyType(string='USE_DEFAULT_POLICY')</em><a class="headerlink" href="#com.vmware.vcenter.vm.storage_client.Policy.DiskPolicySpec.PolicyType.USE_DEFAULT_POLICY" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Use the default storage policy of the datastore. This class attribute was
|
|||
|
|
added in vSphere API 6.7</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.storage_client.Policy.DiskPolicySpec.PolicyType.USE_SPECIFIED_POLICY">
|
|||
|
|
<code class="descname">USE_SPECIFIED_POLICY</code><em class="property"> = PolicyType(string='USE_SPECIFIED_POLICY')</em><a class="headerlink" href="#com.vmware.vcenter.vm.storage_client.Policy.DiskPolicySpec.PolicyType.USE_SPECIFIED_POLICY" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Use the specified policy (see <code class="xref py py-attr docutils literal notranslate"><span class="pre">Policy.DiskPolicySpec.policy</span></code>). This
|
|||
|
|
class attribute was added in vSphere API 6.7</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.storage_client.Policy.Info">
|
|||
|
|
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>vm_home=None</em>, <em>disks=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.storage_client.Policy.Info" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Policy.Info</span></code> class contains information about the storage policies
|
|||
|
|
associated with virtual machine’s home directory and virtual hard disks.
|
|||
|
|
This class was added in vSphere API 6.7</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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.storage_client.Policy.UpdateSpec">
|
|||
|
|
<em class="property">class </em><code class="descname">UpdateSpec</code><span class="sig-paren">(</span><em>vm_home=None</em>, <em>disks=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.storage_client.Policy.UpdateSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Policy.UpdateSpec</span></code> class describes the updates to be made to the
|
|||
|
|
storage policies associated with the virtual machine home and/or its
|
|||
|
|
virtual disks. This class was added in vSphere API 6.7</p>
|
|||
|
|
<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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.storage_client.Policy.VmHomePolicySpec">
|
|||
|
|
<em class="property">class </em><code class="descname">VmHomePolicySpec</code><span class="sig-paren">(</span><em>type=None</em>, <em>policy=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.storage_client.Policy.VmHomePolicySpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Policy.VmHomePolicySpec</span></code> class provides a specification for the
|
|||
|
|
storage policy to be associated with the virtual machine home’s directory.
|
|||
|
|
This class was added in vSphere API 6.7</p>
|
|||
|
|
<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>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.storage_client.Policy.VmHomePolicySpec.PolicyType">
|
|||
|
|
<em class="property">class </em><code class="descname">PolicyType</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.storage_client.Policy.VmHomePolicySpec.PolicyType" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Policy.VmHomePolicySpec.PolicyType</span></code> class defines the choices for
|
|||
|
|
how to specify the policy to be associated with the virtual machine home’s
|
|||
|
|
directory. This enumeration was added in vSphere API 6.7</p>
|
|||
|
|
<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="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.storage_client.Policy.VmHomePolicySpec.PolicyType.USE_DEFAULT_POLICY">
|
|||
|
|
<code class="descname">USE_DEFAULT_POLICY</code><em class="property"> = PolicyType(string='USE_DEFAULT_POLICY')</em><a class="headerlink" href="#com.vmware.vcenter.vm.storage_client.Policy.VmHomePolicySpec.PolicyType.USE_DEFAULT_POLICY" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Use the default storage policy of the datastore. This class attribute was
|
|||
|
|
added in vSphere API 6.7</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.storage_client.Policy.VmHomePolicySpec.PolicyType.USE_SPECIFIED_POLICY">
|
|||
|
|
<code class="descname">USE_SPECIFIED_POLICY</code><em class="property"> = PolicyType(string='USE_SPECIFIED_POLICY')</em><a class="headerlink" href="#com.vmware.vcenter.vm.storage_client.Policy.VmHomePolicySpec.PolicyType.USE_SPECIFIED_POLICY" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Use the specified policy (see <code class="xref py py-attr docutils literal notranslate"><span class="pre">Policy.VmHomePolicySpec.policy</span></code>). This
|
|||
|
|
class attribute was added in vSphere API 6.7</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.storage_client.Policy.get">
|
|||
|
|
<code class="descname">get</code><span class="sig-paren">(</span><em>vm</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.storage_client.Policy.get" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Returns Information about Storage Policy associated with a virtual
|
|||
|
|
machine’s home directory and/or its virtual hard disks. This method was
|
|||
|
|
added in vSphere API 6.7</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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</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.storage_client.Policy.Info" title="com.vmware.vcenter.vm.storage_client.Policy.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Policy.Info</span></code></a></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Overview of Storage Policy associated with a virtual machine’s home
|
|||
|
|
directory and/or its associated virtual hard disks.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
if the user can not be authenticated.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if the user does not have the required privileges.</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.storage_client.Policy.update">
|
|||
|
|
<code class="descname">update</code><span class="sig-paren">(</span><em>vm</em>, <em>spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.storage_client.Policy.update" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Updates the storage policy configuration of a virtual machine and/or
|
|||
|
|
its associated virtual hard disks. This method was added in vSphere API
|
|||
|
|
6.7</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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine identifier.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</li>
|
|||
|
|
<li><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.storage_client.Policy.UpdateSpec" title="com.vmware.vcenter.vm.storage_client.Policy.UpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Policy.UpdateSpec</span></code></a>) – Storage Policy Specification for updating the virtual machine and
|
|||
|
|
virtual disks.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
|
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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
|||
|
|
if the user is not authenticated.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if the user doesn’t have the required priveleges.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
|
|||
|
|
if the storage policy specified is invalid.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code>
|
|||
|
|
if the virtual machine or disk 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 last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code>
|
|||
|
|
if the virtual machine or disk’s configuration state cannot be
|
|||
|
|
accessed.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.storage_client.StubFactory">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.vm.storage_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.storage_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div class="articleComments">
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<footer>
|
|||
|
|
|
|||
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|||
|
|
|
|||
|
|
<a href="com.vmware.vcenter.vm.hardware.html" class="btn btn-neutral float-right" title="com.vmware.vcenter.vm.hardware package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a href="com.vmware.vcenter.storage.policies.html" class="btn btn-neutral" title="com.vmware.vcenter.storage.policies package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<hr/>
|
|||
|
|
|
|||
|
|
<div role="contentinfo">
|
|||
|
|
<p>
|
|||
|
|
© Copyright 2018, VMware, Inc..
|
|||
|
|
|
|||
|
|
</p>
|
|||
|
|
</div>
|
|||
|
|
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|||
|
|
|
|||
|
|
</footer>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
</section>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script type="text/javascript">
|
|||
|
|
var DOCUMENTATION_OPTIONS = {
|
|||
|
|
URL_ROOT:'./',
|
|||
|
|
VERSION:'6.7.0',
|
|||
|
|
COLLAPSE_INDEX:false,
|
|||
|
|
FILE_SUFFIX:'.html',
|
|||
|
|
HAS_SOURCE: true,
|
|||
|
|
SOURCELINK_SUFFIX: '.txt'
|
|||
|
|
};
|
|||
|
|
</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>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script type="text/javascript">
|
|||
|
|
jQuery(function () {
|
|||
|
|
SphinxRtdTheme.StickyNav.enable();
|
|||
|
|
});
|
|||
|
|
</script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</body>
|
|||
|
|
</html>
|