Mirrors/vsphere-automation-sdk-python
1
0
Fork 0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-22 17:39:59 -05:00
Code
3f7afe83b7
vsphere-automation-sdk-python/vsphere/8.0.0.0/com.vmware.vcenter.vm.hardware.html

1691 lines
142 KiB
HTML
Raw Normal View History

Doc Update for M19 and vSphere 8.0.0.0 Signed-off-by: Shweta Purohit <spurohit@vmware.com>
2022-07-14 08:07:12 -04:00
<!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.hardware package &mdash; vSphere Automation SDK for Python. 8.0.0.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 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.storage package" href="com.vmware.vcenter.vm.storage.html" />
<link rel="prev" title="com.vmware.vcenter.vm.guest package" href="com.vmware.vcenter.vm.guest.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"> vSphere Automation SDK for Python.
</a>
<div class="version">
8.0.0.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.oauth2_client">com.vmware.oauth2_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> &raquo;</li>
<li><a href="com.html">com package</a> &raquo;</li>
<li><a href="com.vmware.html">com.vmware package</a> &raquo;</li>
<li><a href="com.vmware.vcenter.html">com.vmware.vcenter package</a> &raquo;</li>
<li><a href="com.vmware.vcenter.vm.html">com.vmware.vcenter.vm package</a> &raquo;</li>
<li>com.vmware.vcenter.vm.hardware package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/com.vmware.vcenter.vm.hardware.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.hardware">
<span id="com-vmware-vcenter-vm-hardware-package"></span><h1>com.vmware.vcenter.vm.hardware package<a class="headerlink" href="#module-com.vmware.vcenter.vm.hardware" title="Permalink to this headline"></a></h1>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="module-com.vmware.vcenter.vm.hardware.adapter_client">
<span id="com-vmware-vcenter-vm-hardware-adapter-client-module"></span><h2>com.vmware.vcenter.vm.hardware.adapter_client module<a class="headerlink" href="#module-com.vmware.vcenter.vm.hardware.adapter_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.adapter_client</span></code> module provides classes
for managing the configuration and state of the virtual adapters belonging to a
virtual machine. This includes methods for reading and manipulating the
conifguration of USB adapters and host bus adapters.</p>
<p>Note that classes for adapters with no configurable properties or runtime
state, such as IDE and PCI adapters, are omitted.</p>
<dl class="py class">
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Nvme">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.vm.hardware.adapter_client.</span></code><code class="sig-name descname"><span class="pre">Nvme</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Nvme" 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">Nvme</span></code> class provides methods for configuring the virtual NVMe
adapters of a virtual machine. This class was added in vSphere API 7.0.0.1.</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.adapter_client.Nvme.CreateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pci_slot_number</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Nvme.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">Nvme.CreateSpec</span></code> class provides a specification for the
configuration of a newly-created virtual NVMe adapter. This class was added
in vSphere API 7.0.0.1.</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> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – NVMe bus number. This attribute was added in vSphere API 7.0.0.1.
If None, the server will choose an available bus number; if none is
available, the request will fail.</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 NVMe adapter on the PCI bus. This attribute was
added in vSphere API 7.0.0.1.
If None, the server will choose an available address when the
virtual machine is powered on.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Nvme.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">label</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bus</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pci_slot_number</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Nvme.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">Nvme.Info</span></code> class contains information about a virtual NVMe adapter.
This class was added in vSphere API 7.0.0.1.</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. This attribute was added in vSphere API 7.0.0.1.</p></li>
<li><p><strong>bus</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – NVMe bus number. This attribute was added in vSphere API 7.0.0.1.</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 NVMe adapter on the PCI bus. This attribute was
added in vSphere API 7.0.0.1.
May be None if the virtual machine has never been powered on since
the adapter was created.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Nvme.RESOURCE_TYPE">
<code class="sig-name descname"><span class="pre">RESOURCE_TYPE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.vcenter.vm.hardware.NvmeAdapter'</span></em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Nvme.RESOURCE_TYPE" title="Permalink to this definition"></a></dt>
<dd><p>Resource type for the virtual NVMe adapter device. This class attribute was
added in vSphere API 7.0.0.1.</p>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Nvme.Summary">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Summary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">adapter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Nvme.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">Nvme.Summary</span></code> class contains commonly used information about a
Virtual NVMe adapter. This class was added in vSphere API 7.0.0.1.</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>adapter</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the virtual NVMe adapter. This attribute was added in
vSphere API 7.0.0.1.
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.NvmeAdapter</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.NvmeAdapter</span></code>.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Nvme.create">
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Nvme.create" title="Permalink to this definition"></a></dt>
<dd><p>Adds a virtual NVMe adapter to the virtual machine. This method was
added in vSphere API 7.0.0.1.</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.adapter_client.Nvme.CreateSpec" title="com.vmware.vcenter.vm.hardware.adapter_client.Nvme.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Nvme.CreateSpec</span></code></a>) – Specification for the new virtual NVMe 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 NVMe 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.NvmeAdapter</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.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 NVMe 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-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.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.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 there are no more available NVMe buses on the virtual machine.</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 NVMe bus or PCI 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 NVMe bus or PCI 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.adapter_client.Nvme.delete">
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">adapter</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Nvme.delete" title="Permalink to this definition"></a></dt>
<dd><p>Removes a virtual NVMe adapter from the virtual machine. This method
was added in vSphere API 7.0.0.1.</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>adapter</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual NVMe 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.NvmeAdapter</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.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-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 virtual NVMe adapter 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>
<dl class="py method">
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Nvme.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">adapter</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Nvme.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns information about a virtual NVMe adapter. This method was added
in vSphere API 7.0.0.1.</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>adapter</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual NVMe 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.NvmeAdapter</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.adapter_client.Nvme.Info" title="com.vmware.vcenter.vm.hardware.adapter_client.Nvme.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Nvme.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Information about the specified virtual NVMe 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 NVMe 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.adapter_client.Nvme.list">
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Nvme.list" title="Permalink to this definition"></a></dt>
<dd><p>Returns commonly used information about the virtual NVMe adapters
belonging to the virtual machine. This method was added in vSphere API
7.0.0.1.</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.adapter_client.Nvme.list" title="com.vmware.vcenter.vm.hardware.adapter_client.Nvme.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.adapter_client.Nvme.Summary" title="com.vmware.vcenter.vm.hardware.adapter_client.Nvme.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Nvme.Summary</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>List of commonly used information about virtual NVMe 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>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Sata">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.vm.hardware.adapter_client.</span></code><code class="sig-name descname"><span class="pre">Sata</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Sata" 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">Sata</span></code> class provides methods for configuring the virtual SATA
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.adapter_client.Sata.CreateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bus</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pci_slot_number</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Sata.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">Sata.CreateSpec</span></code> class provides a specification for the
configuration of a newly-created virtual SATA 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.adapter_client.Sata.Type" title="com.vmware.vcenter.vm.hardware.adapter_client.Sata.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Sata.Type</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Adapter type.
If None, a guest-specific default value will be used.</p></li>
<li><p><strong>bus</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>) – SATA bus number.
If None, the server will choose an available bus number; if none is
available, the request will fail.</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 SATA adapter on the PCI bus.
If None, the server will choose an available address when the
virtual machine is powered on.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Sata.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">label</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bus</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pci_slot_number</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Sata.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">Sata.Info</span></code> class contains information about a virtual SATA 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.adapter_client.Sata.Type" title="com.vmware.vcenter.vm.hardware.adapter_client.Sata.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Sata.Type</span></code></a>) – Adapter type.</p></li>
<li><p><strong>bus</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – SATA bus number.</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 SATA adapter on the PCI bus.
May be None if the virtual machine has never been powered on since
the adapter was created.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Sata.RESOURCE_TYPE">
<code class="sig-name descname"><span class="pre">RESOURCE_TYPE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.vcenter.vm.hardware.SataAdapter'</span></em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Sata.RESOURCE_TYPE" title="Permalink to this definition"></a></dt>
<dd><p>Resource type for the virtual SATA adapter device.</p>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Sata.Summary">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Summary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">adapter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Sata.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">Sata.Summary</span></code> class contains commonly used information about a
Virtual SATA 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>adapter</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the virtual SATA 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.SataAdapter</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.SataAdapter</span></code>.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Sata.Type">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Type</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Sata.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">Sata.Type</span></code> class defines the valid emulation types for a virtual
SATA 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">Type</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Sata.Type.AHCI">
<code class="sig-name descname"><span class="pre">AHCI</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Type(string='AHCI')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Sata.Type.AHCI" title="Permalink to this definition"></a></dt>
<dd><p>AHCI host bus adapter.</p>
</dd></dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Sata.create">
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Sata.create" title="Permalink to this definition"></a></dt>
<dd><p>Adds a virtual SATA 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.adapter_client.Sata.CreateSpec" title="com.vmware.vcenter.vm.hardware.adapter_client.Sata.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Sata.CreateSpec</span></code></a>) – Specification for the new virtual SATA 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 SATA 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.SataAdapter</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.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 SATA 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-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.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.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 there are no more available SATA buses on the virtual machine.</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 SATA bus or PCI 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 SATA bus or PCI 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.adapter_client.Sata.delete">
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">adapter</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Sata.delete" title="Permalink to this definition"></a></dt>
<dd><p>Removes a virtual SATA 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>adapter</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual SATA 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.SataAdapter</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.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-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 virtual SATA adapter 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>
<dl class="py method">
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Sata.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">adapter</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Sata.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns information about a virtual SATA 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>adapter</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual SATA 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.SataAdapter</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.adapter_client.Sata.Info" title="com.vmware.vcenter.vm.hardware.adapter_client.Sata.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Sata.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Information about the specified virtual SATA 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 SATA 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.adapter_client.Sata.list">
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Sata.list" title="Permalink to this definition"></a></dt>
<dd><p>Returns commonly used information about the virtual SATA 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.adapter_client.Sata.list" title="com.vmware.vcenter.vm.hardware.adapter_client.Sata.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.adapter_client.Sata.Summary" title="com.vmware.vcenter.vm.hardware.adapter_client.Sata.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Sata.Summary</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>List of commonly used information about virtual SATA 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>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Scsi">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.vm.hardware.adapter_client.</span></code><code class="sig-name descname"><span class="pre">Scsi</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi" 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">Scsi</span></code> class provides methods for configuring the virtual SCSI
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.adapter_client.Scsi.CreateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bus</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pci_slot_number</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sharing</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.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">Scsi.CreateSpec</span></code> class provides a specification for the
configuration of a newly-created virtual SCSI 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.adapter_client.Scsi.Type" title="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Scsi.Type</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Adapter type.
If None, a guest-specific default value will be used.</p></li>
<li><p><strong>bus</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>) – SCSI bus number.
If None, the server will choose an available bus number; if none is
available, the request will fail.</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 SCSI 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.
If None, the server will choose an available address when the
virtual machine is powered on.</p></li>
<li><p><strong>sharing</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Sharing" title="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Sharing"><code class="xref py py-class docutils literal notranslate"><span class="pre">Scsi.Sharing</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Bus sharing mode.
If None, the adapter will default to <a class="reference internal" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Sharing.NONE" title="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Sharing.NONE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Scsi.Sharing.NONE</span></code></a>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">label</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scsi</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pci_slot_number</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sharing</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.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">Scsi.Info</span></code> class contains information about a virtual SCSI 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.adapter_client.Scsi.Type" title="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Scsi.Type</span></code></a>) – Adapter type.</p></li>
<li><p><strong>scsi</strong> (<a class="reference internal" href="com.vmware.vcenter.vm.html#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">com.vmware.vcenter.vm.hardware_client.ScsiAddressInfo</span></code></a>) – Address of the SCSI adapter on the SCSI bus.</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 SCSI 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>sharing</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Sharing" title="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Sharing"><code class="xref py py-class docutils literal notranslate"><span class="pre">Scsi.Sharing</span></code></a>) – Bus sharing mode.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.RESOURCE_TYPE">
<code class="sig-name descname"><span class="pre">RESOURCE_TYPE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.vcenter.vm.hardware.ScsiAdapter'</span></em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.RESOURCE_TYPE" title="Permalink to this definition"></a></dt>
<dd><p>Resource type for the virtual SCSI adapter device.</p>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Sharing">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Sharing</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Sharing" 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">Scsi.Sharing</span></code> class defines the valid bus sharing modes for a
virtual SCSI 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">Sharing</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Sharing.NONE">
<code class="sig-name descname"><span class="pre">NONE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Sharing(string='NONE')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Sharing.NONE" title="Permalink to this definition"></a></dt>
<dd><p>The virtual SCSI bus is not shared.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Sharing.PHYSICAL">
<code class="sig-name descname"><span class="pre">PHYSICAL</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Sharing(string='PHYSICAL')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Sharing.PHYSICAL" title="Permalink to this definition"></a></dt>
<dd><p>The virtual SCSI bus is shared between two or more virtual machines
residing on different physical hosts.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Sharing.VIRTUAL">
<code class="sig-name descname"><span class="pre">VIRTUAL</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Sharing(string='VIRTUAL')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Sharing.VIRTUAL" title="Permalink to this definition"></a></dt>
<dd><p>The virtual SCSI bus is shared between two or more virtual machines. In
this case, no physical machine is involved.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Summary">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Summary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">adapter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.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">Scsi.Summary</span></code> class contains commonly used information about a
Virtual SCSI 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>adapter</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the virtual SCSI 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.ScsiAdapter</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.ScsiAdapter</span></code>.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Type">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Type</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.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">Scsi.Type</span></code> class defines the valid emulation types for a virtual
SCSI 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">Type</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Type.BUSLOGIC">
<code class="sig-name descname"><span class="pre">BUSLOGIC</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Type(string='BUSLOGIC')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Type.BUSLOGIC" title="Permalink to this definition"></a></dt>
<dd><p>BusLogic host bus adapter.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Type.LSILOGIC">
<code class="sig-name descname"><span class="pre">LSILOGIC</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Type(string='LSILOGIC')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Type.LSILOGIC" title="Permalink to this definition"></a></dt>
<dd><p>LSI Logic host bus adapter.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Type.LSILOGICSAS">
<code class="sig-name descname"><span class="pre">LSILOGICSAS</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Type(string='LSILOGICSAS')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Type.LSILOGICSAS" title="Permalink to this definition"></a></dt>
<dd><p>LSI Logic SAS 1068 host bus adapter.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Type.PVSCSI">
<code class="sig-name descname"><span class="pre">PVSCSI</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Type(string='PVSCSI')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Type.PVSCSI" title="Permalink to this definition"></a></dt>
<dd><p>Paravirtualized host bus adapter.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.UpdateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">UpdateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sharing</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.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">Scsi.UpdateSpec</span></code> class describes the updates to be made to the
configuration of a virtual SCSI 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>sharing</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Sharing" title="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Sharing"><code class="xref py py-class docutils literal notranslate"><span class="pre">Scsi.Sharing</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Bus sharing mode.</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 method">
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.create">
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.create" title="Permalink to this definition"></a></dt>
<dd><p>Adds a virtual SCSI 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.adapter_client.Scsi.CreateSpec" title="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Scsi.CreateSpec</span></code></a>) – Specification for the new virtual SCSI 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 SCSI 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.ScsiAdapter</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 SCSI 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.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.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.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 there are no more available SCSI buses on the virtual machine.</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 SCSI bus 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 SATA bus or PCI 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.adapter_client.Scsi.delete">
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">adapter</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.delete" title="Permalink to this definition"></a></dt>
<dd><p>Removes a virtual SCSI 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>adapter</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual SCSI 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.ScsiAdapter</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.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-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 virtual SCSI adapter 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>
<dl class="py method">
<dt id="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">adapter</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns information about a virtual SCSI 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>adapter</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual SCSI 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.ScsiAdapter</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.adapter_client.Scsi.Info" title="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Scsi.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Information about the specified virtual SCSI 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 SCSI 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.adapter_client.Scsi.list">
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.list" title="Permalink to this definition"></a></dt>
<dd><p>Returns commonly used information about the virtual SCSI 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.adapter_client.Scsi.list" title="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.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.adapter_client.Scsi.Summary" title="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Scsi.Summary</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>List of commonly used information about virtual SCSI 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.adapter_client.Scsi.update">
<code class="sig-name descname"><span class="pre">update</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">adapter</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.update" title="Permalink to this definition"></a></dt>
<dd><p>Updates the configuration of a virtual SCSI 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>adapter</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual SCSI 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.ScsiAdapter</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm.hardware.adapter_client.Scsi.UpdateSpec" title="com.vmware.vcenter.vm.hardware.adapter_client.Scsi.UpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Scsi.UpdateSpec</span></code></a>) – Specification for updating the virtual SCSI 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.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 SCSI 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.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 SCSI
adapter.</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.adapter_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.vm.hardware.adapter_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.adapter_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.boot_client">
<span id="com-vmware-vcenter-vm-hardware-boot-client-module"></span><h2>com.vmware.vcenter.vm.hardware.boot_client module<a class="headerlink" href="#module-com.vmware.vcenter.vm.hardware.boot_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.boot_client</span></code> module provides classes for
managing the virtual devices used to boot a virtual machine.</p>
<dl class="py class">
<dt id="com.vmware.vcenter.vm.hardware.boot_client.Device">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.vm.hardware.boot_client.</span></code><code class="sig-name descname"><span class="pre">Device</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.boot_client.Device" 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">Device</span></code> class provides methods for configuring the device order used
when booting a virtual machine.</p>
<p>The boot order may be specified using a mixture of device classes and
device instances, chosen from among the following:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#com.vmware.vcenter.vm.hardware.boot_client.Device.Type.CDROM" title="com.vmware.vcenter.vm.hardware.boot_client.Device.Type.CDROM"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Device.Type.CDROM</span></code></a>: Boot from a virtual CD-ROM drive; the device
instance(s) will be chosen by the BIOS subsystem.</p></li>
<li><p><a class="reference internal" href="#com.vmware.vcenter.vm.hardware.boot_client.Device.Type.FLOPPY" title="com.vmware.vcenter.vm.hardware.boot_client.Device.Type.FLOPPY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Device.Type.FLOPPY</span></code></a>: Boot from a virtual floppy drive; the device
instance(s) will be chosen by the BIOS subsystem.</p></li>
<li><p><a class="reference internal" href="#com.vmware.vcenter.vm.hardware.boot_client.Device.Type.DISK" title="com.vmware.vcenter.vm.hardware.boot_client.Device.Type.DISK"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Device.Type.DISK</span></code></a>: Boot from a virtual disk device; the device
instance is specified explicitly in <code class="xref py py-attr docutils literal notranslate"><span class="pre">Device.Entry.disks</span></code> list, and
multiple instances may be specified in the list.</p></li>
<li><p><a class="reference internal" href="#com.vmware.vcenter.vm.hardware.boot_client.Device.Type.ETHERNET" title="com.vmware.vcenter.vm.hardware.boot_client.Device.Type.ETHERNET"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Device.Type.ETHERNET</span></code></a>: Boot from a virtual Ethernet adapter; the
device instance is specified explicitly as <code class="xref py py-attr docutils literal notranslate"><span class="pre">Device.Entry.nic</span></code>, and
multiple adapters may be specified in the boot order list.</p></li>
</ul>
<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.boot_client.Device.Entry">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Entry</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nic</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">disks</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.boot_client.Device.Entry" 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">Device.Entry</span></code> class specifies a bootable virtual device class or
specific bootable virtual device(s).</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.boot_client.Device.Type" title="com.vmware.vcenter.vm.hardware.boot_client.Device.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Device.Type</span></code></a>) – Virtual device type.</p></li>
<li><p><strong>nic</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Virtual Ethernet device. Ethernet device to use as boot device for
this entry.
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>.
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.boot_client.Device.Type.ETHERNET" title="com.vmware.vcenter.vm.hardware.boot_client.Device.Type.ETHERNET"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Device.Type.ETHERNET</span></code></a>.</p></li>
<li><p><strong>disks</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>) – Virtual disk device. List of virtual disks in boot order.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers 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 contain
identifiers for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</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.hardware.boot_client.Device.Type.DISK" title="com.vmware.vcenter.vm.hardware.boot_client.Device.Type.DISK"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Device.Type.DISK</span></code></a>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm.hardware.boot_client.Device.EntryCreateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">EntryCreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.boot_client.Device.EntryCreateSpec" 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 class <code class="docutils literal notranslate"><span class="pre">Device.EntryCreateSpec</span></code> specifies a list of bootable virtual
device classes. When a VM is being created and a <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of
<code class="docutils literal notranslate"><span class="pre">Device.EntryCreateSpec</span></code> is specified, the boot order of the specific
device instances are not specified in this class. The boot order of the
specific device instance will be the order in which the Ethernet and Disk
devices appear in the <code class="docutils literal notranslate"><span class="pre">nics</span></code> and <code class="docutils literal notranslate"><span class="pre">disks</span></code> respectively.</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.hardware.boot_client.Device.Type" title="com.vmware.vcenter.vm.hardware.boot_client.Device.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Device.Type</span></code></a>) – Virtual Boot device type.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm.hardware.boot_client.Device.Type">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Type</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.boot_client.Device.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">Device.Type</span></code> class defines the valid device types that may be used
as bootable devices.</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.boot_client.Device.Type.CDROM">
<code class="sig-name descname"><span class="pre">CDROM</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Type(string='CDROM')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.boot_client.Device.Type.CDROM" title="Permalink to this definition"></a></dt>
<dd><p>Virtual CD-ROM device.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm.hardware.boot_client.Device.Type.DISK">
<code class="sig-name descname"><span class="pre">DISK</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Type(string='DISK')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.boot_client.Device.Type.DISK" title="Permalink to this definition"></a></dt>
<dd><p>Virtual disk device.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm.hardware.boot_client.Device.Type.ETHERNET">
<code class="sig-name descname"><span class="pre">ETHERNET</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Type(string='ETHERNET')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.boot_client.Device.Type.ETHERNET" title="Permalink to this definition"></a></dt>
<dd><p>Virtual Ethernet adapter.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm.hardware.boot_client.Device.Type.FLOPPY">
<code class="sig-name descname"><span class="pre">FLOPPY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Type(string='FLOPPY')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.boot_client.Device.Type.FLOPPY" title="Permalink to this definition"></a></dt>
<dd><p>Virtual floppy drive.</p>
</dd></dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.vm.hardware.boot_client.Device.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.boot_client.Device.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns an ordered list of boot devices for the virtual machine. If the
<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> is empty, the virtual machine uses a default boot
sequence.</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><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.hardware.boot_client.Device.Entry" title="com.vmware.vcenter.vm.hardware.boot_client.Device.Entry"><code class="xref py py-class docutils literal notranslate"><span class="pre">Device.Entry</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Ordered list of configured boot 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.boot_client.Device.set">
<code class="sig-name descname"><span class="pre">set</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">devices</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.boot_client.Device.set" title="Permalink to this definition"></a></dt>
<dd><p>Sets the virtual devices that will be used to boot the virtual machine.
The virtual machine will check the devices in order, attempting to boot
from each, until the virtual machine boots successfully. If the
<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> is empty, the virtual machine will use a default boot
sequence. There should be no more than one instance of
<a class="reference internal" href="#com.vmware.vcenter.vm.hardware.boot_client.Device.Entry" title="com.vmware.vcenter.vm.hardware.boot_client.Device.Entry"><code class="xref py py-class docutils literal notranslate"><span class="pre">Device.Entry</span></code></a> for a given device type except
<a class="reference internal" href="#com.vmware.vcenter.vm.hardware.boot_client.Device.Type.ETHERNET" title="com.vmware.vcenter.vm.hardware.boot_client.Device.Type.ETHERNET"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Device.Type.ETHERNET</span></code></a> in the <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code>.</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>devices</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.hardware.boot_client.Device.Entry" title="com.vmware.vcenter.vm.hardware.boot_client.Device.Entry"><code class="xref py py-class docutils literal notranslate"><span class="pre">Device.Entry</span></code></a>) – Ordered list of boot devices.</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, or if any of the specified
virtual devices 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 a any of the CDROM, DISK, ETHERNET, FLOPPY values appears in
more than one <code class="docutils literal notranslate"><span class="pre">Device.Entry</span></code> with the exception of
<a class="reference internal" href="#com.vmware.vcenter.vm.hardware.boot_client.Device.Type.ETHERNET" title="com.vmware.vcenter.vm.hardware.boot_client.Device.Type.ETHERNET"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Device.Type.ETHERNET</span></code></a>, which may appear multiple times if
the virtual machine has been configured with multiple Ethernet
adapters.</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.boot_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.vm.hardware.boot_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm.hardware.boot_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.storage.html" class="btn btn-neutral float-right" title="com.vmware.vcenter.vm.storage package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="com.vmware.vcenter.vm.guest.html" class="btn btn-neutral float-left" title="com.vmware.vcenter.vm.guest package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; Copyright 2022, VMware, Inc..
</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/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>
Copy Permalink