mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-29 20:09:58 -05:00
2335 lines
197 KiB
HTML
2335 lines
197 KiB
HTML
|
|
|||
|
|
|
|||
|
|
<!DOCTYPE html>
|
|||
|
|
<html class="writer-html5" lang="en" >
|
|||
|
|
<head>
|
|||
|
|
<meta charset="utf-8">
|
|||
|
|
|
|||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|||
|
|
|
|||
|
|
<title>com.vmware.vapi.std package — vSphere Automation SDK for Python. 7.0.1.0 documentation</title>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
|||
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<!--[if lt IE 9]>
|
|||
|
|
<script src="_static/js/html5shiv.min.js"></script>
|
|||
|
|
<![endif]-->
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
|||
|
|
<script src="_static/jquery.js"></script>
|
|||
|
|
<script src="_static/underscore.js"></script>
|
|||
|
|
<script src="_static/doctools.js"></script>
|
|||
|
|
<script src="_static/language_data.js"></script>
|
|||
|
|
|
|||
|
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<link rel="index" title="Index" href="genindex.html" />
|
|||
|
|
<link rel="search" title="Search" href="search.html" />
|
|||
|
|
<link rel="next" title="com.vmware.vcenter package" href="com.vmware.vcenter.html" />
|
|||
|
|
<link rel="prev" title="com.vmware.vapi.metadata.privilege package" href="com.vmware.vapi.metadata.privilege.html" />
|
|||
|
|
</head>
|
|||
|
|
|
|||
|
|
<body class="wy-body-for-nav">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="wy-grid-for-nav">
|
|||
|
|
|
|||
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|||
|
|
<div class="wy-side-scroll">
|
|||
|
|
<div class="wy-side-nav-search" >
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a href="index.html" class="icon icon-home" alt="Documentation Home"> vSphere Automation SDK for Python.
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="version">
|
|||
|
|
7.0.1.0
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div role="search">
|
|||
|
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
|||
|
|
<input type="text" name="q" placeholder="Search docs" />
|
|||
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|||
|
|
<input type="hidden" name="area" value="default" />
|
|||
|
|
</form>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<p class="caption"><span class="caption-text">Contents:</span></p>
|
|||
|
|
<ul class="current">
|
|||
|
|
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
|
|||
|
|
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
|
|||
|
|
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
|||
|
|
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="vmware.html">vmware package</a></li>
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<nav class="wy-nav-top" aria-label="top navigation">
|
|||
|
|
|
|||
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|||
|
|
<a href="index.html">vSphere Automation SDK for Python.</a>
|
|||
|
|
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="wy-nav-content">
|
|||
|
|
|
|||
|
|
<div class="rst-content">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
|||
|
|
|
|||
|
|
<ul class="wy-breadcrumbs">
|
|||
|
|
|
|||
|
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.html">com package</a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.vmware.html">com.vmware package</a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.vmware.vapi.html">com.vmware.vapi package</a> »</li>
|
|||
|
|
|
|||
|
|
<li>com.vmware.vapi.std package</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="wy-breadcrumbs-aside">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a href="_sources/com.vmware.vapi.std.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.vapi.std">
|
|||
|
|
<span id="com-vmware-vapi-std-package"></span><h1>com.vmware.vapi.std package<a class="headerlink" href="#module-com.vmware.vapi.std" 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.vapi.std.errors_client">
|
|||
|
|
<span id="com-vmware-vapi-std-errors-client-module"></span><h2>com.vmware.vapi.std.errors_client module<a class="headerlink" href="#module-com.vmware.vapi.std.errors_client" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client</span></code> module provides the standard
|
|||
|
|
exceptions that can be included in the list of exceptions in the specification
|
|||
|
|
of methods to indicate that the method might report those exceptions. It also
|
|||
|
|
provides some classes intended to be used as payload to provide additional
|
|||
|
|
information about those exceptions.</p>
|
|||
|
|
<dl class="py exception">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.AlreadyExists">
|
|||
|
|
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">AlreadyExists</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">messages</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">data</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">error_type</span><span class="o">=</span><span class="default_value">'ALREADY_EXISTS'</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.AlreadyExists" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">AlreadyExists</span></code> exception indicates that an attempt was made to
|
|||
|
|
create an entity but the entity already exists. Typically the entity has a
|
|||
|
|
name or identifier that is required to be unique in some context, but there
|
|||
|
|
is already an entity with that name or identifier in that context.</p>
|
|||
|
|
<blockquote>
|
|||
|
|
<div><p>Examples:</p>
|
|||
|
|
</div></blockquote>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>Trying to create a new tag category when a tag category with the
|
|||
|
|
specified name already exists.</p></li>
|
|||
|
|
<li><p>Trying to create a new tag in tag category when a tag with the specified
|
|||
|
|
name already exists the tag category.</p></li>
|
|||
|
|
<li><p>Trying to create a LUN with a specific UUID on a node (for replication
|
|||
|
|
purposes) when a LUN with that UUID already exists on the node.</p></li>
|
|||
|
|
<li><p>Trying to create a file in a directory or move or copy a file to a
|
|||
|
|
directory when a file with that name already exists in the directory.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
<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>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – <p>Stack of one or more localizable messages for human exception
|
|||
|
|
consumers.</p>
|
|||
|
|
<p>The message at the top of the stack (first in the list) describes
|
|||
|
|
the exception from the perspective of the method the client
|
|||
|
|
invoked. Each subsequent message in the stack describes the “cause”
|
|||
|
|
of the prior message.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>data</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Data to facilitate clients responding to the method reporting a
|
|||
|
|
standard exception to indicating that it was unable to complete
|
|||
|
|
successfully.</p>
|
|||
|
|
<p>Methods may provide data that clients can use when responding to
|
|||
|
|
exceptions. Since the data that clients need may be specific to the
|
|||
|
|
context of the method reporting the exception, different methods
|
|||
|
|
that report the same exception may provide different data in the
|
|||
|
|
exception. The documentation for each each method will describe
|
|||
|
|
what, if any, data it provides for each exception it reports. The
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.ArgumentLocations" title="com.vmware.vapi.std.errors_client.ArgumentLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentLocations</span></code></a>, <a class="reference internal" href="#com.vmware.vapi.std.errors_client.FileLocations" title="com.vmware.vapi.std.errors_client.FileLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileLocations</span></code></a>, and
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.TransientIndication" title="com.vmware.vapi.std.errors_client.TransientIndication"><code class="xref py py-class docutils literal notranslate"><span class="pre">TransientIndication</span></code></a> classes are intended as possible
|
|||
|
|
values for this attribute.
|
|||
|
|
<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> may also be useful as
|
|||
|
|
a value for this attribute (although that is not its primary
|
|||
|
|
purpose). Some classes may provide their own specific classes for
|
|||
|
|
use as the value of this attribute when reporting exceptions from
|
|||
|
|
their methods.
|
|||
|
|
Some methods will not set this attribute when reporting exceptions.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>error_type</strong> (<a class="reference internal" href="#com.vmware.vapi.std.errors_client.Error.Type" title="com.vmware.vapi.std.errors_client.Error.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error.Type</span></code></a>) – Discriminator field to help API consumers identify the structure
|
|||
|
|
type. This attribute was added in vSphere API 6.7.2.
|
|||
|
|
Can be None for compatibility with preceding implementations.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py exception">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.AlreadyInDesiredState">
|
|||
|
|
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">AlreadyInDesiredState</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">messages</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">data</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">error_type</span><span class="o">=</span><span class="default_value">'ALREADY_IN_DESIRED_STATE'</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.AlreadyInDesiredState" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">AlreadyInDesiredState</span></code> exception indicates that an attempt to change
|
|||
|
|
the state of a resource or service had no effect because the resource or
|
|||
|
|
service is already in the desired state.</p>
|
|||
|
|
<blockquote>
|
|||
|
|
<div><p>Examples:</p>
|
|||
|
|
</div></blockquote>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>Trying to power on a virtual machine that is already powered on.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
<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>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – <p>Stack of one or more localizable messages for human exception
|
|||
|
|
consumers.</p>
|
|||
|
|
<p>The message at the top of the stack (first in the list) describes
|
|||
|
|
the exception from the perspective of the method the client
|
|||
|
|
invoked. Each subsequent message in the stack describes the “cause”
|
|||
|
|
of the prior message.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>data</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Data to facilitate clients responding to the method reporting a
|
|||
|
|
standard exception to indicating that it was unable to complete
|
|||
|
|
successfully.</p>
|
|||
|
|
<p>Methods may provide data that clients can use when responding to
|
|||
|
|
exceptions. Since the data that clients need may be specific to the
|
|||
|
|
context of the method reporting the exception, different methods
|
|||
|
|
that report the same exception may provide different data in the
|
|||
|
|
exception. The documentation for each each method will describe
|
|||
|
|
what, if any, data it provides for each exception it reports. The
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.ArgumentLocations" title="com.vmware.vapi.std.errors_client.ArgumentLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentLocations</span></code></a>, <a class="reference internal" href="#com.vmware.vapi.std.errors_client.FileLocations" title="com.vmware.vapi.std.errors_client.FileLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileLocations</span></code></a>, and
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.TransientIndication" title="com.vmware.vapi.std.errors_client.TransientIndication"><code class="xref py py-class docutils literal notranslate"><span class="pre">TransientIndication</span></code></a> classes are intended as possible
|
|||
|
|
values for this attribute.
|
|||
|
|
<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> may also be useful as
|
|||
|
|
a value for this attribute (although that is not its primary
|
|||
|
|
purpose). Some classes may provide their own specific classes for
|
|||
|
|
use as the value of this attribute when reporting exceptions from
|
|||
|
|
their methods.
|
|||
|
|
Some methods will not set this attribute when reporting exceptions.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>error_type</strong> (<a class="reference internal" href="#com.vmware.vapi.std.errors_client.Error.Type" title="com.vmware.vapi.std.errors_client.Error.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error.Type</span></code></a>) – Discriminator field to help API consumers identify the structure
|
|||
|
|
type. This attribute was added in vSphere API 6.7.2.
|
|||
|
|
Can be None for compatibility with preceding implementations.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.ArgumentLocations">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">ArgumentLocations</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">primary</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">secondary</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.ArgumentLocations" 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">ArgumentLocations</span></code> class describes which part(s) of the input to the
|
|||
|
|
method caused the exception.</p>
|
|||
|
|
<p>Some types of exceptions are caused by the value of one of the inputs to
|
|||
|
|
the method, possibly due to an interaction with other inputs to the method.
|
|||
|
|
This class is intended to be used as the payload to identify those inputs
|
|||
|
|
when the method reports exceptions like <a class="reference internal" href="#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">InvalidArgument</span></code></a> or
|
|||
|
|
<a class="reference internal" href="#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">NotFound</span></code></a>. See <code class="xref py py-attr docutils literal notranslate"><span class="pre">Error.data</span></code>.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>primary</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String describing the location of the input that triggered the
|
|||
|
|
exception.</p></li>
|
|||
|
|
<li><p><strong>secondary</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>) – <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> (possibly empty) of strings describing the locations
|
|||
|
|
of other inputs that caused the the primary input to trigger the
|
|||
|
|
exception.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py exception">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.Canceled">
|
|||
|
|
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">Canceled</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">messages</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">data</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">error_type</span><span class="o">=</span><span class="default_value">'CANCELED'</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Canceled" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Canceled</span></code> exception indicates that the method canceled itself in
|
|||
|
|
response to an explicit request to do so. Methods being “canceled” for
|
|||
|
|
other reasons (for example the client connection was closed, a time out
|
|||
|
|
occured, or due to excessive resource consumption) should not report this
|
|||
|
|
exception.</p>
|
|||
|
|
<blockquote>
|
|||
|
|
<div><p>Examples:</p>
|
|||
|
|
</div></blockquote>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>A user is monitoring the progress of the method in a GUI and sees that it
|
|||
|
|
is likely to take longer than he is willing to wait and clicks the cancel
|
|||
|
|
button.</p></li>
|
|||
|
|
<li><p>A user invokes the method using a command-line tool and decides that she
|
|||
|
|
didn’t really want to invoke that method, and presses CTRL-c.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
<blockquote>
|
|||
|
|
<div><p>Counterexamples:</p>
|
|||
|
|
</div></blockquote>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>The client’s connection to the server was closed. Reporting an exception
|
|||
|
|
is pointless since the client will not receive the error response because
|
|||
|
|
the connection has been closed.</p></li>
|
|||
|
|
<li><p>The request is taking longer than some amount of time. The
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.TimedOut" title="com.vmware.vapi.std.errors_client.TimedOut"><code class="xref py py-class docutils literal notranslate"><span class="pre">TimedOut</span></code></a> exception would be reported if the time was specified as
|
|||
|
|
part of the input or is documented in the API contract.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
<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>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – <p>Stack of one or more localizable messages for human exception
|
|||
|
|
consumers.</p>
|
|||
|
|
<p>The message at the top of the stack (first in the list) describes
|
|||
|
|
the exception from the perspective of the method the client
|
|||
|
|
invoked. Each subsequent message in the stack describes the “cause”
|
|||
|
|
of the prior message.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>data</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Data to facilitate clients responding to the method reporting a
|
|||
|
|
standard exception to indicating that it was unable to complete
|
|||
|
|
successfully.</p>
|
|||
|
|
<p>Methods may provide data that clients can use when responding to
|
|||
|
|
exceptions. Since the data that clients need may be specific to the
|
|||
|
|
context of the method reporting the exception, different methods
|
|||
|
|
that report the same exception may provide different data in the
|
|||
|
|
exception. The documentation for each each method will describe
|
|||
|
|
what, if any, data it provides for each exception it reports. The
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.ArgumentLocations" title="com.vmware.vapi.std.errors_client.ArgumentLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentLocations</span></code></a>, <a class="reference internal" href="#com.vmware.vapi.std.errors_client.FileLocations" title="com.vmware.vapi.std.errors_client.FileLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileLocations</span></code></a>, and
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.TransientIndication" title="com.vmware.vapi.std.errors_client.TransientIndication"><code class="xref py py-class docutils literal notranslate"><span class="pre">TransientIndication</span></code></a> classes are intended as possible
|
|||
|
|
values for this attribute.
|
|||
|
|
<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> may also be useful as
|
|||
|
|
a value for this attribute (although that is not its primary
|
|||
|
|
purpose). Some classes may provide their own specific classes for
|
|||
|
|
use as the value of this attribute when reporting exceptions from
|
|||
|
|
their methods.
|
|||
|
|
Some methods will not set this attribute when reporting exceptions.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>error_type</strong> (<a class="reference internal" href="#com.vmware.vapi.std.errors_client.Error.Type" title="com.vmware.vapi.std.errors_client.Error.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error.Type</span></code></a>) – Discriminator field to help API consumers identify the structure
|
|||
|
|
type. This attribute was added in vSphere API 6.7.2.
|
|||
|
|
Can be None for compatibility with preceding implementations.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py exception">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.ConcurrentChange">
|
|||
|
|
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">ConcurrentChange</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">messages</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">data</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">error_type</span><span class="o">=</span><span class="default_value">'CONCURRENT_CHANGE'</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.ConcurrentChange" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">ConcurrentChange</span></code> exception indicates that a data structure, entity,
|
|||
|
|
or resource has been modified since some earlier point in time. Typically
|
|||
|
|
this happens when the client is doing the <em>write</em> portion of a
|
|||
|
|
read-modify-write sequence and indicates that it wants the server to notify
|
|||
|
|
it if the data in the server has changed after it did the <em>read</em>, so that
|
|||
|
|
it can avoid overwriting that change inadvertantly.</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>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – <p>Stack of one or more localizable messages for human exception
|
|||
|
|
consumers.</p>
|
|||
|
|
<p>The message at the top of the stack (first in the list) describes
|
|||
|
|
the exception from the perspective of the method the client
|
|||
|
|
invoked. Each subsequent message in the stack describes the “cause”
|
|||
|
|
of the prior message.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>data</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Data to facilitate clients responding to the method reporting a
|
|||
|
|
standard exception to indicating that it was unable to complete
|
|||
|
|
successfully.</p>
|
|||
|
|
<p>Methods may provide data that clients can use when responding to
|
|||
|
|
exceptions. Since the data that clients need may be specific to the
|
|||
|
|
context of the method reporting the exception, different methods
|
|||
|
|
that report the same exception may provide different data in the
|
|||
|
|
exception. The documentation for each each method will describe
|
|||
|
|
what, if any, data it provides for each exception it reports. The
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.ArgumentLocations" title="com.vmware.vapi.std.errors_client.ArgumentLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentLocations</span></code></a>, <a class="reference internal" href="#com.vmware.vapi.std.errors_client.FileLocations" title="com.vmware.vapi.std.errors_client.FileLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileLocations</span></code></a>, and
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.TransientIndication" title="com.vmware.vapi.std.errors_client.TransientIndication"><code class="xref py py-class docutils literal notranslate"><span class="pre">TransientIndication</span></code></a> classes are intended as possible
|
|||
|
|
values for this attribute.
|
|||
|
|
<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> may also be useful as
|
|||
|
|
a value for this attribute (although that is not its primary
|
|||
|
|
purpose). Some classes may provide their own specific classes for
|
|||
|
|
use as the value of this attribute when reporting exceptions from
|
|||
|
|
their methods.
|
|||
|
|
Some methods will not set this attribute when reporting exceptions.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>error_type</strong> (<a class="reference internal" href="#com.vmware.vapi.std.errors_client.Error.Type" title="com.vmware.vapi.std.errors_client.Error.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error.Type</span></code></a>) – Discriminator field to help API consumers identify the structure
|
|||
|
|
type. This attribute was added in vSphere API 6.7.2.
|
|||
|
|
Can be None for compatibility with preceding implementations.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py exception">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.Error">
|
|||
|
|
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">Error</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">messages</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">data</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">error_type</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error" 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.error.VapiError</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Error</span></code> exception describes theattributes common to all standard
|
|||
|
|
exceptions.</p>
|
|||
|
|
<blockquote>
|
|||
|
|
<div><p>This exception serves two purposes:</p>
|
|||
|
|
</div></blockquote>
|
|||
|
|
<ol class="arabic simple">
|
|||
|
|
<li><p>It is the exception that clients in many programming languages can catch
|
|||
|
|
to handle all standard exceptions. Typically those clients will display one
|
|||
|
|
or more of the localizable messages from <code class="xref py py-attr docutils literal notranslate"><span class="pre">Error.messages</span></code> to a human.</p></li>
|
|||
|
|
<li><p>It is the exception that methods can report when they need to report
|
|||
|
|
some exception, but the exception doesn’t fit into any other standard
|
|||
|
|
exception, and in fact the only reasonable way for a client to react to the
|
|||
|
|
exception is to display the message(s) to a human.</p></li>
|
|||
|
|
</ol>
|
|||
|
|
<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>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – <p>Stack of one or more localizable messages for human exception
|
|||
|
|
consumers.</p>
|
|||
|
|
<p>The message at the top of the stack (first in the list) describes
|
|||
|
|
the exception from the perspective of the method the client
|
|||
|
|
invoked. Each subsequent message in the stack describes the “cause”
|
|||
|
|
of the prior message.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>data</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Data to facilitate clients responding to the method reporting a
|
|||
|
|
standard exception to indicating that it was unable to complete
|
|||
|
|
successfully.</p>
|
|||
|
|
<p>Methods may provide data that clients can use when responding to
|
|||
|
|
exceptions. Since the data that clients need may be specific to the
|
|||
|
|
context of the method reporting the exception, different methods
|
|||
|
|
that report the same exception may provide different data in the
|
|||
|
|
exception. The documentation for each each method will describe
|
|||
|
|
what, if any, data it provides for each exception it reports. The
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.ArgumentLocations" title="com.vmware.vapi.std.errors_client.ArgumentLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentLocations</span></code></a>, <a class="reference internal" href="#com.vmware.vapi.std.errors_client.FileLocations" title="com.vmware.vapi.std.errors_client.FileLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileLocations</span></code></a>, and
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.TransientIndication" title="com.vmware.vapi.std.errors_client.TransientIndication"><code class="xref py py-class docutils literal notranslate"><span class="pre">TransientIndication</span></code></a> classes are intended as possible
|
|||
|
|
values for this attribute.
|
|||
|
|
<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> may also be useful as
|
|||
|
|
a value for this attribute (although that is not its primary
|
|||
|
|
purpose). Some classes may provide their own specific classes for
|
|||
|
|
use as the value of this attribute when reporting exceptions from
|
|||
|
|
their methods.
|
|||
|
|
Some methods will not set this attribute when reporting exceptions.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>error_type</strong> (<a class="reference internal" href="#com.vmware.vapi.std.errors_client.Error.Type" title="com.vmware.vapi.std.errors_client.Error.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error.Type</span></code></a>) – Discriminator field to help API consumers identify the structure
|
|||
|
|
type. This attribute was added in vSphere API 6.7.2.
|
|||
|
|
Can be None for compatibility with preceding implementations.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.Error.Type">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Type</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.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>Enumeration of all standard errors. Used as discriminator in protocols that
|
|||
|
|
have no standard means for transporting the error type, e.g. REST. This
|
|||
|
|
enumeration was added in vSphere API 6.7.2.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.Error.Type.ALREADY_EXISTS">
|
|||
|
|
<code class="sig-name descname">ALREADY_EXISTS</code><em class="property"> = Type(string='ALREADY_EXISTS')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.ALREADY_EXISTS" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Discriminator for the <a class="reference internal" href="#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">AlreadyExists</span></code></a> type. This class attribute was
|
|||
|
|
added in vSphere API 6.7.2.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.Error.Type.ALREADY_IN_DESIRED_STATE">
|
|||
|
|
<code class="sig-name descname">ALREADY_IN_DESIRED_STATE</code><em class="property"> = Type(string='ALREADY_IN_DESIRED_STATE')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.ALREADY_IN_DESIRED_STATE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Discriminator for the <a class="reference internal" href="#com.vmware.vapi.std.errors_client.AlreadyInDesiredState" title="com.vmware.vapi.std.errors_client.AlreadyInDesiredState"><code class="xref py py-class docutils literal notranslate"><span class="pre">AlreadyInDesiredState</span></code></a> type. This class
|
|||
|
|
attribute was added in vSphere API 6.7.2.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.Error.Type.CANCELED">
|
|||
|
|
<code class="sig-name descname">CANCELED</code><em class="property"> = Type(string='CANCELED')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.CANCELED" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Discriminator for the <a class="reference internal" href="#com.vmware.vapi.std.errors_client.Canceled" title="com.vmware.vapi.std.errors_client.Canceled"><code class="xref py py-class docutils literal notranslate"><span class="pre">Canceled</span></code></a> type. This class attribute was
|
|||
|
|
added in vSphere API 6.7.2.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.Error.Type.CONCURRENT_CHANGE">
|
|||
|
|
<code class="sig-name descname">CONCURRENT_CHANGE</code><em class="property"> = Type(string='CONCURRENT_CHANGE')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.CONCURRENT_CHANGE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Discriminator for the <a class="reference internal" href="#com.vmware.vapi.std.errors_client.ConcurrentChange" title="com.vmware.vapi.std.errors_client.ConcurrentChange"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConcurrentChange</span></code></a> type. This class attribute
|
|||
|
|
was added in vSphere API 6.7.2.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.Error.Type.ERROR">
|
|||
|
|
<code class="sig-name descname">ERROR</code><em class="property"> = Type(string='ERROR')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.ERROR" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Discriminator for the <a class="reference internal" href="#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">Error</span></code></a> type. This class attribute was added
|
|||
|
|
in vSphere API 6.7.2.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.Error.Type.FEATURE_IN_USE">
|
|||
|
|
<code class="sig-name descname">FEATURE_IN_USE</code><em class="property"> = Type(string='FEATURE_IN_USE')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.FEATURE_IN_USE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Discriminator for the <a class="reference internal" href="#com.vmware.vapi.std.errors_client.FeatureInUse" title="com.vmware.vapi.std.errors_client.FeatureInUse"><code class="xref py py-class docutils literal notranslate"><span class="pre">FeatureInUse</span></code></a> type. This class attribute was
|
|||
|
|
added in vSphere API 6.7.2.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.Error.Type.INTERNAL_SERVER_ERROR">
|
|||
|
|
<code class="sig-name descname">INTERNAL_SERVER_ERROR</code><em class="property"> = Type(string='INTERNAL_SERVER_ERROR')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.INTERNAL_SERVER_ERROR" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Discriminator for the <a class="reference internal" href="#com.vmware.vapi.std.errors_client.InternalServerError" title="com.vmware.vapi.std.errors_client.InternalServerError"><code class="xref py py-class docutils literal notranslate"><span class="pre">InternalServerError</span></code></a> type. This class
|
|||
|
|
attribute was added in vSphere API 6.7.2.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.Error.Type.INVALID_ARGUMENT">
|
|||
|
|
<code class="sig-name descname">INVALID_ARGUMENT</code><em class="property"> = Type(string='INVALID_ARGUMENT')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.INVALID_ARGUMENT" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Discriminator for the <a class="reference internal" href="#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">InvalidArgument</span></code></a> type. This class attribute
|
|||
|
|
was added in vSphere API 6.7.2.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.Error.Type.INVALID_ELEMENT_CONFIGURATION">
|
|||
|
|
<code class="sig-name descname">INVALID_ELEMENT_CONFIGURATION</code><em class="property"> = Type(string='INVALID_ELEMENT_CONFIGURATION')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.INVALID_ELEMENT_CONFIGURATION" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Discriminator for the <a class="reference internal" href="#com.vmware.vapi.std.errors_client.InvalidElementConfiguration" title="com.vmware.vapi.std.errors_client.InvalidElementConfiguration"><code class="xref py py-class docutils literal notranslate"><span class="pre">InvalidElementConfiguration</span></code></a> type. This class
|
|||
|
|
attribute was added in vSphere API 6.7.2.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.Error.Type.INVALID_ELEMENT_TYPE">
|
|||
|
|
<code class="sig-name descname">INVALID_ELEMENT_TYPE</code><em class="property"> = Type(string='INVALID_ELEMENT_TYPE')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.INVALID_ELEMENT_TYPE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Discriminator for the <a class="reference internal" href="#com.vmware.vapi.std.errors_client.InvalidElementType" title="com.vmware.vapi.std.errors_client.InvalidElementType"><code class="xref py py-class docutils literal notranslate"><span class="pre">InvalidElementType</span></code></a> type. This class
|
|||
|
|
attribute was added in vSphere API 6.7.2.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.Error.Type.INVALID_REQUEST">
|
|||
|
|
<code class="sig-name descname">INVALID_REQUEST</code><em class="property"> = Type(string='INVALID_REQUEST')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.INVALID_REQUEST" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Discriminator for the <a class="reference internal" href="#com.vmware.vapi.std.errors_client.InvalidRequest" title="com.vmware.vapi.std.errors_client.InvalidRequest"><code class="xref py py-class docutils literal notranslate"><span class="pre">InvalidRequest</span></code></a> type. This class attribute
|
|||
|
|
was added in vSphere API 6.7.2.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.Error.Type.NOT_ALLOWED_IN_CURRENT_STATE">
|
|||
|
|
<code class="sig-name descname">NOT_ALLOWED_IN_CURRENT_STATE</code><em class="property"> = Type(string='NOT_ALLOWED_IN_CURRENT_STATE')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.NOT_ALLOWED_IN_CURRENT_STATE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Discriminator for the <a class="reference internal" href="#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">NotAllowedInCurrentState</span></code></a> type. This class
|
|||
|
|
attribute was added in vSphere API 6.7.2.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.Error.Type.NOT_FOUND">
|
|||
|
|
<code class="sig-name descname">NOT_FOUND</code><em class="property"> = Type(string='NOT_FOUND')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.NOT_FOUND" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Discriminator for the <a class="reference internal" href="#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">NotFound</span></code></a> type. This class attribute was
|
|||
|
|
added in vSphere API 6.7.2.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.Error.Type.OPERATION_NOT_FOUND">
|
|||
|
|
<code class="sig-name descname">OPERATION_NOT_FOUND</code><em class="property"> = Type(string='OPERATION_NOT_FOUND')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.OPERATION_NOT_FOUND" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Discriminator for the <a class="reference internal" href="#com.vmware.vapi.std.errors_client.OperationNotFound" title="com.vmware.vapi.std.errors_client.OperationNotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">OperationNotFound</span></code></a> type. This class attribute
|
|||
|
|
was added in vSphere API 6.7.2.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.Error.Type.RESOURCE_BUSY">
|
|||
|
|
<code class="sig-name descname">RESOURCE_BUSY</code><em class="property"> = Type(string='RESOURCE_BUSY')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.RESOURCE_BUSY" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Discriminator for the <a class="reference internal" href="#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">ResourceBusy</span></code></a> type. This class attribute was
|
|||
|
|
added in vSphere API 6.7.2.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.Error.Type.RESOURCE_INACCESSIBLE">
|
|||
|
|
<code class="sig-name descname">RESOURCE_INACCESSIBLE</code><em class="property"> = Type(string='RESOURCE_INACCESSIBLE')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.RESOURCE_INACCESSIBLE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Discriminator for the <a class="reference internal" href="#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">ResourceInaccessible</span></code></a> type. This class
|
|||
|
|
attribute was added in vSphere API 6.7.2.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.Error.Type.RESOURCE_IN_USE">
|
|||
|
|
<code class="sig-name descname">RESOURCE_IN_USE</code><em class="property"> = Type(string='RESOURCE_IN_USE')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.RESOURCE_IN_USE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Discriminator for the <a class="reference internal" href="#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">ResourceInUse</span></code></a> type. This class attribute was
|
|||
|
|
added in vSphere API 6.7.2.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.Error.Type.SERVICE_UNAVAILABLE">
|
|||
|
|
<code class="sig-name descname">SERVICE_UNAVAILABLE</code><em class="property"> = Type(string='SERVICE_UNAVAILABLE')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.SERVICE_UNAVAILABLE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Discriminator for the <a class="reference internal" href="#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">ServiceUnavailable</span></code></a> type. This class
|
|||
|
|
attribute was added in vSphere API 6.7.2.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.Error.Type.TIMED_OUT">
|
|||
|
|
<code class="sig-name descname">TIMED_OUT</code><em class="property"> = Type(string='TIMED_OUT')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.TIMED_OUT" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Discriminator for the <a class="reference internal" href="#com.vmware.vapi.std.errors_client.TimedOut" title="com.vmware.vapi.std.errors_client.TimedOut"><code class="xref py py-class docutils literal notranslate"><span class="pre">TimedOut</span></code></a> type. This class attribute was
|
|||
|
|
added in vSphere API 6.7.2.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.Error.Type.UNABLE_TO_ALLOCATE_RESOURCE">
|
|||
|
|
<code class="sig-name descname">UNABLE_TO_ALLOCATE_RESOURCE</code><em class="property"> = Type(string='UNABLE_TO_ALLOCATE_RESOURCE')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.UNABLE_TO_ALLOCATE_RESOURCE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Discriminator for the <a class="reference internal" href="#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">UnableToAllocateResource</span></code></a> type. This class
|
|||
|
|
attribute was added in vSphere API 6.7.2.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.Error.Type.UNAUTHENTICATED">
|
|||
|
|
<code class="sig-name descname">UNAUTHENTICATED</code><em class="property"> = Type(string='UNAUTHENTICATED')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.UNAUTHENTICATED" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Discriminator for the <a class="reference internal" href="#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">Unauthenticated</span></code></a> type. This class attribute
|
|||
|
|
was added in vSphere API 6.7.2.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.Error.Type.UNAUTHORIZED">
|
|||
|
|
<code class="sig-name descname">UNAUTHORIZED</code><em class="property"> = Type(string='UNAUTHORIZED')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.UNAUTHORIZED" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Discriminator for the <a class="reference internal" href="#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">Unauthorized</span></code></a> type. This class attribute was
|
|||
|
|
added in vSphere API 6.7.2.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.Error.Type.UNEXPECTED_INPUT">
|
|||
|
|
<code class="sig-name descname">UNEXPECTED_INPUT</code><em class="property"> = Type(string='UNEXPECTED_INPUT')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.UNEXPECTED_INPUT" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Discriminator for the <a class="reference internal" href="#com.vmware.vapi.std.errors_client.UnexpectedInput" title="com.vmware.vapi.std.errors_client.UnexpectedInput"><code class="xref py py-class docutils literal notranslate"><span class="pre">UnexpectedInput</span></code></a> type. This class attribute
|
|||
|
|
was added in vSphere API 6.7.2.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.Error.Type.UNSUPPORTED">
|
|||
|
|
<code class="sig-name descname">UNSUPPORTED</code><em class="property"> = Type(string='UNSUPPORTED')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.UNSUPPORTED" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Discriminator for the <a class="reference internal" href="#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">Unsupported</span></code></a> type. This class attribute was
|
|||
|
|
added in vSphere API 6.7.2.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.Error.Type.UNVERIFIED_PEER">
|
|||
|
|
<code class="sig-name descname">UNVERIFIED_PEER</code><em class="property"> = Type(string='UNVERIFIED_PEER')</em><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Error.Type.UNVERIFIED_PEER" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Discriminator for the <a class="reference internal" href="#com.vmware.vapi.std.errors_client.UnverifiedPeer" title="com.vmware.vapi.std.errors_client.UnverifiedPeer"><code class="xref py py-class docutils literal notranslate"><span class="pre">UnverifiedPeer</span></code></a> type. This class attribute
|
|||
|
|
was added in vSphere API 6.7.2.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py exception">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.FeatureInUse">
|
|||
|
|
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">FeatureInUse</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">messages</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">data</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">error_type</span><span class="o">=</span><span class="default_value">'FEATURE_IN_USE'</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.FeatureInUse" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">FeatureInUse</span></code> exception indicates that an action cannot be completed
|
|||
|
|
because a feature is in use.</p>
|
|||
|
|
<blockquote>
|
|||
|
|
<div><p>Examples:</p>
|
|||
|
|
</div></blockquote>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>Trying to disable snapshots on a virtual machine which has a snapshot.</p></li>
|
|||
|
|
<li><p>Trying to downgrade a license that has licensed features that are in use.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
<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>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – <p>Stack of one or more localizable messages for human exception
|
|||
|
|
consumers.</p>
|
|||
|
|
<p>The message at the top of the stack (first in the list) describes
|
|||
|
|
the exception from the perspective of the method the client
|
|||
|
|
invoked. Each subsequent message in the stack describes the “cause”
|
|||
|
|
of the prior message.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>data</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Data to facilitate clients responding to the method reporting a
|
|||
|
|
standard exception to indicating that it was unable to complete
|
|||
|
|
successfully.</p>
|
|||
|
|
<p>Methods may provide data that clients can use when responding to
|
|||
|
|
exceptions. Since the data that clients need may be specific to the
|
|||
|
|
context of the method reporting the exception, different methods
|
|||
|
|
that report the same exception may provide different data in the
|
|||
|
|
exception. The documentation for each each method will describe
|
|||
|
|
what, if any, data it provides for each exception it reports. The
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.ArgumentLocations" title="com.vmware.vapi.std.errors_client.ArgumentLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentLocations</span></code></a>, <a class="reference internal" href="#com.vmware.vapi.std.errors_client.FileLocations" title="com.vmware.vapi.std.errors_client.FileLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileLocations</span></code></a>, and
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.TransientIndication" title="com.vmware.vapi.std.errors_client.TransientIndication"><code class="xref py py-class docutils literal notranslate"><span class="pre">TransientIndication</span></code></a> classes are intended as possible
|
|||
|
|
values for this attribute.
|
|||
|
|
<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> may also be useful as
|
|||
|
|
a value for this attribute (although that is not its primary
|
|||
|
|
purpose). Some classes may provide their own specific classes for
|
|||
|
|
use as the value of this attribute when reporting exceptions from
|
|||
|
|
their methods.
|
|||
|
|
Some methods will not set this attribute when reporting exceptions.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>error_type</strong> (<a class="reference internal" href="#com.vmware.vapi.std.errors_client.Error.Type" title="com.vmware.vapi.std.errors_client.Error.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error.Type</span></code></a>) – Discriminator field to help API consumers identify the structure
|
|||
|
|
type. This attribute was added in vSphere API 6.7.2.
|
|||
|
|
Can be None for compatibility with preceding implementations.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.FileLocations">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">FileLocations</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">primary</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">secondary</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.FileLocations" 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">FileLocations</span></code> class identifies the file(s) that caused the method
|
|||
|
|
to report the exception.</p>
|
|||
|
|
<p>Some types of exceptions are caused by a problem with one or more files.
|
|||
|
|
This class is intended to be used as the payload to identify those files
|
|||
|
|
when the method reports exceptions like <a class="reference internal" href="#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">NotFound</span></code></a>. See
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Error.data</span></code>.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>primary</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String identifying the file that triggered the exception.</p></li>
|
|||
|
|
<li><p><strong>secondary</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>) – <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> (possibly empty) of strings identifying other files
|
|||
|
|
that caused the primary file to trigger the exception.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py exception">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.InternalServerError">
|
|||
|
|
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">InternalServerError</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">messages</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">data</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">error_type</span><span class="o">=</span><span class="default_value">'INTERNAL_SERVER_ERROR'</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.InternalServerError" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">InternalServerError</span></code> exception indicates that the server encounters
|
|||
|
|
an unexpected condition that prevented it from fulfilling the request.</p>
|
|||
|
|
<p>This exception is reported by the API infrastructure, so it could occur in
|
|||
|
|
response to the invocation of any method.</p>
|
|||
|
|
<blockquote>
|
|||
|
|
<div><p>Examples:</p>
|
|||
|
|
</div></blockquote>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>The method returns a value whose type doesn’t match the type type the
|
|||
|
|
method says it should return.</p></li>
|
|||
|
|
<li><p>The method reports an exception that is not included in the list of
|
|||
|
|
exceptions the method says that it can report.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
<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>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – <p>Stack of one or more localizable messages for human exception
|
|||
|
|
consumers.</p>
|
|||
|
|
<p>The message at the top of the stack (first in the list) describes
|
|||
|
|
the exception from the perspective of the method the client
|
|||
|
|
invoked. Each subsequent message in the stack describes the “cause”
|
|||
|
|
of the prior message.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>data</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Data to facilitate clients responding to the method reporting a
|
|||
|
|
standard exception to indicating that it was unable to complete
|
|||
|
|
successfully.</p>
|
|||
|
|
<p>Methods may provide data that clients can use when responding to
|
|||
|
|
exceptions. Since the data that clients need may be specific to the
|
|||
|
|
context of the method reporting the exception, different methods
|
|||
|
|
that report the same exception may provide different data in the
|
|||
|
|
exception. The documentation for each each method will describe
|
|||
|
|
what, if any, data it provides for each exception it reports. The
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.ArgumentLocations" title="com.vmware.vapi.std.errors_client.ArgumentLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentLocations</span></code></a>, <a class="reference internal" href="#com.vmware.vapi.std.errors_client.FileLocations" title="com.vmware.vapi.std.errors_client.FileLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileLocations</span></code></a>, and
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.TransientIndication" title="com.vmware.vapi.std.errors_client.TransientIndication"><code class="xref py py-class docutils literal notranslate"><span class="pre">TransientIndication</span></code></a> classes are intended as possible
|
|||
|
|
values for this attribute.
|
|||
|
|
<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> may also be useful as
|
|||
|
|
a value for this attribute (although that is not its primary
|
|||
|
|
purpose). Some classes may provide their own specific classes for
|
|||
|
|
use as the value of this attribute when reporting exceptions from
|
|||
|
|
their methods.
|
|||
|
|
Some methods will not set this attribute when reporting exceptions.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>error_type</strong> (<a class="reference internal" href="#com.vmware.vapi.std.errors_client.Error.Type" title="com.vmware.vapi.std.errors_client.Error.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error.Type</span></code></a>) – Discriminator field to help API consumers identify the structure
|
|||
|
|
type. This attribute was added in vSphere API 6.7.2.
|
|||
|
|
Can be None for compatibility with preceding implementations.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py exception">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.InvalidArgument">
|
|||
|
|
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">InvalidArgument</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">messages</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">data</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">error_type</span><span class="o">=</span><span class="default_value">'INVALID_ARGUMENT'</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.InvalidArgument" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">InvalidArgument</span></code> exception indicates that the values received for
|
|||
|
|
one or more parameters are not acceptable.</p>
|
|||
|
|
<p>This exception is reported by the API infrastructure, so it could occur in
|
|||
|
|
response to the invocation of any method. It may also be reported as the
|
|||
|
|
result of method-specific validation.</p>
|
|||
|
|
<blockquote>
|
|||
|
|
<div><p>Examples:</p>
|
|||
|
|
</div></blockquote>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>A parameter has a value that is not of the expected type.</p></li>
|
|||
|
|
<li><p>A parameter has a value that is not in the required range.</p></li>
|
|||
|
|
<li><p>A parameter has a value that is not one of the specifically allowed
|
|||
|
|
strings.</p></li>
|
|||
|
|
<li><p>One attribute of a class is the tag for a tagged union, and has a
|
|||
|
|
specific value but another attribute of the class that is required to be
|
|||
|
|
specified when the tag has that value is not specified, or another
|
|||
|
|
attribute of the class that is required to be unspecified when the tag has
|
|||
|
|
that value is specified.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
<blockquote>
|
|||
|
|
<div><p>Counterexamples:</p>
|
|||
|
|
</div></blockquote>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>Trying to create a new tag in tag category when a tag with the specified
|
|||
|
|
name already exists the tag category. The <a class="reference internal" href="#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">AlreadyExists</span></code></a> exception
|
|||
|
|
would be used instead.</p></li>
|
|||
|
|
<li><p>Invoke the method to retrieve information about a virtual machine,
|
|||
|
|
passing an id that does not identify an existing virtual machine. The
|
|||
|
|
<a class="reference internal" href="#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">NotFound</span></code></a> exception would be used instead.</p></li>
|
|||
|
|
<li><p>Attempt to put a virtual machine into a folder that can only contain
|
|||
|
|
hosts. The <a class="reference internal" href="#com.vmware.vapi.std.errors_client.InvalidElementType" title="com.vmware.vapi.std.errors_client.InvalidElementType"><code class="xref py py-class docutils literal notranslate"><span class="pre">InvalidElementType</span></code></a> exception would be used instead.</p></li>
|
|||
|
|
<li><p>Attempt to attach a SCSI virtual disk to an IDE port. The
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.InvalidElementType" title="com.vmware.vapi.std.errors_client.InvalidElementType"><code class="xref py py-class docutils literal notranslate"><span class="pre">InvalidElementType</span></code></a> exception would be used instead.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
<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>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – <p>Stack of one or more localizable messages for human exception
|
|||
|
|
consumers.</p>
|
|||
|
|
<p>The message at the top of the stack (first in the list) describes
|
|||
|
|
the exception from the perspective of the method the client
|
|||
|
|
invoked. Each subsequent message in the stack describes the “cause”
|
|||
|
|
of the prior message.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>data</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Data to facilitate clients responding to the method reporting a
|
|||
|
|
standard exception to indicating that it was unable to complete
|
|||
|
|
successfully.</p>
|
|||
|
|
<p>Methods may provide data that clients can use when responding to
|
|||
|
|
exceptions. Since the data that clients need may be specific to the
|
|||
|
|
context of the method reporting the exception, different methods
|
|||
|
|
that report the same exception may provide different data in the
|
|||
|
|
exception. The documentation for each each method will describe
|
|||
|
|
what, if any, data it provides for each exception it reports. The
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.ArgumentLocations" title="com.vmware.vapi.std.errors_client.ArgumentLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentLocations</span></code></a>, <a class="reference internal" href="#com.vmware.vapi.std.errors_client.FileLocations" title="com.vmware.vapi.std.errors_client.FileLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileLocations</span></code></a>, and
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.TransientIndication" title="com.vmware.vapi.std.errors_client.TransientIndication"><code class="xref py py-class docutils literal notranslate"><span class="pre">TransientIndication</span></code></a> classes are intended as possible
|
|||
|
|
values for this attribute.
|
|||
|
|
<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> may also be useful as
|
|||
|
|
a value for this attribute (although that is not its primary
|
|||
|
|
purpose). Some classes may provide their own specific classes for
|
|||
|
|
use as the value of this attribute when reporting exceptions from
|
|||
|
|
their methods.
|
|||
|
|
Some methods will not set this attribute when reporting exceptions.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>error_type</strong> (<a class="reference internal" href="#com.vmware.vapi.std.errors_client.Error.Type" title="com.vmware.vapi.std.errors_client.Error.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error.Type</span></code></a>) – Discriminator field to help API consumers identify the structure
|
|||
|
|
type. This attribute was added in vSphere API 6.7.2.
|
|||
|
|
Can be None for compatibility with preceding implementations.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py exception">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.InvalidElementConfiguration">
|
|||
|
|
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">InvalidElementConfiguration</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">messages</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">data</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">error_type</span><span class="o">=</span><span class="default_value">'INVALID_ELEMENT_CONFIGURATION'</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.InvalidElementConfiguration" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">InvalidElementConfiguration</span></code> exception indicates that an attempt to
|
|||
|
|
modify the configuration of an element or a group containing the element
|
|||
|
|
failed due to the configuraton of the element. A typical case is when the
|
|||
|
|
method is am attempt to change the group membership of the element fails,
|
|||
|
|
in which case a configuration change on the element may allow the group
|
|||
|
|
membership change to succeed.</p>
|
|||
|
|
<blockquote>
|
|||
|
|
<div><p>Examples:</p>
|
|||
|
|
</div></blockquote>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>Attempt to move a host with a fault tolerant virtual machine out of a
|
|||
|
|
cluster (i.e. make the host a standalone host).</p></li>
|
|||
|
|
<li><p>Attempt to remove a host from a DRS cluster without putting the host into
|
|||
|
|
maintenance mode.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
<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>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – <p>Stack of one or more localizable messages for human exception
|
|||
|
|
consumers.</p>
|
|||
|
|
<p>The message at the top of the stack (first in the list) describes
|
|||
|
|
the exception from the perspective of the method the client
|
|||
|
|
invoked. Each subsequent message in the stack describes the “cause”
|
|||
|
|
of the prior message.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>data</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Data to facilitate clients responding to the method reporting a
|
|||
|
|
standard exception to indicating that it was unable to complete
|
|||
|
|
successfully.</p>
|
|||
|
|
<p>Methods may provide data that clients can use when responding to
|
|||
|
|
exceptions. Since the data that clients need may be specific to the
|
|||
|
|
context of the method reporting the exception, different methods
|
|||
|
|
that report the same exception may provide different data in the
|
|||
|
|
exception. The documentation for each each method will describe
|
|||
|
|
what, if any, data it provides for each exception it reports. The
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.ArgumentLocations" title="com.vmware.vapi.std.errors_client.ArgumentLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentLocations</span></code></a>, <a class="reference internal" href="#com.vmware.vapi.std.errors_client.FileLocations" title="com.vmware.vapi.std.errors_client.FileLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileLocations</span></code></a>, and
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.TransientIndication" title="com.vmware.vapi.std.errors_client.TransientIndication"><code class="xref py py-class docutils literal notranslate"><span class="pre">TransientIndication</span></code></a> classes are intended as possible
|
|||
|
|
values for this attribute.
|
|||
|
|
<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> may also be useful as
|
|||
|
|
a value for this attribute (although that is not its primary
|
|||
|
|
purpose). Some classes may provide their own specific classes for
|
|||
|
|
use as the value of this attribute when reporting exceptions from
|
|||
|
|
their methods.
|
|||
|
|
Some methods will not set this attribute when reporting exceptions.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>error_type</strong> (<a class="reference internal" href="#com.vmware.vapi.std.errors_client.Error.Type" title="com.vmware.vapi.std.errors_client.Error.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error.Type</span></code></a>) – Discriminator field to help API consumers identify the structure
|
|||
|
|
type. This attribute was added in vSphere API 6.7.2.
|
|||
|
|
Can be None for compatibility with preceding implementations.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py exception">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.InvalidElementType">
|
|||
|
|
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">InvalidElementType</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">messages</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">data</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">error_type</span><span class="o">=</span><span class="default_value">'INVALID_ELEMENT_TYPE'</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.InvalidElementType" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">InvalidElementType</span></code> exception indicates that the server was unable
|
|||
|
|
to fulfil the request because an element of a specific type cannot be a
|
|||
|
|
member of particular group.</p>
|
|||
|
|
<p>This exception could be reported, for example, if an attempt is made to put
|
|||
|
|
an element into the wrong type of container.</p>
|
|||
|
|
<blockquote>
|
|||
|
|
<div><p>Examples:</p>
|
|||
|
|
</div></blockquote>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>Attempt to put a virtual machine into a folder that can only contain
|
|||
|
|
hosts.</p></li>
|
|||
|
|
<li><p>Attempt to attach a SCSI virtual disk to an IDE port.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
<blockquote>
|
|||
|
|
<div><p>Counterexamples:</p>
|
|||
|
|
</div></blockquote>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>A parameter has a value that is not of the expected type. The
|
|||
|
|
<a class="reference internal" href="#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">InvalidArgument</span></code></a> exception would be used instead.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
<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>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – <p>Stack of one or more localizable messages for human exception
|
|||
|
|
consumers.</p>
|
|||
|
|
<p>The message at the top of the stack (first in the list) describes
|
|||
|
|
the exception from the perspective of the method the client
|
|||
|
|
invoked. Each subsequent message in the stack describes the “cause”
|
|||
|
|
of the prior message.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>data</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Data to facilitate clients responding to the method reporting a
|
|||
|
|
standard exception to indicating that it was unable to complete
|
|||
|
|
successfully.</p>
|
|||
|
|
<p>Methods may provide data that clients can use when responding to
|
|||
|
|
exceptions. Since the data that clients need may be specific to the
|
|||
|
|
context of the method reporting the exception, different methods
|
|||
|
|
that report the same exception may provide different data in the
|
|||
|
|
exception. The documentation for each each method will describe
|
|||
|
|
what, if any, data it provides for each exception it reports. The
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.ArgumentLocations" title="com.vmware.vapi.std.errors_client.ArgumentLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentLocations</span></code></a>, <a class="reference internal" href="#com.vmware.vapi.std.errors_client.FileLocations" title="com.vmware.vapi.std.errors_client.FileLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileLocations</span></code></a>, and
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.TransientIndication" title="com.vmware.vapi.std.errors_client.TransientIndication"><code class="xref py py-class docutils literal notranslate"><span class="pre">TransientIndication</span></code></a> classes are intended as possible
|
|||
|
|
values for this attribute.
|
|||
|
|
<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> may also be useful as
|
|||
|
|
a value for this attribute (although that is not its primary
|
|||
|
|
purpose). Some classes may provide their own specific classes for
|
|||
|
|
use as the value of this attribute when reporting exceptions from
|
|||
|
|
their methods.
|
|||
|
|
Some methods will not set this attribute when reporting exceptions.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>error_type</strong> (<a class="reference internal" href="#com.vmware.vapi.std.errors_client.Error.Type" title="com.vmware.vapi.std.errors_client.Error.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error.Type</span></code></a>) – Discriminator field to help API consumers identify the structure
|
|||
|
|
type. This attribute was added in vSphere API 6.7.2.
|
|||
|
|
Can be None for compatibility with preceding implementations.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py exception">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.InvalidRequest">
|
|||
|
|
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">InvalidRequest</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">messages</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">data</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">error_type</span><span class="o">=</span><span class="default_value">'INVALID_REQUEST'</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.InvalidRequest" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">InvalidRequest</span></code> exception indicates that the request is malformed in
|
|||
|
|
such a way that the server is unable to process it.</p>
|
|||
|
|
<blockquote>
|
|||
|
|
<div><p>Examples:</p>
|
|||
|
|
</div></blockquote>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>The XML in a SOAP request is not well-formed so the server cannot parse
|
|||
|
|
the request.</p></li>
|
|||
|
|
<li><p>The XML in a SOAP request is well-formed but does not match the structure
|
|||
|
|
required by the SOAP specification.</p></li>
|
|||
|
|
<li><p>A JSON-RPC request is not valid JSON.</p></li>
|
|||
|
|
<li><p>The JSON sent in a JSON-RPC request is not a valid JSON-RPC Request
|
|||
|
|
object.</p></li>
|
|||
|
|
<li><p>The Request object from a JSON-RPC request does not match the structure
|
|||
|
|
required by the API infrastructure.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
<blockquote>
|
|||
|
|
<div><p>Counterexamples:</p>
|
|||
|
|
</div></blockquote>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>The parameter has a value that is not with the required range. The
|
|||
|
|
<a class="reference internal" href="#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">InvalidArgument</span></code></a> exception would be used instead.</p></li>
|
|||
|
|
<li><p>The name of the method specified in the request doesn’t not match any
|
|||
|
|
known method. The <a class="reference internal" href="#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">NotFound</span></code></a> exception would be used instead.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Some transport protocols (for example JSON-RPC) include their own mechanism
|
|||
|
|
for reporting these kinds of errors, and the API infrastructure for a
|
|||
|
|
programming language may expose the errors using a language specific
|
|||
|
|
mechanism, so this exception might not be used.</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>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – <p>Stack of one or more localizable messages for human exception
|
|||
|
|
consumers.</p>
|
|||
|
|
<p>The message at the top of the stack (first in the list) describes
|
|||
|
|
the exception from the perspective of the method the client
|
|||
|
|
invoked. Each subsequent message in the stack describes the “cause”
|
|||
|
|
of the prior message.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>data</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Data to facilitate clients responding to the method reporting a
|
|||
|
|
standard exception to indicating that it was unable to complete
|
|||
|
|
successfully.</p>
|
|||
|
|
<p>Methods may provide data that clients can use when responding to
|
|||
|
|
exceptions. Since the data that clients need may be specific to the
|
|||
|
|
context of the method reporting the exception, different methods
|
|||
|
|
that report the same exception may provide different data in the
|
|||
|
|
exception. The documentation for each each method will describe
|
|||
|
|
what, if any, data it provides for each exception it reports. The
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.ArgumentLocations" title="com.vmware.vapi.std.errors_client.ArgumentLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentLocations</span></code></a>, <a class="reference internal" href="#com.vmware.vapi.std.errors_client.FileLocations" title="com.vmware.vapi.std.errors_client.FileLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileLocations</span></code></a>, and
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.TransientIndication" title="com.vmware.vapi.std.errors_client.TransientIndication"><code class="xref py py-class docutils literal notranslate"><span class="pre">TransientIndication</span></code></a> classes are intended as possible
|
|||
|
|
values for this attribute.
|
|||
|
|
<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> may also be useful as
|
|||
|
|
a value for this attribute (although that is not its primary
|
|||
|
|
purpose). Some classes may provide their own specific classes for
|
|||
|
|
use as the value of this attribute when reporting exceptions from
|
|||
|
|
their methods.
|
|||
|
|
Some methods will not set this attribute when reporting exceptions.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>error_type</strong> (<a class="reference internal" href="#com.vmware.vapi.std.errors_client.Error.Type" title="com.vmware.vapi.std.errors_client.Error.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error.Type</span></code></a>) – Discriminator field to help API consumers identify the structure
|
|||
|
|
type. This attribute was added in vSphere API 6.7.2.
|
|||
|
|
Can be None for compatibility with preceding implementations.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py exception">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState">
|
|||
|
|
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">NotAllowedInCurrentState</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">messages</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">data</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">error_type</span><span class="o">=</span><span class="default_value">'NOT_ALLOWED_IN_CURRENT_STATE'</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">NotAllowedInCurrentState</span></code> exception indicates that the requested
|
|||
|
|
method is not allowed with a resource or service in its current state. This
|
|||
|
|
could be because the method is performing a configuration change that is
|
|||
|
|
not allowed in the current state or because method itself is not allowed in
|
|||
|
|
the current state.</p>
|
|||
|
|
<blockquote>
|
|||
|
|
<div><p>Examples:</p>
|
|||
|
|
</div></blockquote>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>Trying to add a virtual device that cannot be hot plugged to a running
|
|||
|
|
virtual machine.</p></li>
|
|||
|
|
<li><p>Trying to upgrade the virtual hardware version for a suspended virtual
|
|||
|
|
machine.</p></li>
|
|||
|
|
<li><p>Trying to power off, reset, or suspend a virtual machine that is not
|
|||
|
|
powered on.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
<blockquote>
|
|||
|
|
<div><p>Counterexamples:</p>
|
|||
|
|
</div></blockquote>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>Trying to power off a virtual machine that is in the process of being
|
|||
|
|
powered on. The <a class="reference internal" href="#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">ResourceBusy</span></code></a> exception would be used instead.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
<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>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – <p>Stack of one or more localizable messages for human exception
|
|||
|
|
consumers.</p>
|
|||
|
|
<p>The message at the top of the stack (first in the list) describes
|
|||
|
|
the exception from the perspective of the method the client
|
|||
|
|
invoked. Each subsequent message in the stack describes the “cause”
|
|||
|
|
of the prior message.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>data</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Data to facilitate clients responding to the method reporting a
|
|||
|
|
standard exception to indicating that it was unable to complete
|
|||
|
|
successfully.</p>
|
|||
|
|
<p>Methods may provide data that clients can use when responding to
|
|||
|
|
exceptions. Since the data that clients need may be specific to the
|
|||
|
|
context of the method reporting the exception, different methods
|
|||
|
|
that report the same exception may provide different data in the
|
|||
|
|
exception. The documentation for each each method will describe
|
|||
|
|
what, if any, data it provides for each exception it reports. The
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.ArgumentLocations" title="com.vmware.vapi.std.errors_client.ArgumentLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentLocations</span></code></a>, <a class="reference internal" href="#com.vmware.vapi.std.errors_client.FileLocations" title="com.vmware.vapi.std.errors_client.FileLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileLocations</span></code></a>, and
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.TransientIndication" title="com.vmware.vapi.std.errors_client.TransientIndication"><code class="xref py py-class docutils literal notranslate"><span class="pre">TransientIndication</span></code></a> classes are intended as possible
|
|||
|
|
values for this attribute.
|
|||
|
|
<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> may also be useful as
|
|||
|
|
a value for this attribute (although that is not its primary
|
|||
|
|
purpose). Some classes may provide their own specific classes for
|
|||
|
|
use as the value of this attribute when reporting exceptions from
|
|||
|
|
their methods.
|
|||
|
|
Some methods will not set this attribute when reporting exceptions.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>error_type</strong> (<a class="reference internal" href="#com.vmware.vapi.std.errors_client.Error.Type" title="com.vmware.vapi.std.errors_client.Error.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error.Type</span></code></a>) – Discriminator field to help API consumers identify the structure
|
|||
|
|
type. This attribute was added in vSphere API 6.7.2.
|
|||
|
|
Can be None for compatibility with preceding implementations.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py exception">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.NotFound">
|
|||
|
|
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">NotFound</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">messages</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">data</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">error_type</span><span class="o">=</span><span class="default_value">'NOT_FOUND'</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.NotFound" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">NotFound</span></code> exception indicates that a specified element could not be
|
|||
|
|
found.</p>
|
|||
|
|
<blockquote>
|
|||
|
|
<div><p>Examples:</p>
|
|||
|
|
</div></blockquote>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>Invoke the method to retrieve information about a virtual machine,
|
|||
|
|
passing an id that does not identify an existing virtual machine.</p></li>
|
|||
|
|
<li><p>Invoke the method to modify the configuration of a virtual nic, passing
|
|||
|
|
an id that does not identify an existing virtual nic in the specified
|
|||
|
|
virtual machine.</p></li>
|
|||
|
|
<li><p>Invoke the method to remove a vswitch, passing an id that does not
|
|||
|
|
identify an existing vswitch.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
<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>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – <p>Stack of one or more localizable messages for human exception
|
|||
|
|
consumers.</p>
|
|||
|
|
<p>The message at the top of the stack (first in the list) describes
|
|||
|
|
the exception from the perspective of the method the client
|
|||
|
|
invoked. Each subsequent message in the stack describes the “cause”
|
|||
|
|
of the prior message.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>data</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Data to facilitate clients responding to the method reporting a
|
|||
|
|
standard exception to indicating that it was unable to complete
|
|||
|
|
successfully.</p>
|
|||
|
|
<p>Methods may provide data that clients can use when responding to
|
|||
|
|
exceptions. Since the data that clients need may be specific to the
|
|||
|
|
context of the method reporting the exception, different methods
|
|||
|
|
that report the same exception may provide different data in the
|
|||
|
|
exception. The documentation for each each method will describe
|
|||
|
|
what, if any, data it provides for each exception it reports. The
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.ArgumentLocations" title="com.vmware.vapi.std.errors_client.ArgumentLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentLocations</span></code></a>, <a class="reference internal" href="#com.vmware.vapi.std.errors_client.FileLocations" title="com.vmware.vapi.std.errors_client.FileLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileLocations</span></code></a>, and
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.TransientIndication" title="com.vmware.vapi.std.errors_client.TransientIndication"><code class="xref py py-class docutils literal notranslate"><span class="pre">TransientIndication</span></code></a> classes are intended as possible
|
|||
|
|
values for this attribute.
|
|||
|
|
<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> may also be useful as
|
|||
|
|
a value for this attribute (although that is not its primary
|
|||
|
|
purpose). Some classes may provide their own specific classes for
|
|||
|
|
use as the value of this attribute when reporting exceptions from
|
|||
|
|
their methods.
|
|||
|
|
Some methods will not set this attribute when reporting exceptions.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>error_type</strong> (<a class="reference internal" href="#com.vmware.vapi.std.errors_client.Error.Type" title="com.vmware.vapi.std.errors_client.Error.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error.Type</span></code></a>) – Discriminator field to help API consumers identify the structure
|
|||
|
|
type. This attribute was added in vSphere API 6.7.2.
|
|||
|
|
Can be None for compatibility with preceding implementations.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py exception">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.OperationNotFound">
|
|||
|
|
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">OperationNotFound</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">messages</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">data</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">error_type</span><span class="o">=</span><span class="default_value">'OPERATION_NOT_FOUND'</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.OperationNotFound" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">OperationNotFound</span></code> exception indicates that the method specified in
|
|||
|
|
the request could not be found.</p>
|
|||
|
|
<p>Every API request specifies a service identifier and an operation
|
|||
|
|
identifier along with the parameters. If the API infrastructure is unable
|
|||
|
|
to find the requested class or method it reports this exception.</p>
|
|||
|
|
<p>This exception can be reported by the API infrastructure for any method,
|
|||
|
|
but it is specific to the API infrastructure, and should never be reported
|
|||
|
|
by the implementation of any method.</p>
|
|||
|
|
<blockquote>
|
|||
|
|
<div><p>Examples:</p>
|
|||
|
|
</div></blockquote>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>A client provides an invalid service or operation identifier when
|
|||
|
|
invoking the method using a dynamic interface (for example REST).</p></li>
|
|||
|
|
<li><p>A client invokes the method from a class, but that class has not been
|
|||
|
|
installed.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
<blockquote>
|
|||
|
|
<div><p>Counterexamples:</p>
|
|||
|
|
</div></blockquote>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>A client invokes a task scheduling method, but provides an invalid
|
|||
|
|
service identifier or operation identifier. The <a class="reference internal" href="#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">NotFound</span></code></a> exception
|
|||
|
|
would be used instead.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
<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>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – <p>Stack of one or more localizable messages for human exception
|
|||
|
|
consumers.</p>
|
|||
|
|
<p>The message at the top of the stack (first in the list) describes
|
|||
|
|
the exception from the perspective of the method the client
|
|||
|
|
invoked. Each subsequent message in the stack describes the “cause”
|
|||
|
|
of the prior message.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>data</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Data to facilitate clients responding to the method reporting a
|
|||
|
|
standard exception to indicating that it was unable to complete
|
|||
|
|
successfully.</p>
|
|||
|
|
<p>Methods may provide data that clients can use when responding to
|
|||
|
|
exceptions. Since the data that clients need may be specific to the
|
|||
|
|
context of the method reporting the exception, different methods
|
|||
|
|
that report the same exception may provide different data in the
|
|||
|
|
exception. The documentation for each each method will describe
|
|||
|
|
what, if any, data it provides for each exception it reports. The
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.ArgumentLocations" title="com.vmware.vapi.std.errors_client.ArgumentLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentLocations</span></code></a>, <a class="reference internal" href="#com.vmware.vapi.std.errors_client.FileLocations" title="com.vmware.vapi.std.errors_client.FileLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileLocations</span></code></a>, and
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.TransientIndication" title="com.vmware.vapi.std.errors_client.TransientIndication"><code class="xref py py-class docutils literal notranslate"><span class="pre">TransientIndication</span></code></a> classes are intended as possible
|
|||
|
|
values for this attribute.
|
|||
|
|
<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> may also be useful as
|
|||
|
|
a value for this attribute (although that is not its primary
|
|||
|
|
purpose). Some classes may provide their own specific classes for
|
|||
|
|
use as the value of this attribute when reporting exceptions from
|
|||
|
|
their methods.
|
|||
|
|
Some methods will not set this attribute when reporting exceptions.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>error_type</strong> (<a class="reference internal" href="#com.vmware.vapi.std.errors_client.Error.Type" title="com.vmware.vapi.std.errors_client.Error.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error.Type</span></code></a>) – Discriminator field to help API consumers identify the structure
|
|||
|
|
type. This attribute was added in vSphere API 6.7.2.
|
|||
|
|
Can be None for compatibility with preceding implementations.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py exception">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.ResourceBusy">
|
|||
|
|
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">ResourceBusy</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">messages</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">data</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">error_type</span><span class="o">=</span><span class="default_value">'RESOURCE_BUSY'</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.ResourceBusy" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">ResourceBusy</span></code> exception indicates that the method could not be
|
|||
|
|
completed because a resource it needs is busy.</p>
|
|||
|
|
<blockquote>
|
|||
|
|
<div><p>Examples:</p>
|
|||
|
|
</div></blockquote>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>Trying to power off a virtual machine that is in the process of being
|
|||
|
|
powered on.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
<blockquote>
|
|||
|
|
<div><p>Counterexamples:</p>
|
|||
|
|
</div></blockquote>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>Trying to remove a VMFS datastore when there is a virtual machine
|
|||
|
|
registered on any host attached to the datastore. The
|
|||
|
|
<a class="reference internal" href="#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">ResourceInUse</span></code></a> exception would be used instead.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
<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>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – <p>Stack of one or more localizable messages for human exception
|
|||
|
|
consumers.</p>
|
|||
|
|
<p>The message at the top of the stack (first in the list) describes
|
|||
|
|
the exception from the perspective of the method the client
|
|||
|
|
invoked. Each subsequent message in the stack describes the “cause”
|
|||
|
|
of the prior message.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>data</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Data to facilitate clients responding to the method reporting a
|
|||
|
|
standard exception to indicating that it was unable to complete
|
|||
|
|
successfully.</p>
|
|||
|
|
<p>Methods may provide data that clients can use when responding to
|
|||
|
|
exceptions. Since the data that clients need may be specific to the
|
|||
|
|
context of the method reporting the exception, different methods
|
|||
|
|
that report the same exception may provide different data in the
|
|||
|
|
exception. The documentation for each each method will describe
|
|||
|
|
what, if any, data it provides for each exception it reports. The
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.ArgumentLocations" title="com.vmware.vapi.std.errors_client.ArgumentLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentLocations</span></code></a>, <a class="reference internal" href="#com.vmware.vapi.std.errors_client.FileLocations" title="com.vmware.vapi.std.errors_client.FileLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileLocations</span></code></a>, and
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.TransientIndication" title="com.vmware.vapi.std.errors_client.TransientIndication"><code class="xref py py-class docutils literal notranslate"><span class="pre">TransientIndication</span></code></a> classes are intended as possible
|
|||
|
|
values for this attribute.
|
|||
|
|
<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> may also be useful as
|
|||
|
|
a value for this attribute (although that is not its primary
|
|||
|
|
purpose). Some classes may provide their own specific classes for
|
|||
|
|
use as the value of this attribute when reporting exceptions from
|
|||
|
|
their methods.
|
|||
|
|
Some methods will not set this attribute when reporting exceptions.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>error_type</strong> (<a class="reference internal" href="#com.vmware.vapi.std.errors_client.Error.Type" title="com.vmware.vapi.std.errors_client.Error.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error.Type</span></code></a>) – Discriminator field to help API consumers identify the structure
|
|||
|
|
type. This attribute was added in vSphere API 6.7.2.
|
|||
|
|
Can be None for compatibility with preceding implementations.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py exception">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.ResourceInUse">
|
|||
|
|
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">ResourceInUse</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">messages</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">data</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">error_type</span><span class="o">=</span><span class="default_value">'RESOURCE_IN_USE'</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.ResourceInUse" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">ResourceInUse</span></code> exception indicates that the method could not be
|
|||
|
|
completed because a resource is in use.</p>
|
|||
|
|
<blockquote>
|
|||
|
|
<div><p>Examples:</p>
|
|||
|
|
</div></blockquote>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>Trying to remove a VMFS datastore when the is a virtual machine
|
|||
|
|
registered on any host attached to the datastore.</p></li>
|
|||
|
|
<li><p>Trying to add a virtual switch if the physical network adapter being
|
|||
|
|
bridged is already in use.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
<blockquote>
|
|||
|
|
<div><p>Counterexamples:</p>
|
|||
|
|
</div></blockquote>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>Trying to power off a virtual machine that is in the process of being
|
|||
|
|
powered on. The <a class="reference internal" href="#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">ResourceBusy</span></code></a> exception would be used instead.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
<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>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – <p>Stack of one or more localizable messages for human exception
|
|||
|
|
consumers.</p>
|
|||
|
|
<p>The message at the top of the stack (first in the list) describes
|
|||
|
|
the exception from the perspective of the method the client
|
|||
|
|
invoked. Each subsequent message in the stack describes the “cause”
|
|||
|
|
of the prior message.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>data</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Data to facilitate clients responding to the method reporting a
|
|||
|
|
standard exception to indicating that it was unable to complete
|
|||
|
|
successfully.</p>
|
|||
|
|
<p>Methods may provide data that clients can use when responding to
|
|||
|
|
exceptions. Since the data that clients need may be specific to the
|
|||
|
|
context of the method reporting the exception, different methods
|
|||
|
|
that report the same exception may provide different data in the
|
|||
|
|
exception. The documentation for each each method will describe
|
|||
|
|
what, if any, data it provides for each exception it reports. The
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.ArgumentLocations" title="com.vmware.vapi.std.errors_client.ArgumentLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentLocations</span></code></a>, <a class="reference internal" href="#com.vmware.vapi.std.errors_client.FileLocations" title="com.vmware.vapi.std.errors_client.FileLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileLocations</span></code></a>, and
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.TransientIndication" title="com.vmware.vapi.std.errors_client.TransientIndication"><code class="xref py py-class docutils literal notranslate"><span class="pre">TransientIndication</span></code></a> classes are intended as possible
|
|||
|
|
values for this attribute.
|
|||
|
|
<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> may also be useful as
|
|||
|
|
a value for this attribute (although that is not its primary
|
|||
|
|
purpose). Some classes may provide their own specific classes for
|
|||
|
|
use as the value of this attribute when reporting exceptions from
|
|||
|
|
their methods.
|
|||
|
|
Some methods will not set this attribute when reporting exceptions.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>error_type</strong> (<a class="reference internal" href="#com.vmware.vapi.std.errors_client.Error.Type" title="com.vmware.vapi.std.errors_client.Error.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error.Type</span></code></a>) – Discriminator field to help API consumers identify the structure
|
|||
|
|
type. This attribute was added in vSphere API 6.7.2.
|
|||
|
|
Can be None for compatibility with preceding implementations.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py exception">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.ResourceInaccessible">
|
|||
|
|
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">ResourceInaccessible</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">messages</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">data</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">error_type</span><span class="o">=</span><span class="default_value">'RESOURCE_INACCESSIBLE'</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">ResourceInaccessible</span></code> exception indicates that the method could not
|
|||
|
|
be completed because an entity is not accessible.</p>
|
|||
|
|
<blockquote>
|
|||
|
|
<div><p>Examples:</p>
|
|||
|
|
</div></blockquote>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>Attempt to invoke some method on a virtual machine when the virtual
|
|||
|
|
machine’s configuration file is not accessible (for example due to a
|
|||
|
|
storage APD condition).</p></li>
|
|||
|
|
</ul>
|
|||
|
|
<blockquote>
|
|||
|
|
<div><p>Counterexamples:</p>
|
|||
|
|
</div></blockquote>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>Attempt to invoke some method when the server is too busy. The
|
|||
|
|
<a class="reference internal" href="#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">ServiceUnavailable</span></code></a> exception would be used instead.</p></li>
|
|||
|
|
<li><p>Attempt to invoke some method when the server is undergoing maintenance.
|
|||
|
|
The <a class="reference internal" href="#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">ServiceUnavailable</span></code></a> exception would be used instead.</p></li>
|
|||
|
|
<li><p>Some method fails to contact VMware Tools running inside the virtual
|
|||
|
|
machine. The <a class="reference internal" href="#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">ServiceUnavailable</span></code></a> exception would be used instead.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
<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>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – <p>Stack of one or more localizable messages for human exception
|
|||
|
|
consumers.</p>
|
|||
|
|
<p>The message at the top of the stack (first in the list) describes
|
|||
|
|
the exception from the perspective of the method the client
|
|||
|
|
invoked. Each subsequent message in the stack describes the “cause”
|
|||
|
|
of the prior message.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>data</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Data to facilitate clients responding to the method reporting a
|
|||
|
|
standard exception to indicating that it was unable to complete
|
|||
|
|
successfully.</p>
|
|||
|
|
<p>Methods may provide data that clients can use when responding to
|
|||
|
|
exceptions. Since the data that clients need may be specific to the
|
|||
|
|
context of the method reporting the exception, different methods
|
|||
|
|
that report the same exception may provide different data in the
|
|||
|
|
exception. The documentation for each each method will describe
|
|||
|
|
what, if any, data it provides for each exception it reports. The
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.ArgumentLocations" title="com.vmware.vapi.std.errors_client.ArgumentLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentLocations</span></code></a>, <a class="reference internal" href="#com.vmware.vapi.std.errors_client.FileLocations" title="com.vmware.vapi.std.errors_client.FileLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileLocations</span></code></a>, and
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.TransientIndication" title="com.vmware.vapi.std.errors_client.TransientIndication"><code class="xref py py-class docutils literal notranslate"><span class="pre">TransientIndication</span></code></a> classes are intended as possible
|
|||
|
|
values for this attribute.
|
|||
|
|
<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> may also be useful as
|
|||
|
|
a value for this attribute (although that is not its primary
|
|||
|
|
purpose). Some classes may provide their own specific classes for
|
|||
|
|
use as the value of this attribute when reporting exceptions from
|
|||
|
|
their methods.
|
|||
|
|
Some methods will not set this attribute when reporting exceptions.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>error_type</strong> (<a class="reference internal" href="#com.vmware.vapi.std.errors_client.Error.Type" title="com.vmware.vapi.std.errors_client.Error.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error.Type</span></code></a>) – Discriminator field to help API consumers identify the structure
|
|||
|
|
type. This attribute was added in vSphere API 6.7.2.
|
|||
|
|
Can be None for compatibility with preceding implementations.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py exception">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.ServiceUnavailable">
|
|||
|
|
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">ServiceUnavailable</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">messages</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">data</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">error_type</span><span class="o">=</span><span class="default_value">'SERVICE_UNAVAILABLE'</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">ServiceUnavailable</span></code> exception indicates that the class is
|
|||
|
|
unavailable.</p>
|
|||
|
|
<blockquote>
|
|||
|
|
<div><p>Examples:</p>
|
|||
|
|
</div></blockquote>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>Attempt to invoke a method when the server is too busy.</p></li>
|
|||
|
|
<li><p>Attempt to invoke a method when the server is undergoing maintenance.</p></li>
|
|||
|
|
<li><p>An method fails to contact VMware Tools running inside the virtual
|
|||
|
|
machine.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
<blockquote>
|
|||
|
|
<div><p>Counterexamples:</p>
|
|||
|
|
</div></blockquote>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>A client provides an invalid service or operation identifier when
|
|||
|
|
invoking the method using a dynamic interface (for example REST). The
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.OperationNotFound" title="com.vmware.vapi.std.errors_client.OperationNotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">OperationNotFound</span></code></a> exception would be used instead.</p></li>
|
|||
|
|
<li><p>A client invokes the method from the class, but that class has not been
|
|||
|
|
installed. The <a class="reference internal" href="#com.vmware.vapi.std.errors_client.OperationNotFound" title="com.vmware.vapi.std.errors_client.OperationNotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">OperationNotFound</span></code></a> exception would be used instead.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
<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>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – <p>Stack of one or more localizable messages for human exception
|
|||
|
|
consumers.</p>
|
|||
|
|
<p>The message at the top of the stack (first in the list) describes
|
|||
|
|
the exception from the perspective of the method the client
|
|||
|
|
invoked. Each subsequent message in the stack describes the “cause”
|
|||
|
|
of the prior message.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>data</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Data to facilitate clients responding to the method reporting a
|
|||
|
|
standard exception to indicating that it was unable to complete
|
|||
|
|
successfully.</p>
|
|||
|
|
<p>Methods may provide data that clients can use when responding to
|
|||
|
|
exceptions. Since the data that clients need may be specific to the
|
|||
|
|
context of the method reporting the exception, different methods
|
|||
|
|
that report the same exception may provide different data in the
|
|||
|
|
exception. The documentation for each each method will describe
|
|||
|
|
what, if any, data it provides for each exception it reports. The
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.ArgumentLocations" title="com.vmware.vapi.std.errors_client.ArgumentLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentLocations</span></code></a>, <a class="reference internal" href="#com.vmware.vapi.std.errors_client.FileLocations" title="com.vmware.vapi.std.errors_client.FileLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileLocations</span></code></a>, and
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.TransientIndication" title="com.vmware.vapi.std.errors_client.TransientIndication"><code class="xref py py-class docutils literal notranslate"><span class="pre">TransientIndication</span></code></a> classes are intended as possible
|
|||
|
|
values for this attribute.
|
|||
|
|
<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> may also be useful as
|
|||
|
|
a value for this attribute (although that is not its primary
|
|||
|
|
purpose). Some classes may provide their own specific classes for
|
|||
|
|
use as the value of this attribute when reporting exceptions from
|
|||
|
|
their methods.
|
|||
|
|
Some methods will not set this attribute when reporting exceptions.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>error_type</strong> (<a class="reference internal" href="#com.vmware.vapi.std.errors_client.Error.Type" title="com.vmware.vapi.std.errors_client.Error.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error.Type</span></code></a>) – Discriminator field to help API consumers identify the structure
|
|||
|
|
type. This attribute was added in vSphere API 6.7.2.
|
|||
|
|
Can be None for compatibility with preceding implementations.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.StubFactory">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
|||
|
|
<p>Initialize StubFactoryBase</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py exception">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.TimedOut">
|
|||
|
|
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">TimedOut</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">messages</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">data</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">error_type</span><span class="o">=</span><span class="default_value">'TIMED_OUT'</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.TimedOut" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">TimedOut</span></code> exception indicates that the method did not complete
|
|||
|
|
within the allowed amount of time. The allowed amount of time might be:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>provided by the client as an input parameter.</p></li>
|
|||
|
|
<li><p>a fixed limit of the class implementation that is a documented part of
|
|||
|
|
the contract of the class.</p></li>
|
|||
|
|
<li><p>a configurable limit used by the implementation of the class.</p></li>
|
|||
|
|
<li><p>a dynamic limit computed by the implementation of the class.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
<p>The method may or may not complete after the <code class="docutils literal notranslate"><span class="pre">TimedOut</span></code> exception was
|
|||
|
|
reported.</p>
|
|||
|
|
<blockquote>
|
|||
|
|
<div><p>Examples:</p>
|
|||
|
|
</div></blockquote>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>The method was unable to complete within the timeout duration specified
|
|||
|
|
by a parameter of the method.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
<blockquote>
|
|||
|
|
<div><p>Counterexamples:</p>
|
|||
|
|
</div></blockquote>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>A server implementation that puts requests into a queue before
|
|||
|
|
dispatching them might delete a request from the queue if it doesn’t get
|
|||
|
|
dispatched within <em>n</em> minutes. The <a class="reference internal" href="#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">ServiceUnavailable</span></code></a> exception
|
|||
|
|
would be used instead.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
<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>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – <p>Stack of one or more localizable messages for human exception
|
|||
|
|
consumers.</p>
|
|||
|
|
<p>The message at the top of the stack (first in the list) describes
|
|||
|
|
the exception from the perspective of the method the client
|
|||
|
|
invoked. Each subsequent message in the stack describes the “cause”
|
|||
|
|
of the prior message.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>data</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Data to facilitate clients responding to the method reporting a
|
|||
|
|
standard exception to indicating that it was unable to complete
|
|||
|
|
successfully.</p>
|
|||
|
|
<p>Methods may provide data that clients can use when responding to
|
|||
|
|
exceptions. Since the data that clients need may be specific to the
|
|||
|
|
context of the method reporting the exception, different methods
|
|||
|
|
that report the same exception may provide different data in the
|
|||
|
|
exception. The documentation for each each method will describe
|
|||
|
|
what, if any, data it provides for each exception it reports. The
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.ArgumentLocations" title="com.vmware.vapi.std.errors_client.ArgumentLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentLocations</span></code></a>, <a class="reference internal" href="#com.vmware.vapi.std.errors_client.FileLocations" title="com.vmware.vapi.std.errors_client.FileLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileLocations</span></code></a>, and
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.TransientIndication" title="com.vmware.vapi.std.errors_client.TransientIndication"><code class="xref py py-class docutils literal notranslate"><span class="pre">TransientIndication</span></code></a> classes are intended as possible
|
|||
|
|
values for this attribute.
|
|||
|
|
<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> may also be useful as
|
|||
|
|
a value for this attribute (although that is not its primary
|
|||
|
|
purpose). Some classes may provide their own specific classes for
|
|||
|
|
use as the value of this attribute when reporting exceptions from
|
|||
|
|
their methods.
|
|||
|
|
Some methods will not set this attribute when reporting exceptions.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>error_type</strong> (<a class="reference internal" href="#com.vmware.vapi.std.errors_client.Error.Type" title="com.vmware.vapi.std.errors_client.Error.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error.Type</span></code></a>) – Discriminator field to help API consumers identify the structure
|
|||
|
|
type. This attribute was added in vSphere API 6.7.2.
|
|||
|
|
Can be None for compatibility with preceding implementations.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.TransientIndication">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">TransientIndication</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">is_transient</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.TransientIndication" 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">TransientIndication</span></code> class indicates whether or not the exception is
|
|||
|
|
transient.</p>
|
|||
|
|
<p>Some types of exceptions are transient in certain situtations and not
|
|||
|
|
transient in other situtations. This exception payload can be used to
|
|||
|
|
indicate to clients whether a particular exception is transient. See
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Error.data</span></code>.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>is_transient</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Indicates that the exception this class is attached to is
|
|||
|
|
transient.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py exception">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.UnableToAllocateResource">
|
|||
|
|
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">UnableToAllocateResource</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">messages</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">data</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">error_type</span><span class="o">=</span><span class="default_value">'UNABLE_TO_ALLOCATE_RESOURCE'</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.UnableToAllocateResource" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">UnableToAllocateResource</span></code> exception indicates that the method failed
|
|||
|
|
because it was unable to allocate or acquire a required resource.</p>
|
|||
|
|
<blockquote>
|
|||
|
|
<div><p>Examples:</p>
|
|||
|
|
</div></blockquote>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>Trying to power on a virtual machine when there are not enough licenses
|
|||
|
|
to do so.</p></li>
|
|||
|
|
<li><p>Trying to power on a virtual machine that would violate a resource usage
|
|||
|
|
policy.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
<blockquote>
|
|||
|
|
<div><p>Counterexamples:</p>
|
|||
|
|
</div></blockquote>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>Trying to power off a virtual machine that is in the process of being
|
|||
|
|
powered on. A <a class="reference internal" href="#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">ResourceBusy</span></code></a> exception would be used instead.</p></li>
|
|||
|
|
<li><p>Trying to remove a VMFS datastore when the is a virtual machine
|
|||
|
|
registered on any host attached to the datastore. The
|
|||
|
|
<a class="reference internal" href="#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">ResourceInUse</span></code></a> exception would be used instead.</p></li>
|
|||
|
|
<li><p>Trying to add a virtual switch if the physical network adapter being
|
|||
|
|
bridged is already in use. The <a class="reference internal" href="#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">ResourceInUse</span></code></a> exception would be
|
|||
|
|
used instead.</p></li>
|
|||
|
|
<li><p>Attempt to invoke some method on a virtual machine when the virtual
|
|||
|
|
machine’s configuration file is not accessible (for example due to a
|
|||
|
|
storage APD condition). The <a class="reference internal" href="#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">ResourceInaccessible</span></code></a> exception would
|
|||
|
|
be used instead.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
<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>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – <p>Stack of one or more localizable messages for human exception
|
|||
|
|
consumers.</p>
|
|||
|
|
<p>The message at the top of the stack (first in the list) describes
|
|||
|
|
the exception from the perspective of the method the client
|
|||
|
|
invoked. Each subsequent message in the stack describes the “cause”
|
|||
|
|
of the prior message.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>data</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Data to facilitate clients responding to the method reporting a
|
|||
|
|
standard exception to indicating that it was unable to complete
|
|||
|
|
successfully.</p>
|
|||
|
|
<p>Methods may provide data that clients can use when responding to
|
|||
|
|
exceptions. Since the data that clients need may be specific to the
|
|||
|
|
context of the method reporting the exception, different methods
|
|||
|
|
that report the same exception may provide different data in the
|
|||
|
|
exception. The documentation for each each method will describe
|
|||
|
|
what, if any, data it provides for each exception it reports. The
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.ArgumentLocations" title="com.vmware.vapi.std.errors_client.ArgumentLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentLocations</span></code></a>, <a class="reference internal" href="#com.vmware.vapi.std.errors_client.FileLocations" title="com.vmware.vapi.std.errors_client.FileLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileLocations</span></code></a>, and
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.TransientIndication" title="com.vmware.vapi.std.errors_client.TransientIndication"><code class="xref py py-class docutils literal notranslate"><span class="pre">TransientIndication</span></code></a> classes are intended as possible
|
|||
|
|
values for this attribute.
|
|||
|
|
<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> may also be useful as
|
|||
|
|
a value for this attribute (although that is not its primary
|
|||
|
|
purpose). Some classes may provide their own specific classes for
|
|||
|
|
use as the value of this attribute when reporting exceptions from
|
|||
|
|
their methods.
|
|||
|
|
Some methods will not set this attribute when reporting exceptions.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>error_type</strong> (<a class="reference internal" href="#com.vmware.vapi.std.errors_client.Error.Type" title="com.vmware.vapi.std.errors_client.Error.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error.Type</span></code></a>) – Discriminator field to help API consumers identify the structure
|
|||
|
|
type. This attribute was added in vSphere API 6.7.2.
|
|||
|
|
Can be None for compatibility with preceding implementations.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py exception">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.Unauthenticated">
|
|||
|
|
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">Unauthenticated</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">messages</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">data</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">error_type</span><span class="o">=</span><span class="default_value">'UNAUTHENTICATED'</span></em>, <em class="sig-param"><span class="n">challenge</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Unauthenticated" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Unauthenticated</span></code> exception indicates that the method requires
|
|||
|
|
authentication and the user is not authenticated.</p>
|
|||
|
|
<p>API requests may include a security context containing user credentials.
|
|||
|
|
For example, the user credentials could be a SAML token, a user name and
|
|||
|
|
password, or the session identifier for a previously established session.</p>
|
|||
|
|
<blockquote>
|
|||
|
|
<div><p>Examples:</p>
|
|||
|
|
</div></blockquote>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>The SAML token in the request’s security context has expired.</p></li>
|
|||
|
|
<li><p>The user name and password in the request’s security context are invalid.</p></li>
|
|||
|
|
<li><p>The session identifier in the request’s security context identifies a
|
|||
|
|
session that has expired.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
<blockquote>
|
|||
|
|
<div><p>Counterexamples:</p>
|
|||
|
|
</div></blockquote>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>The user is authenticated but isn’t authorized to perform the requested
|
|||
|
|
method. The <a class="reference internal" href="#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">Unauthorized</span></code></a> exception would be used instead.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
<p>For security reasons, the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Error.data</span></code> attribute in this exception is
|
|||
|
|
None, and the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Error.messages</span></code> attribute in this exception does not
|
|||
|
|
disclose which part of the security context is correct or incorrect. For
|
|||
|
|
example the messages would not disclose whether a username or a password is
|
|||
|
|
valid or invalid, but only that a combination of username and password is
|
|||
|
|
invalid.</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>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – <p>Stack of one or more localizable messages for human exception
|
|||
|
|
consumers.</p>
|
|||
|
|
<p>The message at the top of the stack (first in the list) describes
|
|||
|
|
the exception from the perspective of the method the client
|
|||
|
|
invoked. Each subsequent message in the stack describes the “cause”
|
|||
|
|
of the prior message.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>data</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Data to facilitate clients responding to the method reporting a
|
|||
|
|
standard exception to indicating that it was unable to complete
|
|||
|
|
successfully.</p>
|
|||
|
|
<p>Methods may provide data that clients can use when responding to
|
|||
|
|
exceptions. Since the data that clients need may be specific to the
|
|||
|
|
context of the method reporting the exception, different methods
|
|||
|
|
that report the same exception may provide different data in the
|
|||
|
|
exception. The documentation for each each method will describe
|
|||
|
|
what, if any, data it provides for each exception it reports. The
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.ArgumentLocations" title="com.vmware.vapi.std.errors_client.ArgumentLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentLocations</span></code></a>, <a class="reference internal" href="#com.vmware.vapi.std.errors_client.FileLocations" title="com.vmware.vapi.std.errors_client.FileLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileLocations</span></code></a>, and
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.TransientIndication" title="com.vmware.vapi.std.errors_client.TransientIndication"><code class="xref py py-class docutils literal notranslate"><span class="pre">TransientIndication</span></code></a> classes are intended as possible
|
|||
|
|
values for this attribute.
|
|||
|
|
<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> may also be useful as
|
|||
|
|
a value for this attribute (although that is not its primary
|
|||
|
|
purpose). Some classes may provide their own specific classes for
|
|||
|
|
use as the value of this attribute when reporting exceptions from
|
|||
|
|
their methods.
|
|||
|
|
Some methods will not set this attribute when reporting exceptions.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>error_type</strong> (<a class="reference internal" href="#com.vmware.vapi.std.errors_client.Error.Type" title="com.vmware.vapi.std.errors_client.Error.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error.Type</span></code></a>) – Discriminator field to help API consumers identify the structure
|
|||
|
|
type. This attribute was added in vSphere API 6.7.2.
|
|||
|
|
Can be None for compatibility with preceding implementations.</p></li>
|
|||
|
|
<li><p><strong>challenge</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>Indicates the authentication challenges applicable to the target
|
|||
|
|
API provider. It can be used by a client to discover the correct
|
|||
|
|
authentication scheme to use. The exact syntax of the value is
|
|||
|
|
defined by the specific provider, the protocol and authentication
|
|||
|
|
schemes used.</p>
|
|||
|
|
<p>For example, a provider using REST may adhere to the
|
|||
|
|
WWW-Authenticate HTTP header specification, RFC7235, section 4.1.
|
|||
|
|
In this case an example challenge value may be: SIGN
|
|||
|
|
realm=”27da1358-2ba4-11e9-b210-d663bd873d93”,sts=”<a class="reference external" href="http://vcenter/sso?vsphere.local">http://vcenter/sso?vsphere.local</a>”,
|
|||
|
|
Basic realm=”vCenter”. This attribute was added in vSphere API
|
|||
|
|
7.0.0.0.
|
|||
|
|
This attribute is optional because it was added in a newer version
|
|||
|
|
than its parent node.</p>
|
|||
|
|
</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py exception">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.Unauthorized">
|
|||
|
|
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">Unauthorized</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">messages</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">data</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">error_type</span><span class="o">=</span><span class="default_value">'UNAUTHORIZED'</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Unauthorized" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Unauthorized</span></code> exception indicates that the user is not authorized to
|
|||
|
|
perform the method.</p>
|
|||
|
|
<p>API requests may include a security context containing user credentials.
|
|||
|
|
For example, the user credentials could be a SAML token, a user name and
|
|||
|
|
password, or the session identifier for a previously established session.
|
|||
|
|
Invoking the method may require that the user identified by those
|
|||
|
|
credentials has particular privileges on the method or on one or more
|
|||
|
|
resource identifiers passed to the method.</p>
|
|||
|
|
<blockquote>
|
|||
|
|
<div><p>Examples:</p>
|
|||
|
|
</div></blockquote>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>The method requires that the user have one or more privileges on the
|
|||
|
|
method, but the user identified by the credentials in the security context
|
|||
|
|
does not have the required privileges.</p></li>
|
|||
|
|
<li><p>The method requires that the user have one or more privileges on a
|
|||
|
|
resource identifier passed to the method, but the user identified by the
|
|||
|
|
credentials in the security context does not have the required privileges.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
<blockquote>
|
|||
|
|
<div><p>Counterexamples:</p>
|
|||
|
|
</div></blockquote>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>The SAML token in the request’s security context has expired. A
|
|||
|
|
<a class="reference internal" href="#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">Unauthenticated</span></code></a> exception would be used instead.</p></li>
|
|||
|
|
<li><p>The user name and password in the request’s security context are invalid.
|
|||
|
|
The <a class="reference internal" href="#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">Unauthenticated</span></code></a> exception would be used instead.</p></li>
|
|||
|
|
<li><p>The session identifier in the request’s security context identifies a
|
|||
|
|
session that has expired. The <a class="reference internal" href="#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">Unauthenticated</span></code></a> exception would be
|
|||
|
|
used instead.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
<p>For security reasons, the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Error.data</span></code> attribute in this exception is
|
|||
|
|
None, and the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Error.messages</span></code> attribute in this exception does not
|
|||
|
|
disclose why the user is not authorized to perform the method. For example
|
|||
|
|
the messages would not disclose which privilege the user did not have or
|
|||
|
|
which resource identifier the user did not have the required privilege to
|
|||
|
|
access. The API documentation should indicate what privileges are required.</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>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – <p>Stack of one or more localizable messages for human exception
|
|||
|
|
consumers.</p>
|
|||
|
|
<p>The message at the top of the stack (first in the list) describes
|
|||
|
|
the exception from the perspective of the method the client
|
|||
|
|
invoked. Each subsequent message in the stack describes the “cause”
|
|||
|
|
of the prior message.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>data</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Data to facilitate clients responding to the method reporting a
|
|||
|
|
standard exception to indicating that it was unable to complete
|
|||
|
|
successfully.</p>
|
|||
|
|
<p>Methods may provide data that clients can use when responding to
|
|||
|
|
exceptions. Since the data that clients need may be specific to the
|
|||
|
|
context of the method reporting the exception, different methods
|
|||
|
|
that report the same exception may provide different data in the
|
|||
|
|
exception. The documentation for each each method will describe
|
|||
|
|
what, if any, data it provides for each exception it reports. The
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.ArgumentLocations" title="com.vmware.vapi.std.errors_client.ArgumentLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentLocations</span></code></a>, <a class="reference internal" href="#com.vmware.vapi.std.errors_client.FileLocations" title="com.vmware.vapi.std.errors_client.FileLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileLocations</span></code></a>, and
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.TransientIndication" title="com.vmware.vapi.std.errors_client.TransientIndication"><code class="xref py py-class docutils literal notranslate"><span class="pre">TransientIndication</span></code></a> classes are intended as possible
|
|||
|
|
values for this attribute.
|
|||
|
|
<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> may also be useful as
|
|||
|
|
a value for this attribute (although that is not its primary
|
|||
|
|
purpose). Some classes may provide their own specific classes for
|
|||
|
|
use as the value of this attribute when reporting exceptions from
|
|||
|
|
their methods.
|
|||
|
|
Some methods will not set this attribute when reporting exceptions.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>error_type</strong> (<a class="reference internal" href="#com.vmware.vapi.std.errors_client.Error.Type" title="com.vmware.vapi.std.errors_client.Error.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error.Type</span></code></a>) – Discriminator field to help API consumers identify the structure
|
|||
|
|
type. This attribute was added in vSphere API 6.7.2.
|
|||
|
|
Can be None for compatibility with preceding implementations.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py exception">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.UnexpectedInput">
|
|||
|
|
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">UnexpectedInput</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">messages</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">data</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">error_type</span><span class="o">=</span><span class="default_value">'UNEXPECTED_INPUT'</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.UnexpectedInput" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">UnexpectedInput</span></code> exception indicates that the request contained a
|
|||
|
|
parameter or attribute whose name is not known by the server.</p>
|
|||
|
|
<p>Every method expects parameters with known names. Some of those parameters
|
|||
|
|
may be (or contain) classes, and the method expects those classes to
|
|||
|
|
contain attributes with known names. If the method receives parameters or
|
|||
|
|
attributes with names that is does not expect, this exception may be
|
|||
|
|
reported.</p>
|
|||
|
|
<p>This exception can be reported by the API infrastructure for any method,
|
|||
|
|
but it is specific to the API infrastructure, and should never be reported
|
|||
|
|
by the implementation of any method.</p>
|
|||
|
|
<blockquote>
|
|||
|
|
<div><p>Examples:</p>
|
|||
|
|
</div></blockquote>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>A client using stubs generated from the interface specification for
|
|||
|
|
version2 of a class invokes the method passing one or more parameters that
|
|||
|
|
were added in version2, but they are communicating with a server that only
|
|||
|
|
supports version1 of the class.</p></li>
|
|||
|
|
<li><p>A client provides an unexpected parameter or attribute name when invoking
|
|||
|
|
the method using a dynamic interface (for example REST).</p></li>
|
|||
|
|
</ul>
|
|||
|
|
<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>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – <p>Stack of one or more localizable messages for human exception
|
|||
|
|
consumers.</p>
|
|||
|
|
<p>The message at the top of the stack (first in the list) describes
|
|||
|
|
the exception from the perspective of the method the client
|
|||
|
|
invoked. Each subsequent message in the stack describes the “cause”
|
|||
|
|
of the prior message.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>data</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Data to facilitate clients responding to the method reporting a
|
|||
|
|
standard exception to indicating that it was unable to complete
|
|||
|
|
successfully.</p>
|
|||
|
|
<p>Methods may provide data that clients can use when responding to
|
|||
|
|
exceptions. Since the data that clients need may be specific to the
|
|||
|
|
context of the method reporting the exception, different methods
|
|||
|
|
that report the same exception may provide different data in the
|
|||
|
|
exception. The documentation for each each method will describe
|
|||
|
|
what, if any, data it provides for each exception it reports. The
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.ArgumentLocations" title="com.vmware.vapi.std.errors_client.ArgumentLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentLocations</span></code></a>, <a class="reference internal" href="#com.vmware.vapi.std.errors_client.FileLocations" title="com.vmware.vapi.std.errors_client.FileLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileLocations</span></code></a>, and
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.TransientIndication" title="com.vmware.vapi.std.errors_client.TransientIndication"><code class="xref py py-class docutils literal notranslate"><span class="pre">TransientIndication</span></code></a> classes are intended as possible
|
|||
|
|
values for this attribute.
|
|||
|
|
<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> may also be useful as
|
|||
|
|
a value for this attribute (although that is not its primary
|
|||
|
|
purpose). Some classes may provide their own specific classes for
|
|||
|
|
use as the value of this attribute when reporting exceptions from
|
|||
|
|
their methods.
|
|||
|
|
Some methods will not set this attribute when reporting exceptions.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>error_type</strong> (<a class="reference internal" href="#com.vmware.vapi.std.errors_client.Error.Type" title="com.vmware.vapi.std.errors_client.Error.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error.Type</span></code></a>) – Discriminator field to help API consumers identify the structure
|
|||
|
|
type. This attribute was added in vSphere API 6.7.2.
|
|||
|
|
Can be None for compatibility with preceding implementations.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py exception">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.Unsupported">
|
|||
|
|
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">Unsupported</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">messages</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">data</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">error_type</span><span class="o">=</span><span class="default_value">'UNSUPPORTED'</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.Unsupported" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Unsupported</span></code> exception indicates that the method is not supported by
|
|||
|
|
the class.</p>
|
|||
|
|
<blockquote>
|
|||
|
|
<div><p>Examples:</p>
|
|||
|
|
</div></blockquote>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>Trying to hot-plug a CPU when the current configuration of the VM does
|
|||
|
|
not support hot-plugging of CPUs.</p></li>
|
|||
|
|
<li><p>Trying to change the memory size to a value that is not within the
|
|||
|
|
acceptable guest memory bounds supported by the virtual machine’s host.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
<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>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – <p>Stack of one or more localizable messages for human exception
|
|||
|
|
consumers.</p>
|
|||
|
|
<p>The message at the top of the stack (first in the list) describes
|
|||
|
|
the exception from the perspective of the method the client
|
|||
|
|
invoked. Each subsequent message in the stack describes the “cause”
|
|||
|
|
of the prior message.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>data</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Data to facilitate clients responding to the method reporting a
|
|||
|
|
standard exception to indicating that it was unable to complete
|
|||
|
|
successfully.</p>
|
|||
|
|
<p>Methods may provide data that clients can use when responding to
|
|||
|
|
exceptions. Since the data that clients need may be specific to the
|
|||
|
|
context of the method reporting the exception, different methods
|
|||
|
|
that report the same exception may provide different data in the
|
|||
|
|
exception. The documentation for each each method will describe
|
|||
|
|
what, if any, data it provides for each exception it reports. The
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.ArgumentLocations" title="com.vmware.vapi.std.errors_client.ArgumentLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentLocations</span></code></a>, <a class="reference internal" href="#com.vmware.vapi.std.errors_client.FileLocations" title="com.vmware.vapi.std.errors_client.FileLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileLocations</span></code></a>, and
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.TransientIndication" title="com.vmware.vapi.std.errors_client.TransientIndication"><code class="xref py py-class docutils literal notranslate"><span class="pre">TransientIndication</span></code></a> classes are intended as possible
|
|||
|
|
values for this attribute.
|
|||
|
|
<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> may also be useful as
|
|||
|
|
a value for this attribute (although that is not its primary
|
|||
|
|
purpose). Some classes may provide their own specific classes for
|
|||
|
|
use as the value of this attribute when reporting exceptions from
|
|||
|
|
their methods.
|
|||
|
|
Some methods will not set this attribute when reporting exceptions.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>error_type</strong> (<a class="reference internal" href="#com.vmware.vapi.std.errors_client.Error.Type" title="com.vmware.vapi.std.errors_client.Error.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error.Type</span></code></a>) – Discriminator field to help API consumers identify the structure
|
|||
|
|
type. This attribute was added in vSphere API 6.7.2.
|
|||
|
|
Can be None for compatibility with preceding implementations.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py exception">
|
|||
|
|
<dt id="com.vmware.vapi.std.errors_client.UnverifiedPeer">
|
|||
|
|
<em class="property">exception </em><code class="sig-prename descclassname">com.vmware.vapi.std.errors_client.</code><code class="sig-name descname">UnverifiedPeer</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">messages</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">data</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">error_type</span><span class="o">=</span><span class="default_value">'UNVERIFIED_PEER'</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.errors_client.UnverifiedPeer" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">UnverifiedPeer</span></code> exception indicates that an attempt to connect to an
|
|||
|
|
unknown or not-yet-trusted endpoint failed because the system was unable to
|
|||
|
|
verify the identity of the endpoint.</p>
|
|||
|
|
<p>Typically the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Error.data</span></code> attribute of this error will contain
|
|||
|
|
information that can be presented to a human to allow them to decide
|
|||
|
|
whether to trust the endpoint. If they decide to trust the endpoint, the
|
|||
|
|
request can be resubmitted with an indication that the endpoint should be
|
|||
|
|
trusted.</p>
|
|||
|
|
<blockquote>
|
|||
|
|
<div><p>Examples:</p>
|
|||
|
|
</div></blockquote>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>The client provides an IP address or URL of an endpoint the system should
|
|||
|
|
communicate with using an SSL connection, but the endpoint’s SSL
|
|||
|
|
certificate is self-signed, expired, or otherwise not trustworthy.</p></li>
|
|||
|
|
<li><p>The client provides an IP address of a host the system should communicate
|
|||
|
|
with using ssh, but ssh doesn’t recognize the public key of the host</p></li>
|
|||
|
|
</ul>
|
|||
|
|
<p>. This class was added in vSphere API 6.7.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>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – <p>Stack of one or more localizable messages for human exception
|
|||
|
|
consumers.</p>
|
|||
|
|
<p>The message at the top of the stack (first in the list) describes
|
|||
|
|
the exception from the perspective of the method the client
|
|||
|
|
invoked. Each subsequent message in the stack describes the “cause”
|
|||
|
|
of the prior message.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>data</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Data to facilitate clients responding to the method reporting a
|
|||
|
|
standard exception to indicating that it was unable to complete
|
|||
|
|
successfully.</p>
|
|||
|
|
<p>Methods may provide data that clients can use when responding to
|
|||
|
|
exceptions. Since the data that clients need may be specific to the
|
|||
|
|
context of the method reporting the exception, different methods
|
|||
|
|
that report the same exception may provide different data in the
|
|||
|
|
exception. The documentation for each each method will describe
|
|||
|
|
what, if any, data it provides for each exception it reports. The
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.ArgumentLocations" title="com.vmware.vapi.std.errors_client.ArgumentLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentLocations</span></code></a>, <a class="reference internal" href="#com.vmware.vapi.std.errors_client.FileLocations" title="com.vmware.vapi.std.errors_client.FileLocations"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileLocations</span></code></a>, and
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.errors_client.TransientIndication" title="com.vmware.vapi.std.errors_client.TransientIndication"><code class="xref py py-class docutils literal notranslate"><span class="pre">TransientIndication</span></code></a> classes are intended as possible
|
|||
|
|
values for this attribute.
|
|||
|
|
<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> may also be useful as
|
|||
|
|
a value for this attribute (although that is not its primary
|
|||
|
|
purpose). Some classes may provide their own specific classes for
|
|||
|
|
use as the value of this attribute when reporting exceptions from
|
|||
|
|
their methods.
|
|||
|
|
Some methods will not set this attribute when reporting exceptions.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>error_type</strong> (<a class="reference internal" href="#com.vmware.vapi.std.errors_client.Error.Type" title="com.vmware.vapi.std.errors_client.Error.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error.Type</span></code></a>) – Discriminator field to help API consumers identify the structure
|
|||
|
|
type. This attribute was added in vSphere API 6.7.2.
|
|||
|
|
Can be None for compatibility with preceding implementations.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div class="section" id="module-com.vmware.vapi.std.interposition_client">
|
|||
|
|
<span id="com-vmware-vapi-std-interposition-client-module"></span><h2>com.vmware.vapi.std.interposition_client module<a class="headerlink" href="#module-com.vmware.vapi.std.interposition_client" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.std.interposition_client</span></code> module provides classes that
|
|||
|
|
TODO.</p>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vapi.std.interposition_client.InvocationRequest">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vapi.std.interposition_client.</code><code class="sig-name descname">InvocationRequest</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">service_id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">operation_id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">operation_input</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">user</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">groups</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.interposition_client.InvocationRequest" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>Information about an interposed request for operation invocation. All
|
|||
|
|
interposers would receive an instance of this structure as an input
|
|||
|
|
parameter.</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>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Fully qualified name of the service which contains the interposed
|
|||
|
|
operation. In canonical format. For example org.example.hello.</p></li>
|
|||
|
|
<li><p><strong>operation_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the interposed operation. In canonical format. For example
|
|||
|
|
say_hello.</p></li>
|
|||
|
|
<li><p><strong>operation_input</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">DataValue</span></code>) – Input of the interposed operation.</p></li>
|
|||
|
|
<li><p><strong>user</strong> (<a class="reference internal" href="#com.vmware.vapi.std.interposition_client.SecurityPrincipal" title="com.vmware.vapi.std.interposition_client.SecurityPrincipal"><code class="xref py py-class docutils literal notranslate"><span class="pre">SecurityPrincipal</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – User which started the interposed operation.
|
|||
|
|
There could be no authentication information. For example when
|
|||
|
|
methods are invoked anonymously.</p></li>
|
|||
|
|
<li><p><strong>groups</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vapi.std.interposition_client.SecurityPrincipal" title="com.vmware.vapi.std.interposition_client.SecurityPrincipal"><code class="xref py py-class docutils literal notranslate"><span class="pre">SecurityPrincipal</span></code></a>) – Groups of the user who started the interposed operation. Would be
|
|||
|
|
empty if there is no authentication information.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vapi.std.interposition_client.InvocationResult">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vapi.std.interposition_client.</code><code class="sig-name descname">InvocationResult</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">result_type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">output</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">error</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.interposition_client.InvocationResult" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>Information about the result from an interposed operation invocation. All
|
|||
|
|
POST interposers will receive an instance of this structure.</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>result_type</strong> (<a class="reference internal" href="#com.vmware.vapi.std.interposition_client.InvocationResult.ResultType" title="com.vmware.vapi.std.interposition_client.InvocationResult.ResultType"><code class="xref py py-class docutils literal notranslate"><span class="pre">InvocationResult.ResultType</span></code></a>) – Type of the invocation result.</p></li>
|
|||
|
|
<li><p><strong>output</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">DataValue</span></code>) – Normal result value.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">resultType</span></code> is
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.interposition_client.InvocationResult.ResultType.NORMAL_RESULT" title="com.vmware.vapi.std.interposition_client.InvocationResult.ResultType.NORMAL_RESULT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">InvocationResult.ResultType.NORMAL_RESULT</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>error</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code>) – Error result value.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">resultType</span></code> is
|
|||
|
|
<a class="reference internal" href="#com.vmware.vapi.std.interposition_client.InvocationResult.ResultType.ERROR_RESULT" title="com.vmware.vapi.std.interposition_client.InvocationResult.ResultType.ERROR_RESULT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">InvocationResult.ResultType.ERROR_RESULT</span></code></a>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vapi.std.interposition_client.InvocationResult.ResultType">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">ResultType</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.interposition_client.InvocationResult.ResultType" 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>Type of the invocation result.</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">ResultType</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vapi.std.interposition_client.InvocationResult.ResultType.ERROR_RESULT">
|
|||
|
|
<code class="sig-name descname">ERROR_RESULT</code><em class="property"> = ResultType(string='ERROR_RESULT')</em><a class="headerlink" href="#com.vmware.vapi.std.interposition_client.InvocationResult.ResultType.ERROR_RESULT" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Error invocation result.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vapi.std.interposition_client.InvocationResult.ResultType.NORMAL_RESULT">
|
|||
|
|
<code class="sig-name descname">NORMAL_RESULT</code><em class="property"> = ResultType(string='NORMAL_RESULT')</em><a class="headerlink" href="#com.vmware.vapi.std.interposition_client.InvocationResult.ResultType.NORMAL_RESULT" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Normal invocation result.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vapi.std.interposition_client.SecurityPrincipal">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vapi.std.interposition_client.</code><code class="sig-name descname">SecurityPrincipal</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">domain</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.interposition_client.SecurityPrincipal" 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>VMODL equivalent of com.vmware.vapi.security.PrincipalId.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Principal name.</p></li>
|
|||
|
|
<li><p><strong>domain</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Principal domain.
|
|||
|
|
Domain is optional in <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.security.PrincipalId</span></code></p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vapi.std.interposition_client.StubFactory">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vapi.std.interposition_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std.interposition_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.html" class="btn btn-neutral float-right" title="com.vmware.vcenter package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a href="com.vmware.vapi.metadata.privilege.html" class="btn btn-neutral float-left" title="com.vmware.vapi.metadata.privilege package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<hr/>
|
|||
|
|
|
|||
|
|
<div role="contentinfo">
|
|||
|
|
<p>
|
|||
|
|
|
|||
|
|
© Copyright 2020, VMware, Inc.
|
|||
|
|
|
|||
|
|
</p>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
|
|||
|
|
|
|||
|
|
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
|
|||
|
|
|
|||
|
|
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|||
|
|
|
|||
|
|
</footer>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
</section>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script type="text/javascript">
|
|||
|
|
jQuery(function () {
|
|||
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|||
|
|
});
|
|||
|
|
</script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</body>
|
|||
|
|
</html>
|