mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-25 02:39:59 -05:00
6956 lines
624 KiB
HTML
6956 lines
624 KiB
HTML
|
|
|||
|
|
|
|||
|
|
<!DOCTYPE html>
|
|||
|
|
<html class="writer-html5" lang="en" >
|
|||
|
|
<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. 7.0.1.0 documentation</title>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
|||
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<!--[if lt IE 9]>
|
|||
|
|
<script src="_static/js/html5shiv.min.js"></script>
|
|||
|
|
<![endif]-->
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
|||
|
|
<script src="_static/jquery.js"></script>
|
|||
|
|
<script src="_static/underscore.js"></script>
|
|||
|
|
<script src="_static/doctools.js"></script>
|
|||
|
|
<script src="_static/language_data.js"></script>
|
|||
|
|
|
|||
|
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<link rel="index" title="Index" href="genindex.html" />
|
|||
|
|
<link rel="search" title="Search" href="search.html" />
|
|||
|
|
<link rel="next" title="com.vmware.vcenter.vm.guest package" href="com.vmware.vcenter.vm.guest.html" />
|
|||
|
|
<link rel="prev" title="com.vmware.vcenter.vcha package" href="com.vmware.vcenter.vcha.html" />
|
|||
|
|
</head>
|
|||
|
|
|
|||
|
|
<body class="wy-body-for-nav">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<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" alt="Documentation Home"> vSphere Automation SDK for Python.
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="version">
|
|||
|
|
7.0.1.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.vapi_client">com.vmware.vapi_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>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_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" 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" class="icon icon-home"></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.guest.html">com.vmware.vcenter.vm.guest package</a><ul>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.vm.guest.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.vm.guest.html#module-com.vmware.vcenter.vm.guest.networking_client">com.vmware.vcenter.vm.guest.networking_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<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.compute_client">
|
|||
|
|
<span id="com-vmware-vcenter-vm-compute-client-module"></span><h2>com.vmware.vcenter.vm.compute_client module<a class="headerlink" href="#module-com.vmware.vcenter.vm.compute_client" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.compute_client</span></code> module provides classes for
|
|||
|
|
quering the status of compute policies on virtual machines in VMware Cloud on
|
|||
|
|
AWS. Usage beyond VMware Cloud on AWS is not supported.</p>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.compute_client.Policies">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm.compute_client.</code><code class="sig-name descname">Policies</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.compute_client.Policies" 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">Policies</span></code> class provides methods to query the status of policies on
|
|||
|
|
virtual machines in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS
|
|||
|
|
is not supported. <strong>Warning:</strong> This class is available as Technology
|
|||
|
|
Preview. These are early access APIs provided to test, automate and provide
|
|||
|
|
feedback on the feature. Since this can change based on feedback, VMware
|
|||
|
|
does not guarantee backwards compatibility and recommends against using
|
|||
|
|
them in production environments. Some Technology Preview APIs might only be
|
|||
|
|
applicable to specific environments.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.compute_client.Policies.Info">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">status</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.compute_client.Policies.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">Policies.Info</span></code> class contains information about the compliance of a
|
|||
|
|
virtual machine with a compute policy. <strong>Warning:</strong> This class is available
|
|||
|
|
as Technology Preview. These are early access APIs provided to test,
|
|||
|
|
automate and provide feedback on the feature. Since this can change based
|
|||
|
|
on feedback, VMware does not guarantee backwards compatibility and
|
|||
|
|
recommends against using them in production environments. Some Technology
|
|||
|
|
Preview APIs might only be applicable to specific environments.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>status</strong> (<a class="reference internal" href="com.vmware.vcenter.compute.html#com.vmware.vcenter.compute.policies_client.ObjectCompliance" title="com.vmware.vcenter.compute.policies_client.ObjectCompliance"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies_client.ObjectCompliance</span></code></a>) – The compliance status of the policy on a specified
|
|||
|
|
object.**Warning:** This attribute is available as Technology
|
|||
|
|
Preview. These are early access APIs provided to test, automate and
|
|||
|
|
provide feedback on the feature. Since this can change based on
|
|||
|
|
feedback, VMware does not guarantee backwards compatibility and
|
|||
|
|
recommends against using them in production environments. Some
|
|||
|
|
Technology Preview APIs might only be applicable to specific
|
|||
|
|
environments.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.compute_client.Policies.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></em>, <em class="sig-param"><span class="n">policy</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.compute_client.Policies.get" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Returns information about the compliance of a virtual machine with a
|
|||
|
|
compute policy in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS
|
|||
|
|
is not supported. <strong>Warning:</strong> This method is available as Technology
|
|||
|
|
Preview. These are early access APIs provided to test, automate and
|
|||
|
|
provide feedback on the feature. Since this can change based on
|
|||
|
|
feedback, VMware does not guarantee backwards compatibility and
|
|||
|
|
recommends against using them in production environments. Some
|
|||
|
|
Technology Preview APIs might only be applicable to specific
|
|||
|
|
environments.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the virtual machine to query the status for.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p></li>
|
|||
|
|
<li><p><strong>policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the policy to query the status for.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.Resources.COMPUTE_POLICY</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.vm.compute_client.Policies.Info" title="com.vmware.vcenter.vm.compute_client.Policies.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Policies.Info</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>Information about the compliance of the specified virtual machine
|
|||
|
|
with the specified compute policy.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if a virtual machine with the given identifier does not exist, or
|
|||
|
|
if a policy with the given identifier does not exist.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.compute_client.StubFactory">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm.compute_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.compute_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>
|
|||
|
|
<p>Initialize StubFactoryBase</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div class="section" id="module-com.vmware.vcenter.vm.console_client">
|
|||
|
|
<span id="com-vmware-vcenter-vm-console-client-module"></span><h2>com.vmware.vcenter.vm.console_client module<a class="headerlink" href="#module-com.vmware.vcenter.vm.console_client" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.console_client</span></code> module provides classes for
|
|||
|
|
managing Virtual Machine Consoles.</p>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.console_client.StubFactory">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm.console_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.console_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>
|
|||
|
|
<p>Initialize StubFactoryBase</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.console_client.Tickets">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm.console_client.</code><code class="sig-name descname">Tickets</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.console_client.Tickets" 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">Tickets</span></code> class provides methods for managing the virtual machine
|
|||
|
|
console tickets. This class was added in vSphere API 7.0.0.2.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.console_client.Tickets.CreateSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">CreateSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">type</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.console_client.Tickets.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">Tickets.CreateSpec</span></code> class defines the information used to create the
|
|||
|
|
virtual machine console ticket. This class was added in vSphere API
|
|||
|
|
7.0.0.2.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.console_client.Tickets.Type" title="com.vmware.vcenter.vm.console_client.Tickets.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tickets.Type</span></code></a>) – The type of virtual machine console ticket. This attribute was
|
|||
|
|
added in vSphere API 7.0.0.2.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.console_client.Tickets.Summary">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">ticket</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.console_client.Tickets.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">Tickets.Summary</span></code> class contains commonly used information about the
|
|||
|
|
virtual machine console ticket. This class was added in vSphere API
|
|||
|
|
7.0.0.2.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>ticket</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Console ticket URI. This attribute was added in vSphere API
|
|||
|
|
7.0.0.2.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.console_client.Tickets.Type">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Type</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.console_client.Tickets.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">Tickets.Type</span></code> class defines the types of console tickets. This
|
|||
|
|
enumeration was added in vSphere API 7.0.0.2.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.console_client.Tickets.Type.VMRC">
|
|||
|
|
<code class="sig-name descname">VMRC</code><em class="property"> = Type(string='VMRC')</em><a class="headerlink" href="#com.vmware.vcenter.vm.console_client.Tickets.Type.VMRC" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Virtual machine remote console ticket. This class attribute was added in
|
|||
|
|
vSphere API 7.0.0.2.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.console_client.Tickets.Type.WEBMKS">
|
|||
|
|
<code class="sig-name descname">WEBMKS</code><em class="property"> = Type(string='WEBMKS')</em><a class="headerlink" href="#com.vmware.vcenter.vm.console_client.Tickets.Type.WEBMKS" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Web socket console ticket. This class attribute was added in vSphere API
|
|||
|
|
7.0.0.2.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.console_client.Tickets.create">
|
|||
|
|
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></em>, <em class="sig-param"><span class="n">spec</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.console_client.Tickets.create" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Creates a virtual machine console ticket of a given ticket type. The
|
|||
|
|
created ticket is a one time use URI. The validity of the ticket is 30
|
|||
|
|
minutes, if not used with in the time frame the ticket expires.</p>
|
|||
|
|
<p>The <a class="reference internal" href="#com.vmware.vcenter.vm.console_client.Tickets.Type.VMRC" title="com.vmware.vcenter.vm.console_client.Tickets.Type.VMRC"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Tickets.Type.VMRC</span></code></a> ticket contains the IP address or the DNS
|
|||
|
|
resolvable name of the vCenter server. This ticket requires
|
|||
|
|
installation of VMware Workstation, VMware Fusion or VMRC to be
|
|||
|
|
installed on the machine where the ticket has to be opened. This ticket
|
|||
|
|
can be acquired even when the VM is turned off.</p>
|
|||
|
|
<p>The <a class="reference internal" href="#com.vmware.vcenter.vm.console_client.Tickets.Type.WEBMKS" title="com.vmware.vcenter.vm.console_client.Tickets.Type.WEBMKS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Tickets.Type.WEBMKS</span></code></a> ticket contains the IP address of the
|
|||
|
|
DNS resolvable name of the ESX server. This ticket requires user to
|
|||
|
|
embed this ticket in a HTML page using VMware HTML Console SDK -
|
|||
|
|
<a class="reference external" href="https://www.vmware.com/support/developer/html-console">https://www.vmware.com/support/developer/html-console</a> This ticket can
|
|||
|
|
be acquired only when the VM is turned on.. This method was added in
|
|||
|
|
vSphere API 7.0.0.2.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.console_client.Tickets.CreateSpec" title="com.vmware.vcenter.vm.console_client.Tickets.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tickets.CreateSpec</span></code></a>) – Specification for the console ticket to be created.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.vm.console_client.Tickets.Summary" title="com.vmware.vcenter.vm.console_client.Tickets.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tickets.Summary</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>Commonly used information about the virtual machine console ticket.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if the {\@link CreateSpec#type) attribute contains a value that
|
|||
|
|
is not supported by the server.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the virtual machine is powered off and requested ticket type is
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.console_client.Tickets.Type.WEBMKS" title="com.vmware.vcenter.vm.console_client.Tickets.Type.WEBMKS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Tickets.Type.WEBMKS</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration or execution state cannot be
|
|||
|
|
accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</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="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.Customization">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm.guest_client.</code><code class="sig-name descname">Customization</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest_client.Customization" 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">Customization</span></code> class provides methods to apply a customization
|
|||
|
|
specification to a virtual machine. This class was added in vSphere API
|
|||
|
|
7.0.0.0.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.Customization.Info">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">status</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">error</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">start_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">end_time</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest_client.Customization.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">Customization.Info</span></code> class contains the status of a customization
|
|||
|
|
operation applied to a virtual machine. This class was added in vSphere API
|
|||
|
|
7.0.0.0.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.guest_client.Customization.Info.Status" title="com.vmware.vcenter.vm.guest_client.Customization.Info.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">Customization.Info.Status</span></code></a>) – The status of the customization operation. This attribute was added
|
|||
|
|
in vSphere API 7.0.0.0.</p></li>
|
|||
|
|
<li><p><strong>error</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Description of the error if the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Customization.Info.status</span></code>
|
|||
|
|
of customization operation is
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.guest_client.Customization.Info.Status.FAILED" title="com.vmware.vcenter.vm.guest_client.Customization.Info.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Customization.Info.Status.FAILED</span></code></a>. This attribute was added
|
|||
|
|
in vSphere API 7.0.0.0.
|
|||
|
|
This attribute will be None if the status is not FAILED or there is
|
|||
|
|
no information available for the error.</p></li>
|
|||
|
|
<li><p><strong>start_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Time when the customization process has started inside the guest
|
|||
|
|
operating system. This attribute was added in vSphere API 7.0.0.0.
|
|||
|
|
This attribute will be None if the status is PENDING.</p></li>
|
|||
|
|
<li><p><strong>end_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Time when the customization process has completed inside the guest
|
|||
|
|
operating system. This attribute was added in vSphere API 7.0.0.0.
|
|||
|
|
This attribute will be None if the status is not SUCCEEDED or
|
|||
|
|
FAILED.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.Customization.Info.Status">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Status</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest_client.Customization.Info.Status" 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">Customization.Info.Status</span></code> class defines the status values that can
|
|||
|
|
be reported for the customization operation. This enumeration was added in
|
|||
|
|
vSphere API 7.0.0.0.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Status</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.Customization.Info.Status.FAILED">
|
|||
|
|
<code class="sig-name descname">FAILED</code><em class="property"> = Status(string='FAILED')</em><a class="headerlink" href="#com.vmware.vcenter.vm.guest_client.Customization.Info.Status.FAILED" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The customizatio process has failed inside the guest operating system. This
|
|||
|
|
class attribute was added in vSphere API 7.0.0.0.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.Customization.Info.Status.PENDING">
|
|||
|
|
<code class="sig-name descname">PENDING</code><em class="property"> = Status(string='PENDING')</em><a class="headerlink" href="#com.vmware.vcenter.vm.guest_client.Customization.Info.Status.PENDING" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The customization process has not yet started inside the guest operating
|
|||
|
|
system. This class attribute was added in vSphere API 7.0.0.0.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.Customization.Info.Status.RUNNING">
|
|||
|
|
<code class="sig-name descname">RUNNING</code><em class="property"> = Status(string='RUNNING')</em><a class="headerlink" href="#com.vmware.vcenter.vm.guest_client.Customization.Info.Status.RUNNING" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The customization process is currently running inside the guest operating
|
|||
|
|
system. This class attribute was added in vSphere API 7.0.0.0.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.Customization.Info.Status.SUCCEEDED">
|
|||
|
|
<code class="sig-name descname">SUCCEEDED</code><em class="property"> = Status(string='SUCCEEDED')</em><a class="headerlink" href="#com.vmware.vcenter.vm.guest_client.Customization.Info.Status.SUCCEEDED" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The customization process has completed successfully inside the guest
|
|||
|
|
operating system. This class attribute was added in vSphere API 7.0.0.0.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.Customization.SetSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">SetSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">spec</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest_client.Customization.SetSpec" 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">Customization.SetSpec</span></code> class contains specification information that
|
|||
|
|
has to be applied to a virtual machine. This class was added in vSphere API
|
|||
|
|
7.0.0.0.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The name of the customization specification that has be retrieved
|
|||
|
|
from the virtual center inventory and applied for the virtual
|
|||
|
|
machine. Either one of <code class="docutils literal notranslate"><span class="pre">name</span></code> or <code class="docutils literal notranslate"><span class="pre">spec</span></code> or none of them should
|
|||
|
|
be specified. This attribute was added in vSphere API 7.0.0.0.
|
|||
|
|
If None and <code class="docutils literal notranslate"><span class="pre">spec</span></code> is also None when executing
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.guest_client.Customization.set" title="com.vmware.vcenter.vm.guest_client.Customization.set"><code class="xref py py-func docutils literal notranslate"><span class="pre">Customization.set()</span></code></a> operationg, then any pending
|
|||
|
|
customization for the virtual machine will be cleared.</p></li>
|
|||
|
|
<li><p><strong>spec</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.guest_client.CustomizationSpec" title="com.vmware.vcenter.guest_client.CustomizationSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.guest_client.CustomizationSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The customization specification that has to be applied for the
|
|||
|
|
virtual machine. Either one of <code class="docutils literal notranslate"><span class="pre">name</span></code> or <code class="docutils literal notranslate"><span class="pre">spec</span></code> or none of them
|
|||
|
|
should be specified. This attribute was added in vSphere API
|
|||
|
|
7.0.0.0.
|
|||
|
|
If None and <code class="docutils literal notranslate"><span class="pre">name</span></code> is also None when executing
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.guest_client.Customization.set" title="com.vmware.vcenter.vm.guest_client.Customization.set"><code class="xref py py-func docutils literal notranslate"><span class="pre">Customization.set()</span></code></a> operationg, then any pending
|
|||
|
|
customization for the virtual machine will be cleared.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.Customization.set">
|
|||
|
|
<code class="sig-name descname">set</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></em>, <em class="sig-param"><span class="n">spec</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest_client.Customization.set" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Applies a customization specification in <code class="docutils literal notranslate"><span class="pre">spec</span></code> on the virtual
|
|||
|
|
machine in <code class="docutils literal notranslate"><span class="pre">vm</span></code>. This method only sets the specification settings for
|
|||
|
|
the virtual machine. The actual customization happens inside the guest
|
|||
|
|
when the virtual machine is powered on. If <code class="docutils literal notranslate"><span class="pre">spec</span></code> has None values,
|
|||
|
|
then any pending customization settings for the virtual machine are
|
|||
|
|
cleared. If there is a pending customization for the virtual machine
|
|||
|
|
and <code class="docutils literal notranslate"><span class="pre">spec</span></code> has valid content, then the existing customization setting
|
|||
|
|
will be overwritten with the new settings. This method was added in
|
|||
|
|
vSphere API 7.0.0.0.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The unique identifier of the virtual machine that needs to be
|
|||
|
|
customized.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p></li>
|
|||
|
|
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.guest_client.Customization.SetSpec" title="com.vmware.vcenter.vm.guest_client.Customization.SetSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Customization.SetSpec</span></code></a>) – The customization settings to be applied to the guest operating
|
|||
|
|
system.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if the customization settings in <code class="docutils literal notranslate"><span class="pre">spec</span></code> are not valid.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the virtual machine <code class="docutils literal notranslate"><span class="pre">vm</span></code> is not in a powered off state.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if a customization specification is not found with the unique name
|
|||
|
|
in <code class="docutils literal notranslate"><span class="pre">spec</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
If the virtual machine <code class="docutils literal notranslate"><span class="pre">vm</span></code> is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.DhcpConfigInfo">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm.guest_client.</code><code class="sig-name descname">DhcpConfigInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">ipv4_enabled</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">ipv6_enabled</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest_client.DhcpConfigInfo" 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">DhcpConfigInfo</span></code> class specifies when Dynamic Host Configuration
|
|||
|
|
Protocol is enabled. This class was added in vSphere API 7.0.0.0.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>ipv4_enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – True if IPv4 DHCP is enabled, false otherwise. This attribute was
|
|||
|
|
added in vSphere API 7.0.0.0.</p></li>
|
|||
|
|
<li><p><strong>ipv6_enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – True if IPv6 DHCP is enabled, false otherwise. This attribute was
|
|||
|
|
added in vSphere API 7.0.0.0.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.DnsAssignedValues">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm.guest_client.</code><code class="sig-name descname">DnsAssignedValues</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">host_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">domain_name</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest_client.DnsAssignedValues" 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 {\@name DnsAssignedValues) class describes values assigned by a
|
|||
|
|
Domain Name Server (DNS). This class was added in vSphere API 7.0.0.0.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>host_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The host name portion of DNS name. For example, “esx01” part of
|
|||
|
|
esx01.example.com. This attribute was added in vSphere API 7.0.0.0.</p></li>
|
|||
|
|
<li><p><strong>domain_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The domain name portion of the DNS name. “example.com” part of
|
|||
|
|
esx01.example.com. This attribute was added in vSphere API 7.0.0.0.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.DnsConfigInfo">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm.guest_client.</code><code class="sig-name descname">DnsConfigInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">ip_addresses</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">search_domains</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest_client.DnsConfigInfo" 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">DnsConfigInfo</span></code> class describes the configuration of RFC 1034 DNS
|
|||
|
|
settings. This class was added in vSphere API 7.0.0.0.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>ip_addresses</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The IP addresses of the DNS servers in order of use. IPv4 addresses
|
|||
|
|
are specified using dotted decimal notation. For example,
|
|||
|
|
“192.0.2.1”. IPv6 addresses are 128-bit addresses represented as
|
|||
|
|
eight fields of up to four hexadecimal digits. A colon separates
|
|||
|
|
each field (:). For example, 2001:DB8:101::230:6eff:fe04:d9ff. The
|
|||
|
|
address can also consist of the symbol ‘::’ to represent multiple
|
|||
|
|
16-bit groups of contiguous 0’s only once in an address as
|
|||
|
|
described in RFC 2373. This attribute was added in vSphere API
|
|||
|
|
7.0.0.0.</p></li>
|
|||
|
|
<li><p><strong>search_domains</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The domain in which to search for hosts, placed in order of
|
|||
|
|
preference. These are the domain name portion of the DNS names.
|
|||
|
|
This attribute was added in vSphere API 7.0.0.0.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.Identity">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm.guest_client.</code><code class="sig-name descname">Identity</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></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="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.Identity.Info">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">family</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">full_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">host_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">ip_address</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>name</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.vm_client.GuestOS" title="com.vmware.vcenter.vm_client.GuestOS"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm_client.GuestOS</span></code></a>) – Guest operating system identifier (short name). This attribute was
|
|||
|
|
added in vSphere API 6.7.</p></li>
|
|||
|
|
<li><p><strong>family</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.vm_client.GuestOSFamily" title="com.vmware.vcenter.vm_client.GuestOSFamily"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm_client.GuestOSFamily</span></code></a>) – Guest operating system family. This attribute was added in vSphere
|
|||
|
|
API 6.7.</p></li>
|
|||
|
|
<li><p><strong>full_name</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Guest operating system full name. This attribute was added in
|
|||
|
|
vSphere API 6.7.</p></li>
|
|||
|
|
<li><p><strong>host_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Hostname of the guest operating system. This attribute was added in
|
|||
|
|
vSphere API 6.7.</p></li>
|
|||
|
|
<li><p><strong>ip_address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – IP address assigned by the guest operating system. This attribute
|
|||
|
|
was added in vSphere API 6.7.
|
|||
|
|
If None the guest does not have an IP address.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.Identity.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><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>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><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></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>guest identification information.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if VMware Tools is not running.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if VMware Tools has not provided any data.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.LocalFilesystem">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm.guest_client.</code><code class="sig-name descname">LocalFilesystem</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></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="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.LocalFilesystem.Info">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">capacity</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">free_space</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">filesystem</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">mappings</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>capacity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Total capacity of the file system, in bytes. This attribute was
|
|||
|
|
added in vSphere API 6.7.</p></li>
|
|||
|
|
<li><p><strong>free_space</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Free space on the file system, in bytes. This attribute was added
|
|||
|
|
in vSphere API 6.7.</p></li>
|
|||
|
|
<li><p><strong>filesystem</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Filesystem type, if known. For example, ext3 or NTFS. This
|
|||
|
|
attribute was added in vSphere API 7.0.0.0.
|
|||
|
|
<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if VMware Tools reports a value.</p></li>
|
|||
|
|
<li><p><strong>mappings</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.vm.guest_client.LocalFilesystem.VirtualDiskMapping" title="com.vmware.vcenter.vm.guest_client.LocalFilesystem.VirtualDiskMapping"><code class="xref py py-class docutils literal notranslate"><span class="pre">LocalFilesystem.VirtualDiskMapping</span></code></a>) – VirtualDisks backing the guest partition, if known. This attribute
|
|||
|
|
was added in vSphere API 7.0.0.0.
|
|||
|
|
This attribute is optional because it was added in a newer version
|
|||
|
|
than its parent node.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.LocalFilesystem.VirtualDiskMapping">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">VirtualDiskMapping</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">disk</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest_client.LocalFilesystem.VirtualDiskMapping" 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>Describes the virtual disk backing a local guest disk. This class was added
|
|||
|
|
in vSphere API 7.0.0.0.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>disk</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The virtual disk. This attribute was added in vSphere API 7.0.0.0.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>. When methods return a
|
|||
|
|
value of this class as a return value, the attribute will be an
|
|||
|
|
identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.LocalFilesystem.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><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>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><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></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>Information about the local file systems configured in the guest
|
|||
|
|
operating system.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if VMware Tools is not running.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if VMware Tools has not provided any data.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.Networking">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm.guest_client.</code><code class="sig-name descname">Networking</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest_client.Networking" 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">Networking</span></code> class provides methods for retrieving guest operating
|
|||
|
|
system network information. This class was added in vSphere API 7.0.0.0.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.Networking.Info">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">dns_values</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">dns</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest_client.Networking.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">Networking.Info</span></code> class contains information about networking as
|
|||
|
|
configured in the guest operating system. This class was added in vSphere
|
|||
|
|
API 7.0.0.0.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>dns_values</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.guest_client.DnsAssignedValues" title="com.vmware.vcenter.vm.guest_client.DnsAssignedValues"><code class="xref py py-class docutils literal notranslate"><span class="pre">DnsAssignedValues</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Client DNS values. Data assigned by DNS. This attribute was added
|
|||
|
|
in vSphere API 7.0.0.0.
|
|||
|
|
If None no DNS assigned value exists.</p></li>
|
|||
|
|
<li><p><strong>dns</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.guest_client.DnsConfigInfo" title="com.vmware.vcenter.vm.guest_client.DnsConfigInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">DnsConfigInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Client DNS configuration. How DNS queries are resolved. This
|
|||
|
|
attribute was added in vSphere API 7.0.0.0.
|
|||
|
|
If None no DNS assigned value exists.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.Networking.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.guest_client.Networking.get" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Returns information about the network configuration in the guest
|
|||
|
|
operating system. This method was added in vSphere API 7.0.0.0.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine ID
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.vm.guest_client.Networking.Info" title="com.vmware.vcenter.vm.guest_client.Networking.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Networking.Info</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>Information about the networking configuration in the guest
|
|||
|
|
operating system.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if VMware Tools is not running.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.Power">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm.guest_client.</code><code class="sig-name descname">Power</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></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="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.Power.Info">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">state</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">operations_ready</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>state</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.guest_client.Power.State" title="com.vmware.vcenter.vm.guest_client.Power.State"><code class="xref py py-class docutils literal notranslate"><span class="pre">Power.State</span></code></a>) – The power state of the guest operating system. This attribute was
|
|||
|
|
added in vSphere API 6.7.</p></li>
|
|||
|
|
<li><p><strong>operations_ready</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag indicating if the virtual machine is ready to process soft
|
|||
|
|
power operations. This attribute was added in vSphere API 6.7.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.Power.State">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">State</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></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="admonition-title">Note</p>
|
|||
|
|
<p>This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">State</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.Power.State.NOT_RUNNING">
|
|||
|
|
<code class="sig-name 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="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.Power.State.RESETTING">
|
|||
|
|
<code class="sig-name 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="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.Power.State.RUNNING">
|
|||
|
|
<code class="sig-name 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="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.Power.State.SHUTTING_DOWN">
|
|||
|
|
<code class="sig-name 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="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.Power.State.STANDBY">
|
|||
|
|
<code class="sig-name 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="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.Power.State.UNAVAILABLE">
|
|||
|
|
<code class="sig-name 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="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.Power.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><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>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><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></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>Guest OS powerstate information.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.Power.reboot">
|
|||
|
|
<code class="sig-name descname">reboot</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><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>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the virtual machine is not powered on.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if VMware Tools is not running.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the virtual machine is performing another operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
|||
|
|
if the virtual machine does not support being powered on (e.g.
|
|||
|
|
marked as a template, serving as a fault-tolerance secondary
|
|||
|
|
virtual machine).</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.Power.shutdown">
|
|||
|
|
<code class="sig-name descname">shutdown</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><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>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyInDesiredState" title="com.vmware.vapi.std.errors_client.AlreadyInDesiredState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code></a>
|
|||
|
|
if the virtual machine is not powered on.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if VMware Tools is not running.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the virtual machine is suspended.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the virtual machine is performing another operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
|||
|
|
if the virtual machine does not support being powered on (e.g.
|
|||
|
|
marked as a template, serving as a fault-tolerance secondary
|
|||
|
|
virtual machine).</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.Power.standby">
|
|||
|
|
<code class="sig-name descname">standby</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><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>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyInDesiredState" title="com.vmware.vapi.std.errors_client.AlreadyInDesiredState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code></a>
|
|||
|
|
if the virtual machine is suspended.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if VMware Tools is not running.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the virtual machine is not powered on.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the virtual machine is performing another operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
|||
|
|
if the virtual machine does not support being powered on (e.g.
|
|||
|
|
marked as a template, serving as a fault-tolerance secondary
|
|||
|
|
virtual machine).</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.guest_client.StubFactory">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm.guest_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></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>
|
|||
|
|
<p>Initialize StubFactoryBase</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</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="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Boot">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm.hardware_client.</code><code class="sig-name descname">Boot</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></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="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Boot.CreateSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">CreateSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">efi_legacy_boot</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">network_protocol</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">delay</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">retry</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">retry_delay</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">enter_setup_mode</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Boot.Type" title="com.vmware.vcenter.vm.hardware_client.Boot.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Boot.Type</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Firmware type to be used by the virtual machine.
|
|||
|
|
If None, defaults to value that is recommended for the guest OS and
|
|||
|
|
is supported for the virtual hardware version.</p></li>
|
|||
|
|
<li><p><strong>efi_legacy_boot</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag indicating whether to use EFI legacy boot mode.
|
|||
|
|
If None, defaults to value that is recommended for the guest OS and
|
|||
|
|
is supported for the virtual hardware version.</p></li>
|
|||
|
|
<li><p><strong>network_protocol</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Boot.NetworkProtocol" title="com.vmware.vcenter.vm.hardware_client.Boot.NetworkProtocol"><code class="xref py py-class docutils literal notranslate"><span class="pre">Boot.NetworkProtocol</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Protocol to use when attempting to boot the virtual machine over
|
|||
|
|
the network.
|
|||
|
|
If None, defaults to a system defined default value.</p></li>
|
|||
|
|
<li><p><strong>delay</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Delay in milliseconds before beginning the firmware boot process
|
|||
|
|
when the virtual machine is powered on. This delay may be used to
|
|||
|
|
provide a time window for users to connect to the virtual machine
|
|||
|
|
console and enter BIOS setup mode.
|
|||
|
|
If None, default value is 0.</p></li>
|
|||
|
|
<li><p><strong>retry</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag indicating whether the virtual machine should automatically
|
|||
|
|
retry the boot process after a failure.
|
|||
|
|
If None, default value is false.</p></li>
|
|||
|
|
<li><p><strong>retry_delay</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Delay in milliseconds before retrying the boot process after a
|
|||
|
|
failure; applicable only when <code class="xref py py-attr docutils literal notranslate"><span class="pre">Boot.Info.retry</span></code> is true.
|
|||
|
|
If None, default value is 10000.</p></li>
|
|||
|
|
<li><p><strong>enter_setup_mode</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag indicating whether the firmware boot process should
|
|||
|
|
automatically enter setup mode the next time the virtual machine
|
|||
|
|
boots. Note that this flag will automatically be reset to false
|
|||
|
|
once the virtual machine enters setup mode.
|
|||
|
|
If None, the value is unchanged.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Boot.Info">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">efi_legacy_boot</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">network_protocol</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">delay</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">retry</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">retry_delay</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">enter_setup_mode</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Boot.Type" title="com.vmware.vcenter.vm.hardware_client.Boot.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Boot.Type</span></code></a>) – Firmware type used by the virtual machine.</p></li>
|
|||
|
|
<li><p><strong>efi_legacy_boot</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag indicating whether to use EFI legacy boot mode.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Boot.Type.EFI" title="com.vmware.vcenter.vm.hardware_client.Boot.Type.EFI"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Boot.Type.EFI</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>network_protocol</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Boot.NetworkProtocol" title="com.vmware.vcenter.vm.hardware_client.Boot.NetworkProtocol"><code class="xref py py-class docutils literal notranslate"><span class="pre">Boot.NetworkProtocol</span></code></a>) – Protocol to use when attempting to boot the virtual machine over
|
|||
|
|
the network.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Boot.Type.EFI" title="com.vmware.vcenter.vm.hardware_client.Boot.Type.EFI"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Boot.Type.EFI</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>delay</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Delay in milliseconds before beginning the firmware boot process
|
|||
|
|
when the virtual machine is powered on. This delay may be used to
|
|||
|
|
provide a time window for users to connect to the virtual machine
|
|||
|
|
console and enter BIOS setup mode.</p></li>
|
|||
|
|
<li><p><strong>retry</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag indicating whether the virtual machine will automatically
|
|||
|
|
retry the boot process after a failure.</p></li>
|
|||
|
|
<li><p><strong>retry_delay</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Delay in milliseconds before retrying the boot process after a
|
|||
|
|
failure; applicable only when <code class="xref py py-attr docutils literal notranslate"><span class="pre">Boot.Info.retry</span></code> is true.</p></li>
|
|||
|
|
<li><p><strong>enter_setup_mode</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag indicating whether the firmware boot process will
|
|||
|
|
automatically enter setup mode the next time the virtual machine
|
|||
|
|
boots. Note that this flag will automatically be reset to false
|
|||
|
|
once the virtual machine enters setup mode.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Boot.NetworkProtocol">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">NetworkProtocol</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></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="admonition-title">Note</p>
|
|||
|
|
<p>This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">NetworkProtocol</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Boot.NetworkProtocol.IPV4">
|
|||
|
|
<code class="sig-name 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="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Boot.NetworkProtocol.IPV6">
|
|||
|
|
<code class="sig-name 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="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Boot.Type">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Type</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></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="admonition-title">Note</p>
|
|||
|
|
<p>This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Boot.Type.BIOS">
|
|||
|
|
<code class="sig-name 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="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Boot.Type.EFI">
|
|||
|
|
<code class="sig-name 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="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Boot.UpdateSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">UpdateSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">efi_legacy_boot</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">network_protocol</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">delay</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">retry</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">retry_delay</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">enter_setup_mode</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Boot.Type" title="com.vmware.vcenter.vm.hardware_client.Boot.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Boot.Type</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Firmware type to be used by the virtual machine.
|
|||
|
|
If None, the value is unchanged.</p></li>
|
|||
|
|
<li><p><strong>efi_legacy_boot</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag indicating whether to use EFI legacy boot mode.
|
|||
|
|
If None, the value is unchanged.</p></li>
|
|||
|
|
<li><p><strong>network_protocol</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Boot.NetworkProtocol" title="com.vmware.vcenter.vm.hardware_client.Boot.NetworkProtocol"><code class="xref py py-class docutils literal notranslate"><span class="pre">Boot.NetworkProtocol</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Protocol to use when attempting to boot the virtual machine over
|
|||
|
|
the network.
|
|||
|
|
If None, the value is unchanged.</p></li>
|
|||
|
|
<li><p><strong>delay</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Delay in milliseconds before beginning the firmware boot process
|
|||
|
|
when the virtual machine is powered on. This delay may be used to
|
|||
|
|
provide a time window for users to connect to the virtual machine
|
|||
|
|
console and enter BIOS setup mode.
|
|||
|
|
If None, the value is unchanged.</p></li>
|
|||
|
|
<li><p><strong>retry</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag indicating whether the virtual machine should automatically
|
|||
|
|
retry the boot process after a failure.
|
|||
|
|
If None, the value is unchanged.</p></li>
|
|||
|
|
<li><p><strong>retry_delay</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Delay in milliseconds before retrying the boot process after a
|
|||
|
|
failure; applicable only when <code class="xref py py-attr docutils literal notranslate"><span class="pre">Boot.Info.retry</span></code> is true.
|
|||
|
|
If None, the value is unchanged.</p></li>
|
|||
|
|
<li><p><strong>enter_setup_mode</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag indicating whether the firmware boot process should
|
|||
|
|
automatically enter setup mode the next time the virtual machine
|
|||
|
|
boots. Note that this flag will automatically be reset to false
|
|||
|
|
once the virtual machine enters setup mode.
|
|||
|
|
If None, the value is unchanged.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Boot.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><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>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><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></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>Boot-related settings of the virtual machine.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Boot.update">
|
|||
|
|
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></em>, <em class="sig-param"><span class="n">spec</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
<li><p><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.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
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>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the virtual machine is busy performing another operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm.hardware_client.</code><code class="sig-name descname">Cdrom</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></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="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingInfo">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">BackingInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">iso_file</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">host_device</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">auto_detect</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">device_access_type</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType" title="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cdrom.BackingType</span></code></a>) – Backing type for the virtual CD-ROM device.</p></li>
|
|||
|
|
<li><p><strong>iso_file</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Path of the image file backing the virtual CD-ROM device.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType.ISO_FILE" title="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType.ISO_FILE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Cdrom.BackingType.ISO_FILE</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>host_device</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Name of the host device backing the virtual CD-ROM device.
|
|||
|
|
This attribute will be None if <code class="docutils literal notranslate"><span class="pre">autoDetect</span></code> is true and the
|
|||
|
|
virtual CD-ROM device is not connected or no suitable device is
|
|||
|
|
available on the host.</p></li>
|
|||
|
|
<li><p><strong>auto_detect</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag indicating whether the virtual CD-ROM device is configured to
|
|||
|
|
automatically detect a suitable host device.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType.HOST_DEVICE" title="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType.HOST_DEVICE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Cdrom.BackingType.HOST_DEVICE</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>device_access_type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.DeviceAccessType" title="com.vmware.vcenter.vm.hardware_client.Cdrom.DeviceAccessType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cdrom.DeviceAccessType</span></code></a>) – Access type for the device backing.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is one of <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType.HOST_DEVICE" title="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType.HOST_DEVICE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Cdrom.BackingType.HOST_DEVICE</span></code></a> or
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType.CLIENT_DEVICE" title="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType.CLIENT_DEVICE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Cdrom.BackingType.CLIENT_DEVICE</span></code></a>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">BackingSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">iso_file</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">host_device</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">device_access_type</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType" title="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cdrom.BackingType</span></code></a>) – Backing type for the virtual CD-ROM device.</p></li>
|
|||
|
|
<li><p><strong>iso_file</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Path of the image file that should be used as the virtual CD-ROM
|
|||
|
|
device backing.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType.ISO_FILE" title="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType.ISO_FILE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Cdrom.BackingType.ISO_FILE</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>host_device</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Name of the device that should be used as the virtual CD-ROM device
|
|||
|
|
backing.
|
|||
|
|
If None, the virtual CD-ROM device will be configured to
|
|||
|
|
automatically detect a suitable host device.</p></li>
|
|||
|
|
<li><p><strong>device_access_type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.DeviceAccessType" title="com.vmware.vcenter.vm.hardware_client.Cdrom.DeviceAccessType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cdrom.DeviceAccessType</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Access type for the device backing.
|
|||
|
|
If None, defaults to <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.DeviceAccessType.EMULATION" title="com.vmware.vcenter.vm.hardware_client.Cdrom.DeviceAccessType.EMULATION"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Cdrom.DeviceAccessType.EMULATION</span></code></a>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">BackingType</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></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="admonition-title">Note</p>
|
|||
|
|
<p>This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">BackingType</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType.CLIENT_DEVICE">
|
|||
|
|
<code class="sig-name 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="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType.HOST_DEVICE">
|
|||
|
|
<code class="sig-name 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="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingType.ISO_FILE">
|
|||
|
|
<code class="sig-name 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="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.CreateSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">CreateSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">ide</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sata</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">backing</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">start_connected</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">allow_guest_control</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.HostBusAdapterType" title="com.vmware.vcenter.vm.hardware_client.Cdrom.HostBusAdapterType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cdrom.HostBusAdapterType</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Type of host bus adapter to which the device should be attached.
|
|||
|
|
If None, guest-specific default values will be used</p></li>
|
|||
|
|
<li><p><strong>ide</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.IdeAddressSpec" title="com.vmware.vcenter.vm.hardware_client.IdeAddressSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">IdeAddressSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Address for attaching the device to a virtual IDE adapter.
|
|||
|
|
If None, the server will choose an available address; if none is
|
|||
|
|
available, the request will fail.</p></li>
|
|||
|
|
<li><p><strong>sata</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.SataAddressSpec" title="com.vmware.vcenter.vm.hardware_client.SataAddressSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">SataAddressSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Address for attaching the device to a virtual SATA adapter.
|
|||
|
|
If None, the server will choose an available address; if none is
|
|||
|
|
available, the request will fail.</p></li>
|
|||
|
|
<li><p><strong>backing</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingSpec" title="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cdrom.BackingSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Physical resource backing for the virtual CD-ROM device.
|
|||
|
|
If None, defaults to automatic detection of a suitable host device.</p></li>
|
|||
|
|
<li><p><strong>start_connected</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag indicating whether the virtual device should be connected
|
|||
|
|
whenever the virtual machine is powered on.
|
|||
|
|
Defaults to false if None.</p></li>
|
|||
|
|
<li><p><strong>allow_guest_control</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag indicating whether the guest can connect and disconnect the
|
|||
|
|
device.
|
|||
|
|
Defaults to false if None.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.DeviceAccessType">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">DeviceAccessType</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></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="admonition-title">Note</p>
|
|||
|
|
<p>This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">DeviceAccessType</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.DeviceAccessType.EMULATION">
|
|||
|
|
<code class="sig-name 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="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.DeviceAccessType.PASSTHRU">
|
|||
|
|
<code class="sig-name 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="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.DeviceAccessType.PASSTHRU_EXCLUSIVE">
|
|||
|
|
<code class="sig-name 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="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.HostBusAdapterType">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">HostBusAdapterType</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></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="admonition-title">Note</p>
|
|||
|
|
<p>This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">HostBusAdapterType</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.HostBusAdapterType.IDE">
|
|||
|
|
<code class="sig-name 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="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.HostBusAdapterType.SATA">
|
|||
|
|
<code class="sig-name 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="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.Info">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">label</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">ide</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sata</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">backing</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">state</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">start_connected</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">allow_guest_control</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.HostBusAdapterType" title="com.vmware.vcenter.vm.hardware_client.Cdrom.HostBusAdapterType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cdrom.HostBusAdapterType</span></code></a>) – Type of host bus adapter to which the device is attached.</p></li>
|
|||
|
|
<li><p><strong>label</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Device label.</p></li>
|
|||
|
|
<li><p><strong>ide</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.IdeAddressInfo" title="com.vmware.vcenter.vm.hardware_client.IdeAddressInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">IdeAddressInfo</span></code></a>) – Address of device attached to a virtual IDE adapter.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.HostBusAdapterType.IDE" title="com.vmware.vcenter.vm.hardware_client.Cdrom.HostBusAdapterType.IDE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Cdrom.HostBusAdapterType.IDE</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>sata</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.SataAddressInfo" title="com.vmware.vcenter.vm.hardware_client.SataAddressInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">SataAddressInfo</span></code></a>) – Address of device attached to a virtual SATA adapter.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.HostBusAdapterType.SATA" title="com.vmware.vcenter.vm.hardware_client.Cdrom.HostBusAdapterType.SATA"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Cdrom.HostBusAdapterType.SATA</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>backing</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingInfo" title="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cdrom.BackingInfo</span></code></a>) – Physical resource backing for the virtual CD-ROM device.</p></li>
|
|||
|
|
<li><p><strong>state</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.ConnectionState" title="com.vmware.vcenter.vm.hardware_client.ConnectionState"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConnectionState</span></code></a>) – Connection status of the virtual device.</p></li>
|
|||
|
|
<li><p><strong>start_connected</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag indicating whether the virtual device should be connected
|
|||
|
|
whenever the virtual machine is powered on.</p></li>
|
|||
|
|
<li><p><strong>allow_guest_control</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag indicating whether the guest can connect and disconnect the
|
|||
|
|
device.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.RESOURCE_TYPE">
|
|||
|
|
<code class="sig-name 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="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.Summary">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cdrom</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>cdrom</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the virtual CD-ROM device.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Cdrom</span></code>. When methods return a
|
|||
|
|
value of this class as a return value, the attribute 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>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.UpdateSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">UpdateSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">backing</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">start_connected</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">allow_guest_control</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>backing</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Cdrom.BackingSpec" title="com.vmware.vcenter.vm.hardware_client.Cdrom.BackingSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cdrom.BackingSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Physical resource backing for the virtual CD-ROM device.</p>
|
|||
|
|
<p>This attribute may only be modified if the virtual machine is not
|
|||
|
|
powered on or the virtual CD-ROM device is not connected.
|
|||
|
|
If None, the value is unchanged.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>start_connected</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag indicating whether the virtual device should be connected
|
|||
|
|
whenever the virtual machine is powered on.
|
|||
|
|
If None, the value is unchanged.</p></li>
|
|||
|
|
<li><p><strong>allow_guest_control</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag indicating whether the guest can connect and disconnect the
|
|||
|
|
device.
|
|||
|
|
If None, the value is unchanged.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.connect">
|
|||
|
|
<code class="sig-name descname">connect</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></em>, <em class="sig-param"><span class="n">cdrom</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine or virtual CD-ROM device is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyInDesiredState" title="com.vmware.vapi.std.errors_client.AlreadyInDesiredState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code></a>
|
|||
|
|
if the virtual CD-ROM device is already connected.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the virtual machine is not powered on.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the virtual machine is busy performing another operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.create">
|
|||
|
|
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></em>, <em class="sig-param"><span class="n">spec</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
<li><p><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.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>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>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
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>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the virtual machine is suspended or if the virtual machine is
|
|||
|
|
powered on and virtual CD-ROM type is IDE.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnableToAllocateResource" title="com.vmware.vapi.std.errors_client.UnableToAllocateResource"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code></a>
|
|||
|
|
if the specified storage address is unavailable; for example, if
|
|||
|
|
the SCSI adapter requested does not exist.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInUse" title="com.vmware.vapi.std.errors_client.ResourceInUse"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInUse</span></code></a>
|
|||
|
|
if the specified storage address is in use.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if the specified storage address is out of bounds.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the virtual machine is busy performing another operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
|||
|
|
if the guest operating system of the virtual machine is not
|
|||
|
|
supported and spec includes None attributes that default to
|
|||
|
|
guest-specific values.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.delete">
|
|||
|
|
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></em>, <em class="sig-param"><span class="n">cdrom</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine or virtual CD-ROM device is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the virtual machine is suspended or if the virtual machine is
|
|||
|
|
powered on and virtual CD-ROM type is IDE.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the virtual machine is busy performing another operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.disconnect">
|
|||
|
|
<code class="sig-name descname">disconnect</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></em>, <em class="sig-param"><span class="n">cdrom</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine or virtual CD-ROM device is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyInDesiredState" title="com.vmware.vapi.std.errors_client.AlreadyInDesiredState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code></a>
|
|||
|
|
if the virtual CD-ROM device is already disconnected.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the virtual machine is not powered on.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the virtual machine is busy performing another operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></em>, <em class="sig-param"><span class="n">cdrom</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><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>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>Information about the specified virtual CD-ROM device.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine or virtual CD-ROM device is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.list">
|
|||
|
|
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><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>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><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></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>List of commonly used information about virtual CD-ROM devices.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cdrom.update">
|
|||
|
|
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></em>, <em class="sig-param"><span class="n">cdrom</span></em>, <em class="sig-param"><span class="n">spec</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
<li><p><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.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine or virtual CD-ROM device is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
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>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the virtual machine is busy performing another operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.ConnectionCreateSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm.hardware_client.</code><code class="sig-name descname">ConnectionCreateSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">start_connected</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">allow_guest_control</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>start_connected</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag indicating whether the virtual device should be connected
|
|||
|
|
whenever the virtual machine is powered on.
|
|||
|
|
Defaults to false if None.</p></li>
|
|||
|
|
<li><p><strong>allow_guest_control</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag indicating whether the guest can connect and disconnect the
|
|||
|
|
device.
|
|||
|
|
Defaults to false if None.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.ConnectionInfo">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm.hardware_client.</code><code class="sig-name descname">ConnectionInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">state</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">start_connected</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">allow_guest_control</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>state</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.ConnectionState" title="com.vmware.vcenter.vm.hardware_client.ConnectionState"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConnectionState</span></code></a>) – Connection status of the virtual device.</p></li>
|
|||
|
|
<li><p><strong>start_connected</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag indicating whether the virtual device should be connected
|
|||
|
|
whenever the virtual machine is powered on.</p></li>
|
|||
|
|
<li><p><strong>allow_guest_control</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag indicating whether the guest can connect and disconnect the
|
|||
|
|
device.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.ConnectionState">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm.hardware_client.</code><code class="sig-name descname">ConnectionState</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></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="admonition-title">Note</p>
|
|||
|
|
<p>This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.ConnectionState" title="com.vmware.vcenter.vm.hardware_client.ConnectionState"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConnectionState</span></code></a> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.ConnectionState.CONNECTED">
|
|||
|
|
<code class="sig-name 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="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.ConnectionState.NOT_CONNECTED">
|
|||
|
|
<code class="sig-name 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="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.ConnectionState.RECOVERABLE_ERROR">
|
|||
|
|
<code class="sig-name 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="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.ConnectionState.UNKNOWN">
|
|||
|
|
<code class="sig-name 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="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.ConnectionState.UNRECOVERABLE_ERROR">
|
|||
|
|
<code class="sig-name 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="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.ConnectionUpdateSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm.hardware_client.</code><code class="sig-name descname">ConnectionUpdateSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">start_connected</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">allow_guest_control</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>start_connected</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag indicating whether the virtual device should be connected
|
|||
|
|
whenever the virtual machine is powered on.
|
|||
|
|
If None, the value is unchanged.</p></li>
|
|||
|
|
<li><p><strong>allow_guest_control</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag indicating whether the guest can connect and disconnect the
|
|||
|
|
device.
|
|||
|
|
If None, the value is unchanged.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cpu">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm.hardware_client.</code><code class="sig-name descname">Cpu</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></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="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cpu.Info">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">count</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cores_per_socket</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">hot_add_enabled</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">hot_remove_enabled</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Number of CPU cores.</p></li>
|
|||
|
|
<li><p><strong>cores_per_socket</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Number of CPU cores per socket.</p></li>
|
|||
|
|
<li><p><strong>hot_add_enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag indicating whether adding CPUs while the virtual machine is
|
|||
|
|
running is enabled.</p></li>
|
|||
|
|
<li><p><strong>hot_remove_enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag indicating whether removing CPUs while the virtual machine is
|
|||
|
|
running is enabled.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cpu.UpdateSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">UpdateSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">count</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cores_per_socket</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">hot_add_enabled</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">hot_remove_enabled</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>New number of CPU cores. The number of CPU cores in the virtual
|
|||
|
|
machine must be a multiple of the number of cores per socket.</p>
|
|||
|
|
<p>The supported range of CPU counts is constrained by the configured
|
|||
|
|
guest operating system and virtual hardware version of the virtual
|
|||
|
|
machine.</p>
|
|||
|
|
<p>If the virtual machine is running, the number of CPU cores may only
|
|||
|
|
be increased if <code class="xref py py-attr docutils literal notranslate"><span class="pre">Cpu.Info.hot_add_enabled</span></code> is true, and may
|
|||
|
|
only be decreased if <code class="xref py py-attr docutils literal notranslate"><span class="pre">Cpu.Info.hot_remove_enabled</span></code> is true.
|
|||
|
|
If None, the value is unchanged.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>cores_per_socket</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – New number of CPU cores per socket. The number of CPU cores in the
|
|||
|
|
virtual machine must be a multiple of the number of cores per
|
|||
|
|
socket.
|
|||
|
|
If None, the value is unchanged.</p></li>
|
|||
|
|
<li><p><strong>hot_add_enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Flag indicating whether adding CPUs while the virtual machine is
|
|||
|
|
running is enabled.</p>
|
|||
|
|
<p>This attribute may only be modified if the virtual machine is
|
|||
|
|
powered off.
|
|||
|
|
If None, the value is unchanged.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>hot_remove_enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Flag indicating whether removing CPUs while the virtual machine is
|
|||
|
|
running is enabled.</p>
|
|||
|
|
<p>This attribute may only be modified if the virtual machine is
|
|||
|
|
powered off.
|
|||
|
|
If None, the value is unchanged.</p>
|
|||
|
|
</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cpu.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><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>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><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></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>CPU-related settings of the virtual machine.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Cpu.update">
|
|||
|
|
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></em>, <em class="sig-param"><span class="n">spec</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
<li><p><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.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
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>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
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>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
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>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
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>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the virtual machine is busy performing another operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm.hardware_client.</code><code class="sig-name descname">Disk</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></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="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.BackingInfo">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">BackingInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">vmdk_file</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Disk.BackingType" title="com.vmware.vcenter.vm.hardware_client.Disk.BackingType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Disk.BackingType</span></code></a>) – Backing type for the virtual disk.</p></li>
|
|||
|
|
<li><p><strong>vmdk_file</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Path of the VMDK file backing the virtual disk.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Disk.BackingType.VMDK_FILE" title="com.vmware.vcenter.vm.hardware_client.Disk.BackingType.VMDK_FILE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Disk.BackingType.VMDK_FILE</span></code></a>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.BackingSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">BackingSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">vmdk_file</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Disk.BackingType" title="com.vmware.vcenter.vm.hardware_client.Disk.BackingType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Disk.BackingType</span></code></a>) – Backing type for the virtual disk.</p></li>
|
|||
|
|
<li><p><strong>vmdk_file</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Path of the VMDK file backing the virtual disk.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Disk.BackingType.VMDK_FILE" title="com.vmware.vcenter.vm.hardware_client.Disk.BackingType.VMDK_FILE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Disk.BackingType.VMDK_FILE</span></code></a>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.BackingType">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">BackingType</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></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="admonition-title">Note</p>
|
|||
|
|
<p>This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">BackingType</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.BackingType.VMDK_FILE">
|
|||
|
|
<code class="sig-name 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="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.CreateSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">CreateSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">ide</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">scsi</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sata</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">backing</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">new_vmdk</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Disk.HostBusAdapterType" title="com.vmware.vcenter.vm.hardware_client.Disk.HostBusAdapterType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Disk.HostBusAdapterType</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Type of host bus adapter to which the device should be attached.
|
|||
|
|
If None, guest-specific default values will be used</p></li>
|
|||
|
|
<li><p><strong>ide</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.IdeAddressSpec" title="com.vmware.vcenter.vm.hardware_client.IdeAddressSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">IdeAddressSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Address for attaching the device to a virtual IDE adapter.
|
|||
|
|
If None, the server will choose an available address; if none is
|
|||
|
|
available, the request will fail.</p></li>
|
|||
|
|
<li><p><strong>scsi</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.ScsiAddressSpec" title="com.vmware.vcenter.vm.hardware_client.ScsiAddressSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ScsiAddressSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Address for attaching the device to a virtual SCSI adapter.
|
|||
|
|
If None, the server will choose an available address; if none is
|
|||
|
|
available, the request will fail.</p></li>
|
|||
|
|
<li><p><strong>sata</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.SataAddressSpec" title="com.vmware.vcenter.vm.hardware_client.SataAddressSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">SataAddressSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Address for attaching the device to a virtual SATA adapter.
|
|||
|
|
If None, the server will choose an available address; if none is
|
|||
|
|
available, the request will fail.</p></li>
|
|||
|
|
<li><p><strong>backing</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Disk.BackingSpec" title="com.vmware.vcenter.vm.hardware_client.Disk.BackingSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Disk.BackingSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Existing physical resource backing for the virtual disk. Exactly
|
|||
|
|
one of <code class="docutils literal notranslate"><span class="pre">backing</span></code> or <code class="docutils literal notranslate"><span class="pre">newVmdk</span></code> must be specified.
|
|||
|
|
If None, the virtual disk will not be connected to an existing
|
|||
|
|
backing.</p></li>
|
|||
|
|
<li><p><strong>new_vmdk</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Disk.VmdkCreateSpec" title="com.vmware.vcenter.vm.hardware_client.Disk.VmdkCreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Disk.VmdkCreateSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Specification for creating a new VMDK backing for the virtual disk.
|
|||
|
|
Exactly one of <code class="docutils literal notranslate"><span class="pre">backing</span></code> or <code class="docutils literal notranslate"><span class="pre">newVmdk</span></code> must be specified.
|
|||
|
|
If None, a new VMDK backing will not be created.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.HostBusAdapterType">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">HostBusAdapterType</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></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="admonition-title">Note</p>
|
|||
|
|
<p>This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">HostBusAdapterType</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.HostBusAdapterType.IDE">
|
|||
|
|
<code class="sig-name 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="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.HostBusAdapterType.SATA">
|
|||
|
|
<code class="sig-name 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="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.HostBusAdapterType.SCSI">
|
|||
|
|
<code class="sig-name 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="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.Info">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">label</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">ide</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">scsi</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sata</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">backing</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">capacity</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>label</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Device label.</p></li>
|
|||
|
|
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Disk.HostBusAdapterType" title="com.vmware.vcenter.vm.hardware_client.Disk.HostBusAdapterType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Disk.HostBusAdapterType</span></code></a>) – Type of host bus adapter to which the device is attached.</p></li>
|
|||
|
|
<li><p><strong>ide</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.IdeAddressInfo" title="com.vmware.vcenter.vm.hardware_client.IdeAddressInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">IdeAddressInfo</span></code></a>) – Address of device attached to a virtual IDE adapter.
|
|||
|
|
Workaround for PR1459646</p></li>
|
|||
|
|
<li><p><strong>scsi</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.ScsiAddressInfo" title="com.vmware.vcenter.vm.hardware_client.ScsiAddressInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ScsiAddressInfo</span></code></a>) – Address of device attached to a virtual SCSI adapter.
|
|||
|
|
Workaround for PR1459646</p></li>
|
|||
|
|
<li><p><strong>sata</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.SataAddressInfo" title="com.vmware.vcenter.vm.hardware_client.SataAddressInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">SataAddressInfo</span></code></a>) – Address of device attached to a virtual SATA adapter.
|
|||
|
|
Workaround for PR1459646</p></li>
|
|||
|
|
<li><p><strong>backing</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Disk.BackingInfo" title="com.vmware.vcenter.vm.hardware_client.Disk.BackingInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Disk.BackingInfo</span></code></a>) – Physical resource backing for the virtual disk.</p></li>
|
|||
|
|
<li><p><strong>capacity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Capacity of the virtual disk in bytes.
|
|||
|
|
If None, virtual disk is inaccessible or disk capacity is 0.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.RESOURCE_TYPE">
|
|||
|
|
<code class="sig-name 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="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.StoragePolicySpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">StoragePolicySpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">policy</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the storage policy which should be associated with
|
|||
|
|
the VMDK file. This attribute was added in vSphere API 6.7.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.StoragePolicy</span></code>. When methods return a value
|
|||
|
|
of this class as a return value, the attribute will be an
|
|||
|
|
identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.StoragePolicy</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.Summary">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">disk</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>disk</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the virtual Disk.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>. When methods return a
|
|||
|
|
value of this class as a return value, the attribute will be an
|
|||
|
|
identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.UpdateSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">UpdateSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">backing</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>backing</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Disk.BackingSpec" title="com.vmware.vcenter.vm.hardware_client.Disk.BackingSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Disk.BackingSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Physical resource backing for the virtual disk.</p>
|
|||
|
|
<p>This attribute may only be modified if the virtual machine is not
|
|||
|
|
powered on.
|
|||
|
|
If None, the value is unchanged.</p>
|
|||
|
|
</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.VmdkCreateSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">VmdkCreateSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">capacity</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">storage_policy</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Base name of the VMDK file. The name should not include the ‘.vmdk’
|
|||
|
|
file extension.
|
|||
|
|
If None, a name (derived from the name of the virtual machine) will
|
|||
|
|
be chosen by the server.</p></li>
|
|||
|
|
<li><p><strong>capacity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Capacity of the virtual disk backing in bytes.
|
|||
|
|
If None, defaults to a guest-specific capacity.</p></li>
|
|||
|
|
<li><p><strong>storage_policy</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Disk.StoragePolicySpec" title="com.vmware.vcenter.vm.hardware_client.Disk.StoragePolicySpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Disk.StoragePolicySpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The <code class="docutils literal notranslate"><span class="pre">Disk.StoragePolicySpec</span></code> class contains information about the
|
|||
|
|
storage policy that is to be associated the with VMDK file. This
|
|||
|
|
attribute was added in vSphere API 6.7.
|
|||
|
|
If None the default storage policy of the target datastore (if
|
|||
|
|
applicable) is applied. Currently a default storage policy is only
|
|||
|
|
supported by object based datastores : VVol & vSAN. For non- object
|
|||
|
|
datastores, if None then no storage policy would be associated with
|
|||
|
|
the VMDK file.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.create">
|
|||
|
|
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></em>, <em class="sig-param"><span class="n">spec</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
<li><p><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.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>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>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
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>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the virtual machine is suspended or if the virtual machine is
|
|||
|
|
powered on and virtual disk type is IDE.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnableToAllocateResource" title="com.vmware.vapi.std.errors_client.UnableToAllocateResource"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code></a>
|
|||
|
|
if the specified storage address is unavailable; for example, if
|
|||
|
|
the SCSI adapter requested does not exist.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInUse" title="com.vmware.vapi.std.errors_client.ResourceInUse"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInUse</span></code></a>
|
|||
|
|
if the specified storage address is in use.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if the specified storage address is out of bounds or if the
|
|||
|
|
specified storage policy is invalid.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the virtual machine is busy performing another operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
|||
|
|
if the guest operating system of the virtual machine is not
|
|||
|
|
supported and spec includes None attributes that default to
|
|||
|
|
guest-specific values.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.delete">
|
|||
|
|
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></em>, <em class="sig-param"><span class="n">disk</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine or virtual disk is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the virtual machine is suspended or if the virtual machine is
|
|||
|
|
powered on and virtual disk type is IDE.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the virtual machine is busy performing another operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></em>, <em class="sig-param"><span class="n">disk</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><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>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>Information about the specified virtual disk.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine or virtual disk is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.list">
|
|||
|
|
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><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>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><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></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>List of commonly used information about the virtual disks.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Disk.update">
|
|||
|
|
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></em>, <em class="sig-param"><span class="n">disk</span></em>, <em class="sig-param"><span class="n">spec</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
<li><p><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.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine or virtual disk is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
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>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the virtual machine is busy performing another operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm.hardware_client.</code><code class="sig-name descname">Ethernet</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></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="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingInfo">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">BackingInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">network</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">network_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">host_device</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">distributed_switch_uuid</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">distributed_port</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">connection_cookie</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">opaque_network_type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">opaque_network_id</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType" title="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ethernet.BackingType</span></code></a>) – Backing type for the virtual Ethernet adapter.</p></li>
|
|||
|
|
<li><p><strong>network</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifier of the network backing the virtual Ethernet adapter.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">Network</span></code>.
|
|||
|
|
When methods return a value of this class as a return value, the
|
|||
|
|
attribute will be an identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">Network</span></code>.
|
|||
|
|
If None, the identifier of the network backing could not be
|
|||
|
|
determined.</p></li>
|
|||
|
|
<li><p><strong>network_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the standard portgroup backing the virtual Ethernet
|
|||
|
|
adapter.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.STANDARD_PORTGROUP" title="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.STANDARD_PORTGROUP"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Ethernet.BackingType.STANDARD_PORTGROUP</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>host_device</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the device backing the virtual Ethernet adapter.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.HOST_DEVICE" title="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.HOST_DEVICE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Ethernet.BackingType.HOST_DEVICE</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>distributed_switch_uuid</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – UUID of the distributed virtual switch that backs the virtual
|
|||
|
|
Ethernet adapter.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.DISTRIBUTED_PORTGROUP" title="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.DISTRIBUTED_PORTGROUP"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Ethernet.BackingType.DISTRIBUTED_PORTGROUP</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>distributed_port</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Key of the distributed virtual port that backs the virtual Ethernet
|
|||
|
|
adapter.
|
|||
|
|
This attribute will be None if the virtual Ethernet device is not
|
|||
|
|
bound to a distributed virtual port; this can happen if the virtual
|
|||
|
|
machine is powered off or the virtual Ethernet device is not
|
|||
|
|
connected.</p></li>
|
|||
|
|
<li><p><strong>connection_cookie</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Server-generated cookie that identifies the connection to the port.
|
|||
|
|
This ookie may be used to verify that the virtual machine is the
|
|||
|
|
rightful owner of the port.
|
|||
|
|
This attribute will be None if the virtual Ethernet device is not
|
|||
|
|
bound to a distributed virtual port; this can happen if the virtual
|
|||
|
|
machine is powered off or the virtual Ethernet device is not
|
|||
|
|
connected.</p></li>
|
|||
|
|
<li><p><strong>opaque_network_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Type of the opaque network that backs the virtual Ethernet adapter.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.OPAQUE_NETWORK" title="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.OPAQUE_NETWORK"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Ethernet.BackingType.OPAQUE_NETWORK</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>opaque_network_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the opaque network that backs the virtual Ethernet
|
|||
|
|
adapter.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.OPAQUE_NETWORK" title="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.OPAQUE_NETWORK"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Ethernet.BackingType.OPAQUE_NETWORK</span></code></a>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">BackingSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">network</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">distributed_port</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType" title="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ethernet.BackingType</span></code></a>) – Backing type for the virtual Ethernet adapter.</p></li>
|
|||
|
|
<li><p><strong>network</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the network that backs the virtual Ethernet adapter.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">Network</span></code>.
|
|||
|
|
When methods return a value of this class as a return value, the
|
|||
|
|
attribute will be an identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">Network</span></code>.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is one of
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.STANDARD_PORTGROUP" title="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.STANDARD_PORTGROUP"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Ethernet.BackingType.STANDARD_PORTGROUP</span></code></a>,
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.DISTRIBUTED_PORTGROUP" title="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.DISTRIBUTED_PORTGROUP"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Ethernet.BackingType.DISTRIBUTED_PORTGROUP</span></code></a>, or
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.OPAQUE_NETWORK" title="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.OPAQUE_NETWORK"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Ethernet.BackingType.OPAQUE_NETWORK</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>distributed_port</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Key of the distributed virtual port that backs the virtual Ethernet
|
|||
|
|
adapter. Depending on the type of the Portgroup, the port may be
|
|||
|
|
specified using this field. If the portgroup type is early-binding
|
|||
|
|
(also known as static), a port is assigned when the Ethernet
|
|||
|
|
adapter is configured to use the port. The port may be either
|
|||
|
|
automatically or specifically assigned based on the value of this
|
|||
|
|
attribute. If the portgroup type is ephemeral, the port is created
|
|||
|
|
and assigned to a virtual machine when it is powered on and the
|
|||
|
|
Ethernet adapter is connected. This attribute cannot be specified
|
|||
|
|
as no free ports exist before use.
|
|||
|
|
May be used to specify a port when the network specified on the
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">network</span></code> attribute is a static or early binding distributed
|
|||
|
|
portgroup. If None, the port will be automatically assigned to the
|
|||
|
|
Ethernet adapter based on the policy embodied by the portgroup
|
|||
|
|
type.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">BackingType</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></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="admonition-title">Note</p>
|
|||
|
|
<p>This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">BackingType</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.DISTRIBUTED_PORTGROUP">
|
|||
|
|
<code class="sig-name 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="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.HOST_DEVICE">
|
|||
|
|
<code class="sig-name 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="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.OPAQUE_NETWORK">
|
|||
|
|
<code class="sig-name 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="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingType.STANDARD_PORTGROUP">
|
|||
|
|
<code class="sig-name 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="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.CreateSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">CreateSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">upt_compatibility_enabled</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">mac_type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">mac_address</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">pci_slot_number</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">wake_on_lan_enabled</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">backing</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">start_connected</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">allow_guest_control</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType" title="com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ethernet.EmulationType</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Ethernet adapter emulation type.
|
|||
|
|
If None, defaults to a guest-specific type.</p></li>
|
|||
|
|
<li><p><strong>upt_compatibility_enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag indicating whether Universal Pass-Through (UPT) compatibility
|
|||
|
|
is enabled on this virtual Ethernet adapter.
|
|||
|
|
If None, defaults to false.</p></li>
|
|||
|
|
<li><p><strong>mac_type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType" title="com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ethernet.MacAddressType</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – MAC address type.
|
|||
|
|
If None, defaults to <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType.GENERATED" title="com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType.GENERATED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Ethernet.MacAddressType.GENERATED</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>mac_address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – MAC address.
|
|||
|
|
Workaround for PR1459647</p></li>
|
|||
|
|
<li><p><strong>pci_slot_number</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Address of the virtual Ethernet adapter on the PCI bus. If the PCI
|
|||
|
|
address is invalid, the server will change when it the VM is
|
|||
|
|
started or as the device is hot added.
|
|||
|
|
If None, the server will choose an available address when the
|
|||
|
|
virtual machine is powered on.</p></li>
|
|||
|
|
<li><p><strong>wake_on_lan_enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag indicating whether wake-on-LAN is enabled on this virtual
|
|||
|
|
Ethernet adapter.
|
|||
|
|
Defaults to false if None.</p></li>
|
|||
|
|
<li><p><strong>backing</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingSpec" title="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ethernet.BackingSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Physical resource backing for the virtual Ethernet adapter.
|
|||
|
|
If None, the system may try to find an appropriate backing. If one
|
|||
|
|
is not found, the request will fail.</p></li>
|
|||
|
|
<li><p><strong>start_connected</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag indicating whether the virtual device should be connected
|
|||
|
|
whenever the virtual machine is powered on.
|
|||
|
|
Defaults to false if None.</p></li>
|
|||
|
|
<li><p><strong>allow_guest_control</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag indicating whether the guest can connect and disconnect the
|
|||
|
|
device.
|
|||
|
|
Defaults to false if None.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">EmulationType</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></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="admonition-title">Note</p>
|
|||
|
|
<p>This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">EmulationType</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType.E1000">
|
|||
|
|
<code class="sig-name 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="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType.E1000E">
|
|||
|
|
<code class="sig-name 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="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType.PCNET32">
|
|||
|
|
<code class="sig-name 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="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType.VMXNET">
|
|||
|
|
<code class="sig-name 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="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType.VMXNET2">
|
|||
|
|
<code class="sig-name 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="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType.VMXNET3">
|
|||
|
|
<code class="sig-name 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="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.Info">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">label</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">upt_compatibility_enabled</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">mac_type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">mac_address</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">pci_slot_number</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">wake_on_lan_enabled</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">backing</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">state</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">start_connected</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">allow_guest_control</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>label</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Device label.</p></li>
|
|||
|
|
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType" title="com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ethernet.EmulationType</span></code></a>) – Ethernet adapter emulation type.</p></li>
|
|||
|
|
<li><p><strong>upt_compatibility_enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag indicating whether Universal Pass-Through (UPT) compatibility
|
|||
|
|
is enabled on this virtual Ethernet adapter.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType.VMXNET3" title="com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType.VMXNET3"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Ethernet.EmulationType.VMXNET3</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>mac_type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType" title="com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ethernet.MacAddressType</span></code></a>) – MAC address type.</p></li>
|
|||
|
|
<li><p><strong>mac_address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – MAC address.
|
|||
|
|
May be None if <code class="xref py py-attr docutils literal notranslate"><span class="pre">Ethernet.Info.mac_type</span></code> is
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType.MANUAL" title="com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType.MANUAL"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Ethernet.MacAddressType.MANUAL</span></code></a> and has not been specified,
|
|||
|
|
or if <code class="xref py py-attr docutils literal notranslate"><span class="pre">Ethernet.Info.mac_type</span></code> is
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType.GENERATED" title="com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType.GENERATED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Ethernet.MacAddressType.GENERATED</span></code></a> and the virtual machine
|
|||
|
|
has never been powered on since the Ethernet adapter was created.</p></li>
|
|||
|
|
<li><p><strong>pci_slot_number</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Address of the virtual Ethernet adapter on the PCI bus. If the PCI
|
|||
|
|
address is invalid, the server will change it when the VM is
|
|||
|
|
started or as the device is hot added.
|
|||
|
|
May be None if the virtual machine has never been powered on since
|
|||
|
|
the adapter was created.</p></li>
|
|||
|
|
<li><p><strong>wake_on_lan_enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag indicating whether wake-on-LAN is enabled on this virtual
|
|||
|
|
Ethernet adapter.</p></li>
|
|||
|
|
<li><p><strong>backing</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingInfo" title="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ethernet.BackingInfo</span></code></a>) – Physical resource backing for the virtual Ethernet adapter.</p></li>
|
|||
|
|
<li><p><strong>state</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.ConnectionState" title="com.vmware.vcenter.vm.hardware_client.ConnectionState"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConnectionState</span></code></a>) – Connection status of the virtual device.</p></li>
|
|||
|
|
<li><p><strong>start_connected</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag indicating whether the virtual device should be connected
|
|||
|
|
whenever the virtual machine is powered on.</p></li>
|
|||
|
|
<li><p><strong>allow_guest_control</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag indicating whether the guest can connect and disconnect the
|
|||
|
|
device.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">MacAddressType</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></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="admonition-title">Note</p>
|
|||
|
|
<p>This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">MacAddressType</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType.ASSIGNED">
|
|||
|
|
<code class="sig-name 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="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType.GENERATED">
|
|||
|
|
<code class="sig-name 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="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType.MANUAL">
|
|||
|
|
<code class="sig-name 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="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.RESOURCE_TYPE">
|
|||
|
|
<code class="sig-name 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="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.Summary">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">nic</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>nic</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the virtual Ethernet adapter.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Ethernet</span></code>. When methods return a
|
|||
|
|
value of this class as a return value, the attribute 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>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.UpdateSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">UpdateSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">upt_compatibility_enabled</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">mac_type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">mac_address</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">wake_on_lan_enabled</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">backing</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">start_connected</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">allow_guest_control</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>upt_compatibility_enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Flag indicating whether Universal Pass-Through (UPT) compatibility
|
|||
|
|
should be enabled on this virtual Ethernet adapter.</p>
|
|||
|
|
<p>This attribute may be modified at any time, and changes will be
|
|||
|
|
applied the next time the virtual machine is powered on.
|
|||
|
|
If None, the value is unchanged. Must be None if the emulation type
|
|||
|
|
of the virtual Ethernet adapter is not
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType.VMXNET3" title="com.vmware.vcenter.vm.hardware_client.Ethernet.EmulationType.VMXNET3"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Ethernet.EmulationType.VMXNET3</span></code></a>.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>mac_type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType" title="com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ethernet.MacAddressType</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>MAC address type.</p>
|
|||
|
|
<p>This attribute may be modified at any time, and changes will be
|
|||
|
|
applied the next time the virtual machine is powered on.
|
|||
|
|
If None, the value is unchanged.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>mac_address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>MAC address.</p>
|
|||
|
|
<p>This attribute may be modified at any time, and changes will be
|
|||
|
|
applied the next time the virtual machine is powered on.
|
|||
|
|
If None, the value is unchanged. Must be specified if
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Ethernet.UpdateSpec.mac_type</span></code> is
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType.MANUAL" title="com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType.MANUAL"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Ethernet.MacAddressType.MANUAL</span></code></a>. Must be None if the MAC
|
|||
|
|
address type is not <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType.MANUAL" title="com.vmware.vcenter.vm.hardware_client.Ethernet.MacAddressType.MANUAL"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Ethernet.MacAddressType.MANUAL</span></code></a>.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>wake_on_lan_enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Flag indicating whether wake-on-LAN shoud be enabled on this
|
|||
|
|
virtual Ethernet adapter.</p>
|
|||
|
|
<p>This attribute may be modified at any time, and changes will be
|
|||
|
|
applied the next time the virtual machine is powered on.
|
|||
|
|
If None, the value is unchanged.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>backing</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Ethernet.BackingSpec" title="com.vmware.vcenter.vm.hardware_client.Ethernet.BackingSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ethernet.BackingSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Physical resource backing for the virtual Ethernet adapter.</p>
|
|||
|
|
<p>This attribute may be modified at any time, and changes will be
|
|||
|
|
applied the next time the virtual machine is powered on.
|
|||
|
|
If None, the value is unchanged.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>start_connected</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag indicating whether the virtual device should be connected
|
|||
|
|
whenever the virtual machine is powered on.
|
|||
|
|
If None, the value is unchanged.</p></li>
|
|||
|
|
<li><p><strong>allow_guest_control</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag indicating whether the guest can connect and disconnect the
|
|||
|
|
device.
|
|||
|
|
If None, the value is unchanged.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.connect">
|
|||
|
|
<code class="sig-name descname">connect</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></em>, <em class="sig-param"><span class="n">nic</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine or virtual Ethernet adapter is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyInDesiredState" title="com.vmware.vapi.std.errors_client.AlreadyInDesiredState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code></a>
|
|||
|
|
if the virtual Ethernet adapter is already connected.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the virtual machine is not powered on.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the virtual machine is busy performing another operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.create">
|
|||
|
|
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></em>, <em class="sig-param"><span class="n">spec</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
<li><p><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.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>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>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
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>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine or network backing is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnableToAllocateResource" title="com.vmware.vapi.std.errors_client.UnableToAllocateResource"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code></a>
|
|||
|
|
if the virtual machine already has the maximum number of supported
|
|||
|
|
Ethernet adapters.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
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>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the virtual machine is busy performing another operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
|||
|
|
if the guest operating system of the virtual machine is not
|
|||
|
|
supported and spec includes None attributes that default to
|
|||
|
|
guest-specific values.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.delete">
|
|||
|
|
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></em>, <em class="sig-param"><span class="n">nic</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine or virtual Ethernet adapter is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the virtual machine is busy performing another operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.disconnect">
|
|||
|
|
<code class="sig-name descname">disconnect</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></em>, <em class="sig-param"><span class="n">nic</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine or virtual Ethernet adapter is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyInDesiredState" title="com.vmware.vapi.std.errors_client.AlreadyInDesiredState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code></a>
|
|||
|
|
if the virtual Ethernet adapter is already disconnected.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the virtual machine is not powered on.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the virtual machine is busy performing another operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></em>, <em class="sig-param"><span class="n">nic</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><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>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>Information about the specified virtual Ethernet adapter.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine or virtual Ethernet adapter is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.list">
|
|||
|
|
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><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>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><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></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>List of commonly used information about virtual Ethernet adapters.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Ethernet.update">
|
|||
|
|
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></em>, <em class="sig-param"><span class="n">nic</span></em>, <em class="sig-param"><span class="n">spec</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
<li><p><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.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if HOST_DEVICE is specified as the type.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine, virtual Ethernet adapter, or backing
|
|||
|
|
network is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the virtual machine is busy performing another operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Floppy">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm.hardware_client.</code><code class="sig-name descname">Floppy</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></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="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Floppy.BackingInfo">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">BackingInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">image_file</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">host_device</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">auto_detect</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Floppy.BackingType" title="com.vmware.vcenter.vm.hardware_client.Floppy.BackingType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Floppy.BackingType</span></code></a>) – Backing type for the virtual floppy drive.</p></li>
|
|||
|
|
<li><p><strong>image_file</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Path of the image file backing the virtual floppy drive.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Floppy.BackingType.IMAGE_FILE" title="com.vmware.vcenter.vm.hardware_client.Floppy.BackingType.IMAGE_FILE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Floppy.BackingType.IMAGE_FILE</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>host_device</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Name of the host device backing the virtual floppy drive.
|
|||
|
|
This attribute will be None if <code class="docutils literal notranslate"><span class="pre">autoDetect</span></code> is true and the
|
|||
|
|
virtual floppy drive is not connected or no suitable device is
|
|||
|
|
available on the host.</p></li>
|
|||
|
|
<li><p><strong>auto_detect</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag indicating whether the virtual floppy drive is configured to
|
|||
|
|
automatically detect a suitable host device.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Floppy.BackingType.HOST_DEVICE" title="com.vmware.vcenter.vm.hardware_client.Floppy.BackingType.HOST_DEVICE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Floppy.BackingType.HOST_DEVICE</span></code></a>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Floppy.BackingSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">BackingSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">image_file</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">host_device</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Floppy.BackingType" title="com.vmware.vcenter.vm.hardware_client.Floppy.BackingType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Floppy.BackingType</span></code></a>) – Backing type for the virtual floppy drive.</p></li>
|
|||
|
|
<li><p><strong>image_file</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Path of the image file that should be used as the virtual floppy
|
|||
|
|
drive backing.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Floppy.BackingType.IMAGE_FILE" title="com.vmware.vcenter.vm.hardware_client.Floppy.BackingType.IMAGE_FILE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Floppy.BackingType.IMAGE_FILE</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>host_device</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Name of the device that should be used as the virtual floppy drive
|
|||
|
|
backing.
|
|||
|
|
If None, the virtual floppy drive will be configured to
|
|||
|
|
automatically detect a suitable host device.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Floppy.BackingType">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">BackingType</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></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="admonition-title">Note</p>
|
|||
|
|
<p>This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">BackingType</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Floppy.BackingType.CLIENT_DEVICE">
|
|||
|
|
<code class="sig-name 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="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Floppy.BackingType.HOST_DEVICE">
|
|||
|
|
<code class="sig-name 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="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Floppy.BackingType.IMAGE_FILE">
|
|||
|
|
<code class="sig-name 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="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Floppy.CreateSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">CreateSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">backing</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">start_connected</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">allow_guest_control</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>backing</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Floppy.BackingSpec" title="com.vmware.vcenter.vm.hardware_client.Floppy.BackingSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Floppy.BackingSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Physical resource backing for the virtual floppy drive.
|
|||
|
|
If None, defaults to automatic detection of a suitable host device.</p></li>
|
|||
|
|
<li><p><strong>start_connected</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag indicating whether the virtual device should be connected
|
|||
|
|
whenever the virtual machine is powered on.
|
|||
|
|
Defaults to false if None.</p></li>
|
|||
|
|
<li><p><strong>allow_guest_control</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag indicating whether the guest can connect and disconnect the
|
|||
|
|
device.
|
|||
|
|
Defaults to false if None.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Floppy.Info">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">label</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">backing</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">state</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">start_connected</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">allow_guest_control</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>label</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Device label.</p></li>
|
|||
|
|
<li><p><strong>backing</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Floppy.BackingInfo" title="com.vmware.vcenter.vm.hardware_client.Floppy.BackingInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Floppy.BackingInfo</span></code></a>) – Physical resource backing for the virtual floppy drive.</p></li>
|
|||
|
|
<li><p><strong>state</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.ConnectionState" title="com.vmware.vcenter.vm.hardware_client.ConnectionState"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConnectionState</span></code></a>) – Connection status of the virtual device.</p></li>
|
|||
|
|
<li><p><strong>start_connected</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag indicating whether the virtual device should be connected
|
|||
|
|
whenever the virtual machine is powered on.</p></li>
|
|||
|
|
<li><p><strong>allow_guest_control</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag indicating whether the guest can connect and disconnect the
|
|||
|
|
device.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Floppy.RESOURCE_TYPE">
|
|||
|
|
<code class="sig-name 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="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Floppy.Summary">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">floppy</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>floppy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the virtual floppy drive.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Floppy</span></code>. When methods return a
|
|||
|
|
value of this class as a return value, the attribute 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>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Floppy.UpdateSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">UpdateSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">backing</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">start_connected</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">allow_guest_control</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>backing</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Floppy.BackingSpec" title="com.vmware.vcenter.vm.hardware_client.Floppy.BackingSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Floppy.BackingSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Physical resource backing for the virtual floppy drive.</p>
|
|||
|
|
<p>This attribute may only be modified if the virtual machine is not
|
|||
|
|
powered on or the virtual floppy drive is not connected.
|
|||
|
|
If None, the value is unchanged.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>start_connected</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag indicating whether the virtual device should be connected
|
|||
|
|
whenever the virtual machine is powered on.
|
|||
|
|
If None, the value is unchanged.</p></li>
|
|||
|
|
<li><p><strong>allow_guest_control</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag indicating whether the guest can connect and disconnect the
|
|||
|
|
device.
|
|||
|
|
If None, the value is unchanged.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Floppy.connect">
|
|||
|
|
<code class="sig-name descname">connect</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></em>, <em class="sig-param"><span class="n">floppy</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine or virtual floppy drive is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyInDesiredState" title="com.vmware.vapi.std.errors_client.AlreadyInDesiredState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code></a>
|
|||
|
|
if the virtual floppy drive is already connected.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the virtual machine is not powered on.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the virtual machine is busy performing another operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Floppy.create">
|
|||
|
|
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></em>, <em class="sig-param"><span class="n">spec</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
<li><p><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.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>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>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
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>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the virtual machine is not powered off.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnableToAllocateResource" title="com.vmware.vapi.std.errors_client.UnableToAllocateResource"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code></a>
|
|||
|
|
if the virtual machine already has the maximum number of supported
|
|||
|
|
floppy drives.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the virtual machine is busy performing another operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Floppy.delete">
|
|||
|
|
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></em>, <em class="sig-param"><span class="n">floppy</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine or virtual floppy drive is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the virtual machine is not powered off.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the virtual machine is busy performing another operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Floppy.disconnect">
|
|||
|
|
<code class="sig-name descname">disconnect</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></em>, <em class="sig-param"><span class="n">floppy</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine or virtual floppy drive is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyInDesiredState" title="com.vmware.vapi.std.errors_client.AlreadyInDesiredState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code></a>
|
|||
|
|
if the virtual floppy drive is already disconnected.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the virtual machine is not powered on.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the virtual machine is busy performing another operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Floppy.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></em>, <em class="sig-param"><span class="n">floppy</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><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>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>Information about the specified virtual floppy drive.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine or virtual floppy drive is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Floppy.list">
|
|||
|
|
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><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>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><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></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>List of commonly used information about virtual floppy drives.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Floppy.update">
|
|||
|
|
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></em>, <em class="sig-param"><span class="n">floppy</span></em>, <em class="sig-param"><span class="n">spec</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
<li><p><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.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine or virtual floppy drive is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
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>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the virtual machine is busy performing another operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.IdeAddressInfo">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm.hardware_client.</code><code class="sig-name descname">IdeAddressInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">primary</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">master</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>primary</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag specifying whether the device is attached to the primary or
|
|||
|
|
secondary IDE adapter of the virtual machine.</p></li>
|
|||
|
|
<li><p><strong>master</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag specifying whether the device is the master or slave device on
|
|||
|
|
the IDE adapter.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.IdeAddressSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm.hardware_client.</code><code class="sig-name descname">IdeAddressSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">primary</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">master</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>primary</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag specifying whether the device should be attached to the
|
|||
|
|
primary or secondary IDE adapter of the virtual machine.
|
|||
|
|
If None, the server will choose a adapter with an available
|
|||
|
|
connection. If no IDE connections are available, the request will
|
|||
|
|
be rejected.</p></li>
|
|||
|
|
<li><p><strong>master</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag specifying whether the device should be the master or slave
|
|||
|
|
device on the IDE adapter.
|
|||
|
|
If None, the server will choose an available connection type. If no
|
|||
|
|
IDE connections are available, the request will be rejected.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Memory">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm.hardware_client.</code><code class="sig-name descname">Memory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></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="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Memory.Info">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">size_mib</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">hot_add_enabled</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">hot_add_increment_size_mib</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">hot_add_limit_mib</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>size_mib</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Memory size in mebibytes.</p></li>
|
|||
|
|
<li><p><strong>hot_add_enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – <p>Flag indicating whether adding memory while the virtual machine is
|
|||
|
|
running is enabled.</p>
|
|||
|
|
<p>Some guest operating systems may consume more resources or perform
|
|||
|
|
less efficiently when they run on hardware that supports adding
|
|||
|
|
memory while the machine is running.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>hot_add_increment_size_mib</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>The granularity, in mebibytes, at which memory can be added to a
|
|||
|
|
running virtual machine.</p>
|
|||
|
|
<p>When adding memory to a running virtual machine, the amount of
|
|||
|
|
memory added must be at least
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Memory.Info.hot_add_increment_size_mib</span></code> and the total memory
|
|||
|
|
size of the virtual machine must be a multiple of
|
|||
|
|
{\@link>hotAddIncrementSize}.
|
|||
|
|
Only set when <code class="xref py py-attr docutils literal notranslate"><span class="pre">Memory.Info.hot_add_enabled</span></code> is true and the
|
|||
|
|
virtual machine is running.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>hot_add_limit_mib</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The maximum amount of memory, in mebibytes, that can be added to a
|
|||
|
|
running virtual machine.
|
|||
|
|
Only set when <code class="xref py py-attr docutils literal notranslate"><span class="pre">Memory.Info.hot_add_enabled</span></code> is true and the
|
|||
|
|
virtual machine is running.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Memory.UpdateSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">UpdateSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">size_mib</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">hot_add_enabled</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>size_mib</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>New memory size in mebibytes.</p>
|
|||
|
|
<p>The supported range of memory sizes is constrained by the
|
|||
|
|
configured guest operating system and virtual hardware version of
|
|||
|
|
the virtual machine.</p>
|
|||
|
|
<p>If the virtual machine is running, this value may only be changed
|
|||
|
|
if <code class="xref py py-attr docutils literal notranslate"><span class="pre">Memory.Info.hot_add_enabled</span></code> is true, and the new memory
|
|||
|
|
size must satisfy the constraints specified by
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Memory.Info.hot_add_increment_size_mib</span></code> and
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Memory.Info.hot_add_limit_mib</span></code>.
|
|||
|
|
If None, the value is unchanged.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>hot_add_enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Flag indicating whether adding memory while the virtual machine is
|
|||
|
|
running should be enabled.</p>
|
|||
|
|
<p>Some guest operating systems may consume more resources or perform
|
|||
|
|
less efficiently when they run on hardware that supports adding
|
|||
|
|
memory while the machine is running.</p>
|
|||
|
|
<p>This attribute may only be modified if the virtual machine is not
|
|||
|
|
powered on.
|
|||
|
|
If None, the value is unchanged.</p>
|
|||
|
|
</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Memory.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><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>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><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></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>Memory-related settings of the virtual machine.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Memory.update">
|
|||
|
|
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></em>, <em class="sig-param"><span class="n">spec</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
<li><p><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.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
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>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">hotAddEnabled</span></code> is specified and the virtual machine is not
|
|||
|
|
powered off.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
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>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the virtual machine is busy performing another operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Parallel">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm.hardware_client.</code><code class="sig-name descname">Parallel</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></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="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Parallel.BackingInfo">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">BackingInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">file</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">host_device</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">auto_detect</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Parallel.BackingType" title="com.vmware.vcenter.vm.hardware_client.Parallel.BackingType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Parallel.BackingType</span></code></a>) – Backing type for the virtual parallel port.</p></li>
|
|||
|
|
<li><p><strong>file</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Path of the file backing the virtual parallel port.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Parallel.BackingType.FILE" title="com.vmware.vcenter.vm.hardware_client.Parallel.BackingType.FILE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Parallel.BackingType.FILE</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>host_device</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Name of the device backing the virtual parallel port.
|
|||
|
|
This attribute will be None if <code class="docutils literal notranslate"><span class="pre">autoDetect</span></code> is true and the
|
|||
|
|
virtual parallel port is not connected or no suitable device is
|
|||
|
|
available on the host.</p></li>
|
|||
|
|
<li><p><strong>auto_detect</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag indicating whether the virtual parallel port is configured to
|
|||
|
|
automatically detect a suitable host device.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Parallel.BackingType.HOST_DEVICE" title="com.vmware.vcenter.vm.hardware_client.Parallel.BackingType.HOST_DEVICE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Parallel.BackingType.HOST_DEVICE</span></code></a>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Parallel.BackingSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">BackingSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">file</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">host_device</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Parallel.BackingType" title="com.vmware.vcenter.vm.hardware_client.Parallel.BackingType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Parallel.BackingType</span></code></a>) – Backing type for the virtual parallel port.</p></li>
|
|||
|
|
<li><p><strong>file</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Path of the file that should be used as the virtual parallel port
|
|||
|
|
backing.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Parallel.BackingType.FILE" title="com.vmware.vcenter.vm.hardware_client.Parallel.BackingType.FILE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Parallel.BackingType.FILE</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>host_device</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Name of the device that should be used as the virtual parallel port
|
|||
|
|
backing.
|
|||
|
|
If None, the virtual parallel port will be configured to
|
|||
|
|
automatically detect a suitable host device.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Parallel.BackingType">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">BackingType</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></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="admonition-title">Note</p>
|
|||
|
|
<p>This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">BackingType</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Parallel.BackingType.FILE">
|
|||
|
|
<code class="sig-name 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="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Parallel.BackingType.HOST_DEVICE">
|
|||
|
|
<code class="sig-name 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="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Parallel.CreateSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">CreateSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">backing</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">start_connected</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">allow_guest_control</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>backing</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Parallel.BackingSpec" title="com.vmware.vcenter.vm.hardware_client.Parallel.BackingSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Parallel.BackingSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Physical resource backing for the virtual parallel port.
|
|||
|
|
If None, defaults to automatic detection of a suitable host device.</p></li>
|
|||
|
|
<li><p><strong>start_connected</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag indicating whether the virtual device should be connected
|
|||
|
|
whenever the virtual machine is powered on.
|
|||
|
|
Defaults to false if None.</p></li>
|
|||
|
|
<li><p><strong>allow_guest_control</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag indicating whether the guest can connect and disconnect the
|
|||
|
|
device.
|
|||
|
|
Defaults to false if None.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Parallel.Info">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">label</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">backing</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">state</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">start_connected</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">allow_guest_control</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>label</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Device label.</p></li>
|
|||
|
|
<li><p><strong>backing</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Parallel.BackingInfo" title="com.vmware.vcenter.vm.hardware_client.Parallel.BackingInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Parallel.BackingInfo</span></code></a>) – Physical resource backing for the virtual parallel port.</p></li>
|
|||
|
|
<li><p><strong>state</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.ConnectionState" title="com.vmware.vcenter.vm.hardware_client.ConnectionState"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConnectionState</span></code></a>) – Connection status of the virtual device.</p></li>
|
|||
|
|
<li><p><strong>start_connected</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag indicating whether the virtual device should be connected
|
|||
|
|
whenever the virtual machine is powered on.</p></li>
|
|||
|
|
<li><p><strong>allow_guest_control</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag indicating whether the guest can connect and disconnect the
|
|||
|
|
device.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Parallel.RESOURCE_TYPE">
|
|||
|
|
<code class="sig-name 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="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Parallel.Summary">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">port</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>port</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the virtual parallel port.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.ParallelPort</span></code>. When methods
|
|||
|
|
return a value of this class as a return value, the attribute 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>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Parallel.UpdateSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">UpdateSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">backing</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">start_connected</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">allow_guest_control</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>backing</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Parallel.BackingSpec" title="com.vmware.vcenter.vm.hardware_client.Parallel.BackingSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Parallel.BackingSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Physical resource backing for the virtual parallel port.</p>
|
|||
|
|
<p>This attribute may only be modified if the virtual machine is not
|
|||
|
|
powered on or the virtual parallel port is not connected.
|
|||
|
|
If None, the value is unchanged.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>start_connected</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag indicating whether the virtual device should be connected
|
|||
|
|
whenever the virtual machine is powered on.
|
|||
|
|
If None, the value is unchanged.</p></li>
|
|||
|
|
<li><p><strong>allow_guest_control</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag indicating whether the guest can connect and disconnect the
|
|||
|
|
device.
|
|||
|
|
If None, the value is unchanged.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Parallel.connect">
|
|||
|
|
<code class="sig-name descname">connect</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></em>, <em class="sig-param"><span class="n">port</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine or virtual parallel port is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyInDesiredState" title="com.vmware.vapi.std.errors_client.AlreadyInDesiredState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code></a>
|
|||
|
|
if the virtual parallel port is already connected.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the virtual machine is not powered on.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the virtual machine is busy performing another operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Parallel.create">
|
|||
|
|
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></em>, <em class="sig-param"><span class="n">spec</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
<li><p><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.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>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>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
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>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the virtual machine is not powered off.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnableToAllocateResource" title="com.vmware.vapi.std.errors_client.UnableToAllocateResource"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code></a>
|
|||
|
|
if the virtual machine already has the maximum number of supported
|
|||
|
|
parallel ports.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the virtual machine is busy performing another operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Parallel.delete">
|
|||
|
|
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></em>, <em class="sig-param"><span class="n">port</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine or virtual parallel port is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the virtual machine is not powered off.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the virtual machine is busy performing another operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Parallel.disconnect">
|
|||
|
|
<code class="sig-name descname">disconnect</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></em>, <em class="sig-param"><span class="n">port</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine or virtual parallel port is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyInDesiredState" title="com.vmware.vapi.std.errors_client.AlreadyInDesiredState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code></a>
|
|||
|
|
if the virtual parallel port is already disconnected.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the virtual machine is not powered on.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the virtual machine is busy performing another operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Parallel.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></em>, <em class="sig-param"><span class="n">port</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><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>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>Information about the specified virtual parallel port.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine or virtual parallel port is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Parallel.list">
|
|||
|
|
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><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>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><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></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>List of commonly used information about virtual parallel ports.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Parallel.update">
|
|||
|
|
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></em>, <em class="sig-param"><span class="n">port</span></em>, <em class="sig-param"><span class="n">spec</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
<li><p><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.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine or virtual parallel port is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
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>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the virtual machine is busy performing another operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.SataAddressInfo">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm.hardware_client.</code><code class="sig-name descname">SataAddressInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">bus</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">unit</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>bus</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Bus number of the adapter to which the device is attached.</p></li>
|
|||
|
|
<li><p><strong>unit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Unit number of the device.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.SataAddressSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm.hardware_client.</code><code class="sig-name descname">SataAddressSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">bus</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">unit</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>bus</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Bus number of the adapter to which the device should be attached.</p></li>
|
|||
|
|
<li><p><strong>unit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Unit number of the device.
|
|||
|
|
If None, the server will choose an available unit number on the
|
|||
|
|
specified adapter. If there are no available connections on the
|
|||
|
|
adapter, the request will be rejected.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.ScsiAddressInfo">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm.hardware_client.</code><code class="sig-name descname">ScsiAddressInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">bus</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">unit</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>bus</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Bus number of the adapter to which the device is attached.</p></li>
|
|||
|
|
<li><p><strong>unit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Unit number of the device.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.ScsiAddressSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm.hardware_client.</code><code class="sig-name descname">ScsiAddressSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">bus</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">unit</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>bus</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Bus number of the adapter to which the device should be attached.</p></li>
|
|||
|
|
<li><p><strong>unit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Unit number of the device.
|
|||
|
|
If None, the server will choose an available unit number on the
|
|||
|
|
specified adapter. If there are no available connections on the
|
|||
|
|
adapter, the request will be rejected.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm.hardware_client.</code><code class="sig-name descname">Serial</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></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="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.BackingInfo">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">BackingInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">file</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">host_device</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">auto_detect</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">pipe</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">no_rx_loss</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">network_location</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">proxy</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType" title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Serial.BackingType</span></code></a>) – Backing type for the virtual serial port.</p></li>
|
|||
|
|
<li><p><strong>file</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Path of the file backing the virtual serial port.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.FILE" title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.FILE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Serial.BackingType.FILE</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>host_device</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Name of the device backing the virtual serial port.
|
|||
|
|
This attribute will be None if <code class="docutils literal notranslate"><span class="pre">autoDetect</span></code> is true and the
|
|||
|
|
virtual serial port is not connected or no suitable device is
|
|||
|
|
available on the host.</p></li>
|
|||
|
|
<li><p><strong>auto_detect</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag indicating whether the virtual serial port is configured to
|
|||
|
|
automatically detect a suitable host device.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.HOST_DEVICE" title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.HOST_DEVICE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Serial.BackingType.HOST_DEVICE</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>pipe</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the pipe backing the virtual serial port.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is one of <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.PIPE_SERVER" title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.PIPE_SERVER"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Serial.BackingType.PIPE_SERVER</span></code></a> or
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.PIPE_CLIENT" title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.PIPE_CLIENT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Serial.BackingType.PIPE_CLIENT</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>no_rx_loss</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag that enables optimized data transfer over the pipe. When the
|
|||
|
|
value is true, the host buffers data to prevent data overrun. This
|
|||
|
|
allows the virtual machine to read all of the data transferred over
|
|||
|
|
the pipe with no data loss.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is one of <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.PIPE_SERVER" title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.PIPE_SERVER"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Serial.BackingType.PIPE_SERVER</span></code></a> or
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.PIPE_CLIENT" title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.PIPE_CLIENT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Serial.BackingType.PIPE_CLIENT</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>network_location</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>URI specifying the location of the network service backing the
|
|||
|
|
virtual serial port.</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><p>If <code class="xref py py-attr docutils literal notranslate"><span class="pre">Serial.BackingInfo.type</span></code> is
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_SERVER" title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_SERVER"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Serial.BackingType.NETWORK_SERVER</span></code></a>, this attribute is the
|
|||
|
|
location used by clients to connect to this server. The hostname
|
|||
|
|
part of the URI should either be empty or should specify the
|
|||
|
|
address of the host on which the virtual machine is running.</p></li>
|
|||
|
|
<li><p>If <code class="xref py py-attr docutils literal notranslate"><span class="pre">Serial.BackingInfo.type</span></code> is
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_CLIENT" title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_CLIENT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Serial.BackingType.NETWORK_CLIENT</span></code></a>, this attribute is the
|
|||
|
|
location used by the virtual machine to connect to the remote
|
|||
|
|
server.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
<p>This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is one of <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_SERVER" title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_SERVER"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Serial.BackingType.NETWORK_SERVER</span></code></a> or
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_CLIENT" title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_CLIENT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Serial.BackingType.NETWORK_CLIENT</span></code></a>.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>proxy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Proxy service that provides network access to the network backing.
|
|||
|
|
If set, the virtual machine initiates a connection with the proxy
|
|||
|
|
service and forwards the traffic to the proxy.
|
|||
|
|
If None, no proxy service is configured.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.BackingSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">BackingSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">file</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">host_device</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">pipe</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">no_rx_loss</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">network_location</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">proxy</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType" title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Serial.BackingType</span></code></a>) – Backing type for the virtual serial port.</p></li>
|
|||
|
|
<li><p><strong>file</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Path of the file backing the virtual serial port.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.FILE" title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.FILE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Serial.BackingType.FILE</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>host_device</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Name of the device backing the virtual serial port.
|
|||
|
|
If None, the virtual serial port will be configured to
|
|||
|
|
automatically detect a suitable host device.</p></li>
|
|||
|
|
<li><p><strong>pipe</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the pipe backing the virtual serial port.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is one of <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.PIPE_SERVER" title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.PIPE_SERVER"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Serial.BackingType.PIPE_SERVER</span></code></a> or
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.PIPE_CLIENT" title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.PIPE_CLIENT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Serial.BackingType.PIPE_CLIENT</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>no_rx_loss</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag that enables optimized data transfer over the pipe. When the
|
|||
|
|
value is true, the host buffers data to prevent data overrun. This
|
|||
|
|
allows the virtual machine to read all of the data transferred over
|
|||
|
|
the pipe with no data loss.
|
|||
|
|
If None, defaults to false.</p></li>
|
|||
|
|
<li><p><strong>network_location</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>URI specifying the location of the network service backing the
|
|||
|
|
virtual serial port.</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><p>If <code class="xref py py-attr docutils literal notranslate"><span class="pre">Serial.BackingSpec.type</span></code> is
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_SERVER" title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_SERVER"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Serial.BackingType.NETWORK_SERVER</span></code></a>, this attribute is the
|
|||
|
|
location used by clients to connect to this server. The hostname
|
|||
|
|
part of the URI should either be empty or should specify the
|
|||
|
|
address of the host on which the virtual machine is running.</p></li>
|
|||
|
|
<li><p>If <code class="xref py py-attr docutils literal notranslate"><span class="pre">Serial.BackingSpec.type</span></code> is
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_CLIENT" title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_CLIENT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Serial.BackingType.NETWORK_CLIENT</span></code></a>, this attribute is the
|
|||
|
|
location used by the virtual machine to connect to the remote
|
|||
|
|
server.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
<p>This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is one of <a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_SERVER" title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_SERVER"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Serial.BackingType.NETWORK_SERVER</span></code></a> or
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_CLIENT" title="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_CLIENT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Serial.BackingType.NETWORK_CLIENT</span></code></a>.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>proxy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Proxy service that provides network access to the network backing.
|
|||
|
|
If set, the virtual machine initiates a connection with the proxy
|
|||
|
|
service and forwards the traffic to the proxy.
|
|||
|
|
If None, no proxy service should be used.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.BackingType">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">BackingType</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></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="admonition-title">Note</p>
|
|||
|
|
<p>This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">BackingType</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.FILE">
|
|||
|
|
<code class="sig-name 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="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.HOST_DEVICE">
|
|||
|
|
<code class="sig-name 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="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_CLIENT">
|
|||
|
|
<code class="sig-name 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="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.NETWORK_SERVER">
|
|||
|
|
<code class="sig-name 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="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.PIPE_CLIENT">
|
|||
|
|
<code class="sig-name 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="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.BackingType.PIPE_SERVER">
|
|||
|
|
<code class="sig-name 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="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.CreateSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">CreateSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">yield_on_poll</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">backing</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">start_connected</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">allow_guest_control</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>yield_on_poll</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – CPU yield behavior. If set to true, the virtual machine will
|
|||
|
|
periodically relinquish the processor if its sole task is polling
|
|||
|
|
the virtual serial port. The amount of time it takes to regain the
|
|||
|
|
processor will depend on the degree of other virtual machine
|
|||
|
|
activity on the host.
|
|||
|
|
If None, defaults to false.</p></li>
|
|||
|
|
<li><p><strong>backing</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingSpec" title="com.vmware.vcenter.vm.hardware_client.Serial.BackingSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Serial.BackingSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Physical resource backing for the virtual serial port.
|
|||
|
|
If None, defaults to automatic detection of a suitable host device.</p></li>
|
|||
|
|
<li><p><strong>start_connected</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag indicating whether the virtual device should be connected
|
|||
|
|
whenever the virtual machine is powered on.
|
|||
|
|
Defaults to false if None.</p></li>
|
|||
|
|
<li><p><strong>allow_guest_control</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag indicating whether the guest can connect and disconnect the
|
|||
|
|
device.
|
|||
|
|
Defaults to false if None.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.Info">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">label</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">yield_on_poll</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">backing</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">state</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">start_connected</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">allow_guest_control</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>label</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Device label.</p></li>
|
|||
|
|
<li><p><strong>yield_on_poll</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – CPU yield behavior. If set to true, the virtual machine will
|
|||
|
|
periodically relinquish the processor if its sole task is polling
|
|||
|
|
the virtual serial port. The amount of time it takes to regain the
|
|||
|
|
processor will depend on the degree of other virtual machine
|
|||
|
|
activity on the host.</p></li>
|
|||
|
|
<li><p><strong>backing</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingInfo" title="com.vmware.vcenter.vm.hardware_client.Serial.BackingInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Serial.BackingInfo</span></code></a>) – Physical resource backing for the virtual serial port.</p></li>
|
|||
|
|
<li><p><strong>state</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.ConnectionState" title="com.vmware.vcenter.vm.hardware_client.ConnectionState"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConnectionState</span></code></a>) – Connection status of the virtual device.</p></li>
|
|||
|
|
<li><p><strong>start_connected</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag indicating whether the virtual device should be connected
|
|||
|
|
whenever the virtual machine is powered on.</p></li>
|
|||
|
|
<li><p><strong>allow_guest_control</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag indicating whether the guest can connect and disconnect the
|
|||
|
|
device.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.RESOURCE_TYPE">
|
|||
|
|
<code class="sig-name 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="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.Summary">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">port</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>port</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the virtual serial port.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.SerialPort</span></code>. When methods return
|
|||
|
|
a value of this class as a return value, the attribute will be an
|
|||
|
|
identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.SerialPort</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.UpdateSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">UpdateSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">yield_on_poll</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">backing</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">start_connected</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">allow_guest_control</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>yield_on_poll</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>CPU yield behavior. If set to true, the virtual machine will
|
|||
|
|
periodically relinquish the processor if its sole task is polling
|
|||
|
|
the virtual serial port. The amount of time it takes to regain the
|
|||
|
|
processor will depend on the degree of other virtual machine
|
|||
|
|
activity on the host.</p>
|
|||
|
|
<p>This attribute may be modified at any time, and changes applied to
|
|||
|
|
a connected virtual serial port take effect immediately.
|
|||
|
|
If None, the value is unchanged.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>backing</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware_client.Serial.BackingSpec" title="com.vmware.vcenter.vm.hardware_client.Serial.BackingSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Serial.BackingSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Physical resource backing for the virtual serial port.</p>
|
|||
|
|
<p>This attribute may only be modified if the virtual machine is not
|
|||
|
|
powered on or the virtual serial port is not connected.
|
|||
|
|
If None, the value is unchanged.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>start_connected</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag indicating whether the virtual device should be connected
|
|||
|
|
whenever the virtual machine is powered on.
|
|||
|
|
If None, the value is unchanged.</p></li>
|
|||
|
|
<li><p><strong>allow_guest_control</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag indicating whether the guest can connect and disconnect the
|
|||
|
|
device.
|
|||
|
|
If None, the value is unchanged.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.connect">
|
|||
|
|
<code class="sig-name descname">connect</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></em>, <em class="sig-param"><span class="n">port</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine or virtual serial port is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyInDesiredState" title="com.vmware.vapi.std.errors_client.AlreadyInDesiredState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code></a>
|
|||
|
|
if the virtual serial port is already connected.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the virtual machine is not powered on.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the virtual machine is busy performing another operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.create">
|
|||
|
|
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></em>, <em class="sig-param"><span class="n">spec</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
<li><p><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.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>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>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
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>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the virtual machine is not powered off.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnableToAllocateResource" title="com.vmware.vapi.std.errors_client.UnableToAllocateResource"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code></a>
|
|||
|
|
if the virtual machine already has the maximum number of supported
|
|||
|
|
serial ports.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the virtual machine is busy performing another operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.delete">
|
|||
|
|
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></em>, <em class="sig-param"><span class="n">port</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine or virtual serial port is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the virtual machine is not powered off.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the virtual machine is busy performing another operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.disconnect">
|
|||
|
|
<code class="sig-name descname">disconnect</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></em>, <em class="sig-param"><span class="n">port</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine or virtual serial port is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyInDesiredState" title="com.vmware.vapi.std.errors_client.AlreadyInDesiredState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code></a>
|
|||
|
|
if the virtual serial port is already disconnected.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the virtual machine is not powered on.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the virtual machine is busy performing another operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></em>, <em class="sig-param"><span class="n">port</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><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>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>Information about the specified virtual serial port.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine or virtual serial port is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.list">
|
|||
|
|
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><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>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><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></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>List of commonly used information about virtual serial ports.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.Serial.update">
|
|||
|
|
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></em>, <em class="sig-param"><span class="n">port</span></em>, <em class="sig-param"><span class="n">spec</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
<li><p><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.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine or virtual serial port is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
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>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the virtual machine is busy performing another operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.hardware_client.StubFactory">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm.hardware_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></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>
|
|||
|
|
<p>Initialize StubFactoryBase</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</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="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.storage_client.Policy">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm.storage_client.</code><code class="sig-name descname">Policy</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></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="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.storage_client.Policy.DiskPolicySpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">DiskPolicySpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">policy</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.storage_client.Policy.DiskPolicySpec.PolicyType" title="com.vmware.vcenter.vm.storage_client.Policy.DiskPolicySpec.PolicyType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Policy.DiskPolicySpec.PolicyType</span></code></a>) – Policy type to be used while performing update operation on the
|
|||
|
|
virtual disks. This attribute was added in vSphere API 6.7.</p></li>
|
|||
|
|
<li><p><strong>policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Storage Policy identification. This attribute was added in vSphere
|
|||
|
|
API 6.7.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.StoragePolicy</span></code>. When methods return a value
|
|||
|
|
of this class as a return value, the attribute will be an
|
|||
|
|
identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.StoragePolicy</span></code>.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.storage_client.Policy.DiskPolicySpec.PolicyType.USE_SPECIFIED_POLICY" title="com.vmware.vcenter.vm.storage_client.Policy.DiskPolicySpec.PolicyType.USE_SPECIFIED_POLICY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Policy.DiskPolicySpec.PolicyType.USE_SPECIFIED_POLICY</span></code></a>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.storage_client.Policy.DiskPolicySpec.PolicyType">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">PolicyType</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></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="admonition-title">Note</p>
|
|||
|
|
<p>This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">PolicyType</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.storage_client.Policy.DiskPolicySpec.PolicyType.USE_DEFAULT_POLICY">
|
|||
|
|
<code class="sig-name 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="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.storage_client.Policy.DiskPolicySpec.PolicyType.USE_SPECIFIED_POLICY">
|
|||
|
|
<code class="sig-name 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="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.storage_client.Policy.Info">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm_home</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">disks</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>vm_home</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Storage Policy associated with virtual machine home. This attribute
|
|||
|
|
was added in vSphere API 6.7.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.StoragePolicy</span></code>. When methods return a value
|
|||
|
|
of this class as a return value, the attribute will be an
|
|||
|
|
identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.StoragePolicy</span></code>.
|
|||
|
|
IfNone, the virtual machine’s home directory doesn’t have any
|
|||
|
|
storage policy.</p></li>
|
|||
|
|
<li><p><strong>disks</strong> (<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 <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Storage policies associated with virtual disks. The values in this
|
|||
|
|
<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> are storage policy identifiers. They will be
|
|||
|
|
identifiers for the resource type:com.vmware.vcenter.StoragePolicy
|
|||
|
|
If the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is empty, the virtual machine does not have
|
|||
|
|
any disks or its disks are not associated with a storage policy.
|
|||
|
|
This attribute was added in vSphere API 6.7.
|
|||
|
|
When clients pass a value of this class as a parameter, the key in
|
|||
|
|
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>. When methods return
|
|||
|
|
a value of this class as a return value, the key in the attribute
|
|||
|
|
<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> 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></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.storage_client.Policy.UpdateSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">UpdateSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm_home</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">disks</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>vm_home</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.storage_client.Policy.VmHomePolicySpec" title="com.vmware.vcenter.vm.storage_client.Policy.VmHomePolicySpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Policy.VmHomePolicySpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Storage policy to be used when reconfiguring the virtual machine
|
|||
|
|
home. This attribute was added in vSphere API 6.7.
|
|||
|
|
if None the current storage policy is retained.</p></li>
|
|||
|
|
<li><p><strong>disks</strong> ((<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.storage_client.Policy.DiskPolicySpec" title="com.vmware.vcenter.vm.storage_client.Policy.DiskPolicySpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Policy.DiskPolicySpec</span></code></a>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Storage policy or policies to be used when reconfiguring virtual
|
|||
|
|
machine diks. This attribute was added in vSphere API 6.7.
|
|||
|
|
When clients pass a value of this class as a parameter, the key in
|
|||
|
|
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>. When methods return
|
|||
|
|
a value of this class as a return value, the key in the attribute
|
|||
|
|
<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>.
|
|||
|
|
if None the current storage policy is retained.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.storage_client.Policy.VmHomePolicySpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">VmHomePolicySpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">policy</span><span class="o">=</span><span class="default_value">None</span></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="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.storage_client.Policy.VmHomePolicySpec.PolicyType" title="com.vmware.vcenter.vm.storage_client.Policy.VmHomePolicySpec.PolicyType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Policy.VmHomePolicySpec.PolicyType</span></code></a>) – Policy type to be used while performing update operation on the
|
|||
|
|
virtual machine home’s directory. This attribute was added in
|
|||
|
|
vSphere API 6.7.</p></li>
|
|||
|
|
<li><p><strong>policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Storage Policy identification. This attribute was added in vSphere
|
|||
|
|
API 6.7.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.StoragePolicy</span></code>. When methods return a value
|
|||
|
|
of this class as a return value, the attribute will be an
|
|||
|
|
identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.StoragePolicy</span></code>.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is
|
|||
|
|
<a class="reference internal" href="#com.vmware.vcenter.vm.storage_client.Policy.VmHomePolicySpec.PolicyType.USE_SPECIFIED_POLICY" title="com.vmware.vcenter.vm.storage_client.Policy.VmHomePolicySpec.PolicyType.USE_SPECIFIED_POLICY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Policy.VmHomePolicySpec.PolicyType.USE_SPECIFIED_POLICY</span></code></a>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.storage_client.Policy.VmHomePolicySpec.PolicyType">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">PolicyType</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></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="admonition-title">Note</p>
|
|||
|
|
<p>This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">PolicyType</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.storage_client.Policy.VmHomePolicySpec.PolicyType.USE_DEFAULT_POLICY">
|
|||
|
|
<code class="sig-name 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="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.storage_client.Policy.VmHomePolicySpec.PolicyType.USE_SPECIFIED_POLICY">
|
|||
|
|
<code class="sig-name 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="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.storage_client.Policy.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><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>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><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></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>Overview of Storage Policy associated with a virtual machine’s home
|
|||
|
|
directory and/or its associated virtual hard disks.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine’s configuration state cannot be accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user does not have the required privileges.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.storage_client.Policy.update">
|
|||
|
|
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></em>, <em class="sig-param"><span class="n">spec</span></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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><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>.</p></li>
|
|||
|
|
<li><p><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.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
|||
|
|
if the system is unable to communicate with a service to complete
|
|||
|
|
the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user is not authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user doesn’t have the required priveleges.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if the storage policy specified is invalid.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
|
|||
|
|
if the virtual machine or disk is busy performing another
|
|||
|
|
operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the virtual machine or disk’s configuration state cannot be
|
|||
|
|
accessed.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.storage_client.StubFactory">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm.storage_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></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>
|
|||
|
|
<p>Initialize StubFactoryBase</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div class="section" id="module-com.vmware.vcenter.vm.tools_client">
|
|||
|
|
<span id="com-vmware-vcenter-vm-tools-client-module"></span><h2>com.vmware.vcenter.vm.tools_client module<a class="headerlink" href="#module-com.vmware.vcenter.vm.tools_client" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm_client</span></code> module provides classes for managing
|
|||
|
|
VMware Tools.</p>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.tools_client.Installer">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm.tools_client.</code><code class="sig-name descname">Installer</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.tools_client.Installer" 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">Installer</span></code> (\@term service} provides methods to install VMware
|
|||
|
|
Tools in the guest operating system. This class was added in vSphere API
|
|||
|
|
7.0.0.0.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.tools_client.Installer.Info">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">is_connected</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.tools_client.Installer.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">Installer.Info</span></code> class contains information about the VMWare Tools
|
|||
|
|
installer. This class was added in vSphere API 7.0.0.0.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>is_connected</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag indicating whether the VMware Tools installer is mounted as a
|
|||
|
|
CD-ROM. This attribute was added in vSphere API 7.0.0.0.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.tools_client.Installer.connect">
|
|||
|
|
<code class="sig-name descname">connect</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.tools_client.Installer.connect" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Connects the VMware Tools CD installer as a CD-ROM for the guest
|
|||
|
|
operating system. On Windows guest operating systems with autorun, this
|
|||
|
|
should cause the installer to initiate the Tools installation which
|
|||
|
|
will need user input to complete. On other (non-Windows) guest
|
|||
|
|
operating systems this will make the Tools installation available, and
|
|||
|
|
a a user will need to do guest-specific actions. On Linux, this
|
|||
|
|
includes opening an archive and running the installer. To monitor the
|
|||
|
|
status of the Tools install, clients should check the <code class="docutils literal notranslate"><span class="pre">versionStatus</span></code>
|
|||
|
|
and <code class="docutils literal notranslate"><span class="pre">runState</span></code> from <a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.vm_client.Tools.get" title="com.vmware.vcenter.vm_client.Tools.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm_client.Tools.get()</span></code></a>.
|
|||
|
|
This method was added in vSphere API 7.0.0.0.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine ID
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the virtual machine is not powered on.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyInDesiredState" title="com.vmware.vapi.std.errors_client.AlreadyInDesiredState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code></a>
|
|||
|
|
if the VMware Tools CD is already connected.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the Tools installation fails in the guest operating system.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.tools_client.Installer.disconnect">
|
|||
|
|
<code class="sig-name descname">disconnect</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.tools_client.Installer.disconnect" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Disconnect the VMware Tools installer CD image. This method was added
|
|||
|
|
in vSphere API 7.0.0.0.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual machine ID
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if the virtual machine is not powered on.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.tools_client.Installer.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.tools_client.Installer.get" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Get information about the VMware Tools installer. This method was added
|
|||
|
|
in vSphere API 7.0.0.0.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><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>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.vm.tools_client.Installer.Info" title="com.vmware.vcenter.vm.tools_client.Installer.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Installer.Info</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>information about the VMware Tools installer.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the virtual machine is not found.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.vm.tools_client.StubFactory">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.vm.tools_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.tools_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>
|
|||
|
|
<p>Initialize StubFactoryBase</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<footer>
|
|||
|
|
|
|||
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|||
|
|
|
|||
|
|
<a href="com.vmware.vcenter.vm.guest.html" class="btn btn-neutral float-right" title="com.vmware.vcenter.vm.guest package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a href="com.vmware.vcenter.vcha.html" class="btn btn-neutral float-left" title="com.vmware.vcenter.vcha package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<hr/>
|
|||
|
|
|
|||
|
|
<div role="contentinfo">
|
|||
|
|
<p>
|
|||
|
|
|
|||
|
|
© Copyright 2020, VMware, Inc.
|
|||
|
|
|
|||
|
|
</p>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
|
|||
|
|
|
|||
|
|
<a href="https://github.com/rtfd/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">
|
|||
|
|
jQuery(function () {
|
|||
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|||
|
|
});
|
|||
|
|
</script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</body>
|
|||
|
|
</html>
|