mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-22 01:39:58 -05:00
1716 lines
169 KiB
HTML
1716 lines
169 KiB
HTML
<!DOCTYPE html>
|
||
<html class="writer-html5" lang="en" >
|
||
<head>
|
||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<title>com.vmware.cis package — vSphere Automation SDK for Python. 8.0.2.0 documentation</title>
|
||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||
<!--[if lt IE 9]>
|
||
<script src="_static/js/html5shiv.min.js"></script>
|
||
<![endif]-->
|
||
|
||
<script data-url_root="./" id="documentation_options" 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/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.content package" href="com.vmware.content.html" />
|
||
<link rel="prev" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster package" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html" />
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav">
|
||
<div class="wy-grid-for-nav">
|
||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
<div class="wy-side-scroll">
|
||
<div class="wy-side-nav-search" >
|
||
|
||
|
||
|
||
<a href="index.html" class="icon icon-home">
|
||
vSphere Automation SDK for Python.
|
||
</a>
|
||
<div class="version">
|
||
8.0.2.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" aria-label="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="Navigation menu">
|
||
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
||
<ul class="current">
|
||
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
|
||
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
|
||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||
<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="Page navigation">
|
||
<ul class="wy-breadcrumbs">
|
||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||
<li class="breadcrumb-item"><a href="com.html">com package</a></li>
|
||
<li class="breadcrumb-item"><a href="com.vmware.html">com.vmware package</a></li>
|
||
<li class="breadcrumb-item active">com.vmware.cis package</li>
|
||
<li class="wy-breadcrumbs-aside">
|
||
<a href="_sources/com.vmware.cis.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">
|
||
|
||
<section id="module-com.vmware.cis">
|
||
<span id="com-vmware-cis-package"></span><h1>com.vmware.cis package<a class="headerlink" href="#module-com.vmware.cis" title="Permalink to this headline"></a></h1>
|
||
<section id="submodules">
|
||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
|
||
</section>
|
||
<section id="module-com.vmware.cis.tagging_client">
|
||
<span id="com-vmware-cis-tagging-client-module"></span><h2>com.vmware.cis.tagging_client module<a class="headerlink" href="#module-com.vmware.cis.tagging_client" title="Permalink to this headline"></a></h2>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging_client</span></code> component provides methods and classes to
|
||
attach metadata, by means of tags, to vSphere objects to make these objects
|
||
more sortable and searchable. You can use it to create, manage, and enumerate
|
||
tags and their categories (the group a tag belongs to). You can also query the
|
||
attached tags and attached objects.</p>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.tagging_client.Category">
|
||
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.cis.tagging_client.</span></span><span class="sig-name descname"><span class="pre">Category</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Category" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Category</span></code> class provides methods to create, read, update, delete,
|
||
and enumerate categories.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.tagging_client.Category.CreateSpec">
|
||
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">CreateSpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cardinality</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">associable_types</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">category_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Category.CreateSpec" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Category.CreateSpec</span></code> class is used to create a category.</p>
|
||
<p>Use the <a class="reference internal" href="#com.vmware.cis.tagging_client.Category.create" title="com.vmware.cis.tagging_client.Category.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">Category.create()</span></code></a> method to create a category defined by the
|
||
create specification.</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>) – The display name of the category.</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The description of the category.</p></li>
|
||
<li><p><strong>cardinality</strong> (<a class="reference internal" href="#com.vmware.cis.tagging_client.CategoryModel.Cardinality" title="com.vmware.cis.tagging_client.CategoryModel.Cardinality"><code class="xref py py-class docutils literal notranslate"><span class="pre">CategoryModel.Cardinality</span></code></a>) – The associated cardinality (SINGLE, MULTIPLE) of the category.</p></li>
|
||
<li><p><strong>associable_types</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Object types to which this category’s tags can be attached.</p></li>
|
||
<li><p><strong>category_id</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>) – This attribute was added in vSphere API 6.7.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Category</span></code>. When methods return a value of
|
||
this class as a return value, the attribute will be an identifier
|
||
for the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Category</span></code>.
|
||
If None an identifier will be generated by the server</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.tagging_client.Category.UpdateSpec">
|
||
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">UpdateSpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cardinality</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">associable_types</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Category.UpdateSpec" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Category.UpdateSpec</span></code> class describes the updates to be made to an
|
||
existing category.</p>
|
||
<p>Use the <a class="reference internal" href="#com.vmware.cis.tagging_client.Category.update" title="com.vmware.cis.tagging_client.Category.update"><code class="xref py py-func docutils literal notranslate"><span class="pre">Category.update()</span></code></a> method to modify a category. When you call
|
||
the method, specify the category identifier. You obtain the category
|
||
identifier when you call the <a class="reference internal" href="#com.vmware.cis.tagging_client.Category.create" title="com.vmware.cis.tagging_client.Category.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">Category.create()</span></code></a> method. You can also
|
||
retrieve an identifier by using the <a class="reference internal" href="#com.vmware.cis.tagging_client.Category.list" title="com.vmware.cis.tagging_client.Category.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Category.list()</span></code></a> method.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The display name of the category.
|
||
If None the name will not be modified.</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The description of the category.
|
||
If None the description will not be modified.</p></li>
|
||
<li><p><strong>cardinality</strong> (<a class="reference internal" href="#com.vmware.cis.tagging_client.CategoryModel.Cardinality" title="com.vmware.cis.tagging_client.CategoryModel.Cardinality"><code class="xref py py-class docutils literal notranslate"><span class="pre">CategoryModel.Cardinality</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The associated cardinality (SINGLE, MULTIPLE) of the category.
|
||
If None the cardinality will not be modified.</p></li>
|
||
<li><p><strong>associable_types</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Object types to which this category’s tags can be attached.</p>
|
||
<p>The <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of associable types cannot be updated
|
||
incrementally. For example, if
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Category.UpdateSpec.associable_types</span></code> originally contains
|
||
{A,B,C} and you want to add D, then you need to pass {A,B,C,D} in
|
||
your update specification. You also cannot remove any item from
|
||
this <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>. For example, if you have {A,B,C}, then you
|
||
cannot remove say {A} from it. Similarly, if you start with an
|
||
empty <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>, then that implies that you can tag any object
|
||
and hence you cannot later pass say {A}, because that would be
|
||
restricting the type of objects you want to tag. Thus, associable
|
||
types can only grow and not shrink.
|
||
If None the associable types will not be modified.</p>
|
||
</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.tagging_client.Category.add_to_used_by">
|
||
<span class="sig-name descname"><span class="pre">add_to_used_by</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">category_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">used_by_entity</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Category.add_to_used_by" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Adds the <code class="docutils literal notranslate"><span class="pre">used_by_entity</span></code> to the <code class="xref py py-attr docutils literal notranslate"><span class="pre">CategoryModel.used_by</span></code>
|
||
subscribers <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> for the specified category. If the
|
||
<code class="docutils literal notranslate"><span class="pre">used_by_entity</span></code> is already in the <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>, then this becomes an
|
||
idempotent no-op. To invoke this method, you need the modify
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">CategoryModel.used_by</span></code> privilege on the category.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>category_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifier of the input category.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Category</span></code>.</p></li>
|
||
<li><p><strong>used_by_entity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The name of the user to be added to the
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">CategoryModel.used_by</span></code> <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the category for the given <code class="docutils literal notranslate"><span class="pre">category_id</span></code> does not exist in the
|
||
system.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have the privilege to add an entity to the
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">CategoryModel.used_by</span></code> field.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.tagging_client.Category.create">
|
||
<span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">create_spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Category.create" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Creates a category. To invoke this method, you need the create category
|
||
privilege.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>create_spec</strong> (<a class="reference internal" href="#com.vmware.cis.tagging_client.Category.CreateSpec" title="com.vmware.cis.tagging_client.Category.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Category.CreateSpec</span></code></a>) – Specification for the new category to be created.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>The identifier of the created category.
|
||
The return value will be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Category</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
|
||
if the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Category.CreateSpec.name</span></code> provided in the
|
||
<code class="docutils literal notranslate"><span class="pre">create_spec</span></code> is the name of an already existing category.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||
if any of the information in the <code class="docutils literal notranslate"><span class="pre">create_spec</span></code> is invalid.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have the privilege to create a category.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.tagging_client.Category.delete">
|
||
<span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">category_id</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Category.delete" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Deletes an existing category. To invoke this method, you need the
|
||
delete privilege on the category.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>category_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifier of category to be deleted.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Category</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the category for the given <code class="docutils literal notranslate"><span class="pre">category_id</span></code> does not exist in the
|
||
system.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have the privilege to delete the category.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the user can not be authenticated.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.tagging_client.Category.get">
|
||
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">category_id</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Category.get" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Fetches the category information for the given category identifier. In
|
||
order to view the category information, you need the read privilege on
|
||
the category.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>category_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifier of the input category.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Category</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.cis.tagging_client.CategoryModel" title="com.vmware.cis.tagging_client.CategoryModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">CategoryModel</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>The <a class="reference internal" href="#com.vmware.cis.tagging_client.CategoryModel" title="com.vmware.cis.tagging_client.CategoryModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">CategoryModel</span></code></a> that corresponds to <code class="docutils literal notranslate"><span class="pre">category_id</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the category for the given <code class="docutils literal notranslate"><span class="pre">category_id</span></code> does not exist in the
|
||
system.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have the privilege to read the category.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.tagging_client.Category.list">
|
||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Category.list" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Enumerates the categories in the system. To invoke this method, you
|
||
need the read privilege on the individual categories. The <a class="reference internal" href="#com.vmware.cis.tagging_client.Category.list" title="com.vmware.cis.tagging_client.Category.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a>
|
||
will only contain those categories for which you have read privileges.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.cis.tagging_client.Category.list" title="com.vmware.cis.tagging_client.Category.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>The <a class="reference internal" href="#com.vmware.cis.tagging_client.Category.list" title="com.vmware.cis.tagging_client.Category.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of resource identifiers for the categories in the
|
||
system.
|
||
The return value will contain identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Category</span></code>.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.tagging_client.Category.list_used_categories">
|
||
<span class="sig-name descname"><span class="pre">list_used_categories</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">used_by_entity</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Category.list_used_categories" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Enumerates all categories for which the <code class="docutils literal notranslate"><span class="pre">used_by_entity</span></code> is part of
|
||
the <code class="xref py py-attr docutils literal notranslate"><span class="pre">CategoryModel.used_by</span></code> subscribers <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>. To invoke
|
||
this method, you need the read privilege on the individual categories.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>used_by_entity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The field on which the results will be filtered.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.cis.tagging_client.Category.list" title="com.vmware.cis.tagging_client.Category.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>The <a class="reference internal" href="#com.vmware.cis.tagging_client.Category.list" title="com.vmware.cis.tagging_client.Category.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of resource identifiers for the categories in the
|
||
system that are used by <code class="docutils literal notranslate"><span class="pre">used_by_entity</span></code>.
|
||
The return value will contain identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Category</span></code>.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.tagging_client.Category.remove_from_used_by">
|
||
<span class="sig-name descname"><span class="pre">remove_from_used_by</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">category_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">used_by_entity</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Category.remove_from_used_by" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Removes the <code class="docutils literal notranslate"><span class="pre">used_by_entity</span></code> from the <code class="xref py py-attr docutils literal notranslate"><span class="pre">CategoryModel.used_by</span></code>
|
||
subscribers <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>. If the <code class="docutils literal notranslate"><span class="pre">used_by_entity</span></code> is not using this
|
||
category, then this becomes a no-op. To invoke this method, you need
|
||
the modify <code class="xref py py-attr docutils literal notranslate"><span class="pre">CategoryModel.used_by</span></code> privilege on the category.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>category_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifier of the input category.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Category</span></code>.</p></li>
|
||
<li><p><strong>used_by_entity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The name of the user to be removed from the
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">CategoryModel.used_by</span></code> <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the category for the given <code class="docutils literal notranslate"><span class="pre">category_id</span></code> does not exist in the
|
||
system.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have the privilege to remove an entity from the
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">CategoryModel.used_by</span></code> field.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.tagging_client.Category.revoke_propagating_permissions">
|
||
<span class="sig-name descname"><span class="pre">revoke_propagating_permissions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">category_id</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Category.revoke_propagating_permissions" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Revokes all propagating permissions on the given category. You should
|
||
then attach a direct permission with tagging privileges on the given
|
||
category. To invoke this method, you need category related privileges
|
||
(direct or propagating) on the concerned category.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>category_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifier of the input category.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Category</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the category for the given <code class="docutils literal notranslate"><span class="pre">category_id</span></code> does not exist in the
|
||
system.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have the privilege to revoke propagating permissions
|
||
on the category.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.tagging_client.Category.update">
|
||
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">category_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">update_spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Category.update" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Updates an existing category. To invoke this method, you need the edit
|
||
privilege on the category.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>category_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifier of the category to be updated.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Category</span></code>.</p></li>
|
||
<li><p><strong>update_spec</strong> (<a class="reference internal" href="#com.vmware.cis.tagging_client.Category.UpdateSpec" title="com.vmware.cis.tagging_client.Category.UpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Category.UpdateSpec</span></code></a>) – Specification to update the category.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
|
||
if the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Category.UpdateSpec.name</span></code> provided in the
|
||
<code class="docutils literal notranslate"><span class="pre">update_spec</span></code> is the name of an already existing category.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||
if any of the information in the <code class="docutils literal notranslate"><span class="pre">update_spec</span></code> is invalid.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the category for the given <code class="docutils literal notranslate"><span class="pre">category_id</span></code> does not exist in the
|
||
system.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have the privilege to update the category.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.tagging_client.CategoryModel">
|
||
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.cis.tagging_client.</span></span><span class="sig-name descname"><span class="pre">CategoryModel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cardinality</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">associable_types</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">used_by</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.CategoryModel" 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">CategoryModel</span></code> class defines a category that is used to group one or
|
||
more tags.</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>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The unique identifier of the category.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Category</span></code>. When methods return a value of
|
||
this class as a return value, the attribute will be an identifier
|
||
for the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Category</span></code>.</p></li>
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The display name of the category.</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The description of the category.</p></li>
|
||
<li><p><strong>cardinality</strong> (<a class="reference internal" href="#com.vmware.cis.tagging_client.CategoryModel.Cardinality" title="com.vmware.cis.tagging_client.CategoryModel.Cardinality"><code class="xref py py-class docutils literal notranslate"><span class="pre">CategoryModel.Cardinality</span></code></a>) – The associated cardinality (SINGLE, MULTIPLE) of the category.</p></li>
|
||
<li><p><strong>associable_types</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The types of objects that the tags in this category can be attached
|
||
to. If the <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> is empty, then tags can be attached to all
|
||
types of objects. This field works only for objects that reside in
|
||
Inventory Service (IS). For non IS objects, this check is not
|
||
performed today and hence a tag can be attached to any non IS
|
||
object.</p></li>
|
||
<li><p><strong>used_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of users that can use this category. To add users
|
||
to this, you need to have the edit privilege on the category.
|
||
Similarly, to unsubscribe from this category, you need the edit
|
||
privilege on the category. You should not modify other users
|
||
subscription from this <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.tagging_client.CategoryModel.Cardinality">
|
||
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">Cardinality</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.CategoryModel.Cardinality" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">CategoryModel.Cardinality</span></code> class defines the number of tags in a
|
||
category that can be assigned to an object.</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">Cardinality</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.tagging_client.CategoryModel.Cardinality.MULTIPLE">
|
||
<span class="sig-name descname"><span class="pre">MULTIPLE</span></span><em class="property"> <span class="pre">=</span> <span class="pre">Cardinality(string='MULTIPLE')</span></em><a class="headerlink" href="#com.vmware.cis.tagging_client.CategoryModel.Cardinality.MULTIPLE" title="Permalink to this definition"></a></dt>
|
||
<dd><p>An object can be assigned several of the tags in this category. For
|
||
example, if a category is “Server”, then different tags of this category
|
||
would be “AppServer”, “DatabaseServer” and so on. In this case a VM object
|
||
can be assigned more than one of the above tags and hence the cardinality
|
||
of the associated category here is multiple.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.tagging_client.CategoryModel.Cardinality.SINGLE">
|
||
<span class="sig-name descname"><span class="pre">SINGLE</span></span><em class="property"> <span class="pre">=</span> <span class="pre">Cardinality(string='SINGLE')</span></em><a class="headerlink" href="#com.vmware.cis.tagging_client.CategoryModel.Cardinality.SINGLE" title="Permalink to this definition"></a></dt>
|
||
<dd><p>An object can only be assigned one of the tags in this category. For
|
||
example, if a category is “Operating System”, then different tags of this
|
||
category would be “Windows”, “Linux”, and so on. In this case a VM object
|
||
can be assigned only one of these tags and hence the cardinality of the
|
||
associated category here is single.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.tagging_client.StubFactory">
|
||
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.cis.tagging_client.</span></span><span class="sig-name descname"><span class="pre">StubFactory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.StubFactory" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||
<p>Initialize StubFactoryBase</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.tagging_client.Tag">
|
||
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.cis.tagging_client.</span></span><span class="sig-name descname"><span class="pre">Tag</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Tag</span></code> class provides methods to create, read, update, delete, and
|
||
enumerate tags.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.tagging_client.Tag.CreateSpec">
|
||
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">CreateSpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">category_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tag_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag.CreateSpec" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Tag.CreateSpec</span></code> class describes a tag.</p>
|
||
<p>Use the <a class="reference internal" href="#com.vmware.cis.tagging_client.Tag.create" title="com.vmware.cis.tagging_client.Tag.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">Tag.create()</span></code></a> method to create a tag defined by the create
|
||
specification.</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>) – The display name of the tag. The name must be unique within its
|
||
category.</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The description of the tag.</p></li>
|
||
<li><p><strong>category_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The unique identifier of the parent category in which this tag will
|
||
be created.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Category</span></code>. When methods return a value of
|
||
this class as a return value, the attribute will be an identifier
|
||
for the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Category</span></code>.</p></li>
|
||
<li><p><strong>tag_id</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>) – This attribute was added in vSphere API 6.7.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag</span></code>. When methods return a value of this
|
||
class as a return value, the attribute will be an identifier for
|
||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag</span></code>.
|
||
If None an identifier will be generated by the server</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.tagging_client.Tag.UpdateSpec">
|
||
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">UpdateSpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag.UpdateSpec" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Tag.UpdateSpec</span></code> class describes the updates to be made to an
|
||
existing tag.</p>
|
||
<p>Use the <a class="reference internal" href="#com.vmware.cis.tagging_client.Tag.update" title="com.vmware.cis.tagging_client.Tag.update"><code class="xref py py-func docutils literal notranslate"><span class="pre">Tag.update()</span></code></a> method to modify a tag. When you call the
|
||
method, you specify the tag identifier. You obtain the tag identifier when
|
||
you call the <a class="reference internal" href="#com.vmware.cis.tagging_client.Tag.create" title="com.vmware.cis.tagging_client.Tag.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">Tag.create()</span></code></a> method. You can also retrieve an identifier
|
||
by using the <a class="reference internal" href="#com.vmware.cis.tagging_client.Tag.list" title="com.vmware.cis.tagging_client.Tag.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Tag.list()</span></code></a> method.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The display name of the tag.
|
||
If None the name will not be modified.</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The description of the tag.
|
||
If None the description will not be modified.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.tagging_client.Tag.add_to_used_by">
|
||
<span class="sig-name descname"><span class="pre">add_to_used_by</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tag_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">used_by_entity</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag.add_to_used_by" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Adds the <code class="docutils literal notranslate"><span class="pre">used_by_entity</span></code> to the <code class="xref py py-attr docutils literal notranslate"><span class="pre">TagModel.used_by</span></code> subscribers
|
||
<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>. If the <code class="docutils literal notranslate"><span class="pre">used_by_entity</span></code> is already in the <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>,
|
||
then this becomes a no-op. To invoke this method, you need the modify
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">TagModel.used_by</span></code> privilege on the tag.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>tag_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifier of the input tag.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag</span></code>.</p></li>
|
||
<li><p><strong>used_by_entity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The name of the user to be added to the <code class="xref py py-attr docutils literal notranslate"><span class="pre">TagModel.used_by</span></code>
|
||
<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the tag for the given <code class="docutils literal notranslate"><span class="pre">tag_id</span></code> does not exist in the system.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have the privilege to add an entity to the
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">TagModel.used_by</span></code> field.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.tagging_client.Tag.create">
|
||
<span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">create_spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag.create" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Creates a tag. To invoke this method, you need the create tag privilege
|
||
on the input category.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>create_spec</strong> (<a class="reference internal" href="#com.vmware.cis.tagging_client.Tag.CreateSpec" title="com.vmware.cis.tagging_client.Tag.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tag.CreateSpec</span></code></a>) – Specification for the new tag to be created.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>The identifier of the created tag.
|
||
The return value will be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
|
||
if the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Tag.CreateSpec.name</span></code> provided in the <code class="docutils literal notranslate"><span class="pre">create_spec</span></code>
|
||
is the name of an already existing tag in the input category.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||
if any of the input information in the <code class="docutils literal notranslate"><span class="pre">create_spec</span></code> is invalid.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the category for in the given <code class="docutils literal notranslate"><span class="pre">create_spec</span></code> does not exist in
|
||
the system.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have the privilege to create tag.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.tagging_client.Tag.delete">
|
||
<span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tag_id</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag.delete" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Deletes an existing tag. To invoke this method, you need the delete
|
||
privilege on the tag.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>tag_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifier of the input tag.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the tag for the given <code class="docutils literal notranslate"><span class="pre">tag_id</span></code> does not exist in the system.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have the privilege to delete the tag.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the user can not be authenticated.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.tagging_client.Tag.get">
|
||
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tag_id</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag.get" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Fetches the tag information for the given tag identifier. To invoke
|
||
this method, you need the read privilege on the tag in order to view
|
||
the tag info.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>tag_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifier of the input tag.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.cis.tagging_client.TagModel" title="com.vmware.cis.tagging_client.TagModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">TagModel</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>The <a class="reference internal" href="#com.vmware.cis.tagging_client.TagModel" title="com.vmware.cis.tagging_client.TagModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">TagModel</span></code></a> that corresponds to <code class="docutils literal notranslate"><span class="pre">tag_id</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the tag for the given <code class="docutils literal notranslate"><span class="pre">tag_id</span></code> does not exist in the system.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if the user does not have the privilege to read the tag.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.tagging_client.Tag.list">
|
||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag.list" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Enumerates the tags in the system. To invoke this method, you need read
|
||
privilege on the individual tags. The <a class="reference internal" href="#com.vmware.cis.tagging_client.Tag.list" title="com.vmware.cis.tagging_client.Tag.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> will only contain
|
||
tags for which you have read privileges.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.cis.tagging_client.Tag.list" title="com.vmware.cis.tagging_client.Tag.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>The <a class="reference internal" href="#com.vmware.cis.tagging_client.Tag.list" title="com.vmware.cis.tagging_client.Tag.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of resource identifiers for the tags in the
|
||
system.
|
||
The return value will contain identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag</span></code>.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.tagging_client.Tag.list_tags_for_category">
|
||
<span class="sig-name descname"><span class="pre">list_tags_for_category</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">category_id</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag.list_tags_for_category" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Enumerates all tags for the given category. To invoke this method, you
|
||
need the read privilege on the given category and the individual tags
|
||
in that category.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>category_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifier of the input category.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Category</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.cis.tagging_client.Tag.list" title="com.vmware.cis.tagging_client.Tag.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>The <a class="reference internal" href="#com.vmware.cis.tagging_client.Tag.list" title="com.vmware.cis.tagging_client.Tag.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of resource identifiers for the tags in the given
|
||
input category.
|
||
The return value will contain identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the category for the given <code class="docutils literal notranslate"><span class="pre">category_id</span></code> does not exist in the
|
||
system.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have the privilege to read the category.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.tagging_client.Tag.list_used_tags">
|
||
<span class="sig-name descname"><span class="pre">list_used_tags</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">used_by_entity</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag.list_used_tags" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Enumerates all tags for which the <code class="docutils literal notranslate"><span class="pre">used_by_entity</span></code> is part of the
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">TagModel.used_by</span></code> subscribers <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>. To invoke this
|
||
method, you need the read privilege on the individual tags.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>used_by_entity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The field on which the results will be filtered.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.cis.tagging_client.Tag.list" title="com.vmware.cis.tagging_client.Tag.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>The <a class="reference internal" href="#com.vmware.cis.tagging_client.Tag.list" title="com.vmware.cis.tagging_client.Tag.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of resource identifiers for the tags in the
|
||
system that are used by <code class="docutils literal notranslate"><span class="pre">used_by_entity</span></code>.
|
||
The return value will contain identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag</span></code>.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.tagging_client.Tag.remove_from_used_by">
|
||
<span class="sig-name descname"><span class="pre">remove_from_used_by</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tag_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">used_by_entity</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag.remove_from_used_by" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Removes the <code class="docutils literal notranslate"><span class="pre">used_by_entity</span></code> from the <code class="xref py py-attr docutils literal notranslate"><span class="pre">TagModel.used_by</span></code>
|
||
subscribers set. If the <code class="docutils literal notranslate"><span class="pre">used_by_entity</span></code> is not using this tag, then
|
||
this becomes a no-op. To invoke this method, you need modify
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">TagModel.used_by</span></code> privilege on the tag.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>tag_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifier of the input tag.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag</span></code>.</p></li>
|
||
<li><p><strong>used_by_entity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The name of the user to be removed from the
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">TagModel.used_by</span></code> <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the tag for the given <code class="docutils literal notranslate"><span class="pre">tag_id</span></code> does not exist in the system.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have the privilege to remove an entity from the
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">TagModel.used_by</span></code> field.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.tagging_client.Tag.revoke_propagating_permissions">
|
||
<span class="sig-name descname"><span class="pre">revoke_propagating_permissions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tag_id</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag.revoke_propagating_permissions" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Revokes all propagating permissions on the given tag. You should then
|
||
attach a direct permission with tagging privileges on the given tag. To
|
||
invoke this method, you need tag related privileges (direct or
|
||
propagating) on the concerned tag.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>tag_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifier of the input tag.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the tag for the given <code class="docutils literal notranslate"><span class="pre">tag_id</span></code> does not exist in the system.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have the privilege to revoke propagating permissions
|
||
on the tag.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.tagging_client.Tag.update">
|
||
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tag_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">update_spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag.update" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Updates an existing tag. To invoke this method, you need the edit
|
||
privilege on the tag.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>tag_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifier of the input tag.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag</span></code>.</p></li>
|
||
<li><p><strong>update_spec</strong> (<a class="reference internal" href="#com.vmware.cis.tagging_client.Tag.UpdateSpec" title="com.vmware.cis.tagging_client.Tag.UpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tag.UpdateSpec</span></code></a>) – Specification to update the tag.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
|
||
if the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Tag.UpdateSpec.name</span></code> provided in the <code class="docutils literal notranslate"><span class="pre">update_spec</span></code>
|
||
is the name of an already existing tag in the same category.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||
if any of the input information in the <code class="docutils literal notranslate"><span class="pre">update_spec</span></code> is invalid.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the tag for the given <code class="docutils literal notranslate"><span class="pre">tag_id</span></code> does not exist in the system.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have the privilege to update the tag.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.tagging_client.TagAssociation">
|
||
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.cis.tagging_client.</span></span><span class="sig-name descname"><span class="pre">TagAssociation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">TagAssociation</span></code> class provides methods to attach, detach, and query
|
||
tags.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.tagging_client.TagAssociation.BatchResult">
|
||
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">BatchResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">success</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error_messages</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.BatchResult" 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">TagAssociation.BatchResult</span></code> class describes the result of performing
|
||
the same method on several tags or objects in a single invocation. This
|
||
class was added in vSphere API 6.5.</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>success</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – This is true if the batch method completed without any errors.
|
||
Otherwise it is false and all or some methods have failed. This
|
||
attribute was added in vSphere API 6.5.</p></li>
|
||
<li><p><strong>error_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>) – The <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of error messages. This attribute was added in
|
||
vSphere API 6.5.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.tagging_client.TagAssociation.ObjectToTags">
|
||
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">ObjectToTags</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">object_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tag_ids</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.ObjectToTags" 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">TagAssociation.ObjectToTags</span></code> class describes an object and its
|
||
related tags. Use the <a class="reference internal" href="#com.vmware.cis.tagging_client.TagAssociation.list_attached_tags_on_objects" title="com.vmware.cis.tagging_client.TagAssociation.list_attached_tags_on_objects"><code class="xref py py-func docutils literal notranslate"><span class="pre">TagAssociation.list_attached_tags_on_objects()</span></code></a>
|
||
method to retrieve a <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> with each element containing an object
|
||
and the tags attached to it. This class was added in vSphere API 6.5.</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>object_id</strong> (<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>) – The identifier of the object. This attribute was added in vSphere
|
||
API 6.5.</p></li>
|
||
<li><p><strong>tag_ids</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifiers of the related tags. This attribute was added in
|
||
vSphere API 6.5.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must contain identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag</span></code>. When methods return a value of this
|
||
class as a return value, the attribute will contain identifiers for
|
||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.tagging_client.TagAssociation.TagToObjects">
|
||
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">TagToObjects</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tag_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">object_ids</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.TagToObjects" 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">TagAssociation.TagToObjects</span></code> class describes a tag and its related
|
||
objects. Use the <a class="reference internal" href="#com.vmware.cis.tagging_client.TagAssociation.list_attached_objects_on_tags" title="com.vmware.cis.tagging_client.TagAssociation.list_attached_objects_on_tags"><code class="xref py py-func docutils literal notranslate"><span class="pre">TagAssociation.list_attached_objects_on_tags()</span></code></a>
|
||
method to retrieve a <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> with each element containing a tag and
|
||
the objects to which it is attached. This class was added in vSphere API
|
||
6.5.</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>tag_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifier of the tag. This attribute was added in vSphere API
|
||
6.5.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag</span></code>. When methods return a value of this
|
||
class as a return value, the attribute will be an identifier for
|
||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag</span></code>.</p></li>
|
||
<li><p><strong>object_ids</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.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>) – The identifiers of the related objects. This attribute was added in
|
||
vSphere API 6.5.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.tagging_client.TagAssociation.attach">
|
||
<span class="sig-name descname"><span class="pre">attach</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tag_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">object_id</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.attach" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Attaches the given tag to the input object. The tag needs to meet the
|
||
cardinality (<code class="xref py py-attr docutils literal notranslate"><span class="pre">CategoryModel.cardinality</span></code>) and associability
|
||
(<code class="xref py py-attr docutils literal notranslate"><span class="pre">CategoryModel.associable_types</span></code>) criteria in order to be
|
||
eligible for attachment. If the tag is already attached to the object,
|
||
then this method is a no-op and an error will not be thrown. To invoke
|
||
this method, you need the attach tag privilege on the tag and the read
|
||
privilege on the object.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>tag_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifier of the input tag.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag</span></code>.</p></li>
|
||
<li><p><strong>object_id</strong> (<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>) – The identifier of the input object.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the tag for the given <code class="docutils literal notranslate"><span class="pre">tag_id</span></code> does not exist in the system.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||
if the input tag is not eligible to be attached to this object or
|
||
if the <code class="docutils literal notranslate"><span class="pre">object_id</span></code> is not valid.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have the privilege to attach the tag or do not have
|
||
the privilege to read the object.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the user can not be authenticated.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.tagging_client.TagAssociation.attach_multiple_tags_to_object">
|
||
<span class="sig-name descname"><span class="pre">attach_multiple_tags_to_object</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">object_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tag_ids</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.attach_multiple_tags_to_object" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Attaches the given tags to the input object. If a tag is already
|
||
attached to the object, then the individual method is a no-op and an
|
||
error will not be added to
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">TagAssociation.BatchResult.error_messages</span></code>. To invoke this
|
||
method, you need the read privilege on the object and the attach tag
|
||
privilege on each tag. This method was added in vSphere API 6.5.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>object_id</strong> (<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>) – The identifier of the input object.</p></li>
|
||
<li><p><strong>tag_ids</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifiers of the input tags.
|
||
The parameter must contain identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.cis.tagging_client.TagAssociation.BatchResult" title="com.vmware.cis.tagging_client.TagAssociation.BatchResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">TagAssociation.BatchResult</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>The outcome of the batch method and the <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of error
|
||
messages (<code class="xref py py-attr docutils literal notranslate"><span class="pre">TagAssociation.BatchResult.error_messages</span></code>)
|
||
describing attachment failures.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have the privilege to read the object.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the user can not be authenticated.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.tagging_client.TagAssociation.attach_tag_to_multiple_objects">
|
||
<span class="sig-name descname"><span class="pre">attach_tag_to_multiple_objects</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tag_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">object_ids</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.attach_tag_to_multiple_objects" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Attaches the given tag to the input objects. If a tag is already
|
||
attached to the object, then the individual method is a no-op and an
|
||
error will not be added to
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">TagAssociation.BatchResult.error_messages</span></code>. To invoke this
|
||
method, you need the attach tag privilege on the tag and the read
|
||
privilege on each object. This method was added in vSphere API 6.5.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>tag_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifier of the input tag.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag</span></code>.</p></li>
|
||
<li><p><strong>object_ids</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.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>) – The identifiers of the input objects.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.cis.tagging_client.TagAssociation.BatchResult" title="com.vmware.cis.tagging_client.TagAssociation.BatchResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">TagAssociation.BatchResult</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>The outcome of the batch method and the <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of error
|
||
messages (<code class="xref py py-attr docutils literal notranslate"><span class="pre">TagAssociation.BatchResult.error_messages</span></code>)
|
||
describing attachment failures.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the tag for the given <code class="docutils literal notranslate"><span class="pre">tag_id</span></code> does not exist in the system.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have the attach tag privilege on the tag.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the user can not be authenticated.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.tagging_client.TagAssociation.detach">
|
||
<span class="sig-name descname"><span class="pre">detach</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tag_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">object_id</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.detach" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Detaches the tag from the given object. If the tag is already removed
|
||
from the object, then this method is a no-op and an error will not be
|
||
thrown. To invoke this method, you need the attach tag privilege on the
|
||
tag and the read privilege on the object.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>tag_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifier of the input tag.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag</span></code>.</p></li>
|
||
<li><p><strong>object_id</strong> (<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>) – The identifier of the input object.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the tag for the given <code class="docutils literal notranslate"><span class="pre">tag_id</span></code> does not exist in the system.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have the privilege to detach the tag or do not have
|
||
the privilege to read the given object.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the user can not be authenticated.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.tagging_client.TagAssociation.detach_multiple_tags_from_object">
|
||
<span class="sig-name descname"><span class="pre">detach_multiple_tags_from_object</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">object_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tag_ids</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.detach_multiple_tags_from_object" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Detaches the given tags from the input object. If a tag is already
|
||
removed from the object, then the individual method is a no-op and an
|
||
error will not be added to
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">TagAssociation.BatchResult.error_messages</span></code>. To invoke this
|
||
method, you need the read privilege on the object and the attach tag
|
||
privilege each tag. This method was added in vSphere API 6.5.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>object_id</strong> (<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>) – The identifier of the input object.</p></li>
|
||
<li><p><strong>tag_ids</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifiers of the input tags.
|
||
The parameter must contain identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.cis.tagging_client.TagAssociation.BatchResult" title="com.vmware.cis.tagging_client.TagAssociation.BatchResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">TagAssociation.BatchResult</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>The outcome of the batch method and the <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of error
|
||
messages (<code class="xref py py-attr docutils literal notranslate"><span class="pre">TagAssociation.BatchResult.error_messages</span></code>)
|
||
describing detachment failures.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have the privilege to read the object.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the user can not be authenticated.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.tagging_client.TagAssociation.detach_tag_from_multiple_objects">
|
||
<span class="sig-name descname"><span class="pre">detach_tag_from_multiple_objects</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tag_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">object_ids</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.detach_tag_from_multiple_objects" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Detaches the given tag from the input objects. If a tag is already
|
||
removed from the object, then the individual method is a no-op and an
|
||
error will not be added to
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">TagAssociation.BatchResult.error_messages</span></code>. To invoke this
|
||
method, you need the attach tag privilege on the tag and the read
|
||
privilege on each object. This method was added in vSphere API 6.5.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>tag_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifier of the input tag.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag</span></code>.</p></li>
|
||
<li><p><strong>object_ids</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.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>) – The identifiers of the input objects.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.cis.tagging_client.TagAssociation.BatchResult" title="com.vmware.cis.tagging_client.TagAssociation.BatchResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">TagAssociation.BatchResult</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>The outcome of the batch method and the <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of error
|
||
messages (<code class="xref py py-attr docutils literal notranslate"><span class="pre">TagAssociation.BatchResult.error_messages</span></code>)
|
||
describing detachment failures.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the tag for the given tag does not exist in the system.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have the attach tag privilege on the tag.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the user can not be authenticated.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.tagging_client.TagAssociation.list_attachable_tags">
|
||
<span class="sig-name descname"><span class="pre">list_attachable_tags</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">object_id</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.list_attachable_tags" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Fetches the <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of attachable tags for the given object,
|
||
omitting the tags that have already been attached. Criteria for
|
||
attachability is calculated based on tagging cardinality
|
||
(<code class="xref py py-attr docutils literal notranslate"><span class="pre">CategoryModel.cardinality</span></code>) and associability
|
||
(<code class="xref py py-attr docutils literal notranslate"><span class="pre">CategoryModel.associable_types</span></code>) constructs. To invoke this
|
||
method, you need the read privilege on the input object. The
|
||
<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> will only contain those tags for which you have read
|
||
privileges.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>object_id</strong> (<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>) – The identifier of the input object.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>The <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of tag identifiers that are eligible to be
|
||
attached to the given object.
|
||
The return value will contain identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have the privilege to read the object.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the user can not be authenticated.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.tagging_client.TagAssociation.list_attached_objects">
|
||
<span class="sig-name descname"><span class="pre">list_attached_objects</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tag_id</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.list_attached_objects" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Fetches the <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of attached objects for the given tag. To
|
||
invoke this method, you need the read privilege on the input tag. Only
|
||
those objects for which you have the read privilege will be returned.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>tag_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifier of the input tag.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.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></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>The <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of attached object identifiers.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the tag for the given <code class="docutils literal notranslate"><span class="pre">tag_id</span></code> does not exist in the system.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have the privilege to read the tag.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the user can not be authenticated.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.tagging_client.TagAssociation.list_attached_objects_on_tags">
|
||
<span class="sig-name descname"><span class="pre">list_attached_objects_on_tags</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tag_ids</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.list_attached_objects_on_tags" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Fetches the <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.cis.tagging_client.TagAssociation.TagToObjects" title="com.vmware.cis.tagging_client.TagAssociation.TagToObjects"><code class="xref py py-class docutils literal notranslate"><span class="pre">TagAssociation.TagToObjects</span></code></a>
|
||
describing the input tag identifiers and the objects they are attached
|
||
to. To invoke this method, you need the read privilege on each input
|
||
tag. The <code class="xref py py-attr docutils literal notranslate"><span class="pre">TagAssociation.TagToObjects.object_ids</span></code> will only
|
||
contain those objects for which you have the read privilege. This
|
||
method was added in vSphere API 6.5.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>tag_ids</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifiers of the input tags.
|
||
The parameter must contain identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.cis.tagging_client.TagAssociation.TagToObjects" title="com.vmware.cis.tagging_client.TagAssociation.TagToObjects"><code class="xref py py-class docutils literal notranslate"><span class="pre">TagAssociation.TagToObjects</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>The <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of the tag identifiers to all object identifiers
|
||
that each tag is attached to.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the user can not be authenticated.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.tagging_client.TagAssociation.list_attached_tags">
|
||
<span class="sig-name descname"><span class="pre">list_attached_tags</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">object_id</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.list_attached_tags" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Fetches the <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of tags attached to the given object. To
|
||
invoke this method, you need the read privilege on the input object.
|
||
The <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> will only contain those tags for which you have the
|
||
read privileges.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>object_id</strong> (<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>) – The identifier of the input object.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>The <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of all tag identifiers that correspond to the
|
||
tags attached to the given object.
|
||
The return value will contain identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have the privilege to read the object.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the user can not be authenticated.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.tagging_client.TagAssociation.list_attached_tags_on_objects">
|
||
<span class="sig-name descname"><span class="pre">list_attached_tags_on_objects</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">object_ids</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.list_attached_tags_on_objects" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Fetches the <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.cis.tagging_client.TagAssociation.ObjectToTags" title="com.vmware.cis.tagging_client.TagAssociation.ObjectToTags"><code class="xref py py-class docutils literal notranslate"><span class="pre">TagAssociation.ObjectToTags</span></code></a>
|
||
describing the input object identifiers and the tags attached to each
|
||
object. To invoke this method, you need the read privilege on each
|
||
input object. The <code class="xref py py-attr docutils literal notranslate"><span class="pre">TagAssociation.ObjectToTags.tag_ids</span></code> will only
|
||
contain those tags for which you have the read privilege. This method
|
||
was added in vSphere API 6.5.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>object_ids</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.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>) – The identifiers of the input objects.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.cis.tagging_client.TagAssociation.ObjectToTags" title="com.vmware.cis.tagging_client.TagAssociation.ObjectToTags"><code class="xref py py-class docutils literal notranslate"><span class="pre">TagAssociation.ObjectToTags</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>The <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of the object identifiers to all tag identifiers
|
||
that are attached to that object.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the user can not be authenticated.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.tagging_client.TagModel">
|
||
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.cis.tagging_client.</span></span><span class="sig-name descname"><span class="pre">TagModel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">category_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">used_by</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.tagging_client.TagModel" 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">TagModel</span></code> class defines a tag that can be attached to vSphere
|
||
objects.</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>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The unique identifier of the tag.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag</span></code>. When methods return a value of this
|
||
class as a return value, the attribute will be an identifier for
|
||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag</span></code>.</p></li>
|
||
<li><p><strong>category_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifier of the parent category in which this tag will be
|
||
created.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Category</span></code>. When methods return a value of
|
||
this class as a return value, the attribute will be an identifier
|
||
for the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Category</span></code>.</p></li>
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The display name of the tag.</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The description of the tag.</p></li>
|
||
<li><p><strong>used_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of users that can use this tag. To add users to
|
||
this, you need to have the edit privilege on the tag. Similarly, to
|
||
unsubscribe from this tag, you need the edit privilege on the tag.
|
||
You should not modify other users subscription from this
|
||
<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="module-com.vmware.cis.task_client">
|
||
<span id="com-vmware-cis-task-client-module"></span><h2>com.vmware.cis.task_client module<a class="headerlink" href="#module-com.vmware.cis.task_client" title="Permalink to this headline"></a></h2>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.cis.task_client</span></code> module provides classes and classes used for
|
||
managing tasks.</p>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.task_client.CommonInfo">
|
||
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.cis.task_client.</span></span><span class="sig-name descname"><span class="pre">CommonInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">operation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">target</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cancelable</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start_time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">end_time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.task_client.CommonInfo" 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">CommonInfo</span></code> class contains information common to all tasks. This
|
||
class was added in vSphere API 6.7.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>description</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Description of the operation associated with the task. This
|
||
attribute was added in vSphere API 6.7.</p></li>
|
||
<li><p><strong>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the service containing the operation. This attribute
|
||
was added in vSphere API 6.7.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>. When methods return a value of this
|
||
class as a return value, the attribute will be an identifier for
|
||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>.</p></li>
|
||
<li><p><strong>operation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the operation associated with the task. This
|
||
attribute was added in vSphere API 6.7.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>. When methods return a value of this
|
||
class as a return value, the attribute will be an identifier for
|
||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>.</p></li>
|
||
<li><p><strong>parent</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>) – Parent of the current task. This attribute was added in vSphere API
|
||
6.7.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.task</span></code>. When methods return a value of this class
|
||
as a return value, the attribute will be an identifier for the
|
||
resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.cis.task</span></code>.
|
||
This attribute will be None if the task has no parent.</p></li>
|
||
<li><p><strong>target</strong> (<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> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifier of the target created by the operation or an existing
|
||
one the operation performed on. This attribute was added in vSphere
|
||
API 6.7.
|
||
This attribute will be None if the operation has no target or
|
||
multiple targets.</p></li>
|
||
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.cis.task_client.Status" title="com.vmware.cis.task_client.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">Status</span></code></a>) – Status of the operation associated with the task. This attribute
|
||
was added in vSphere API 6.7.</p></li>
|
||
<li><p><strong>cancelable</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag to indicate whether or not the operation can be cancelled. The
|
||
value may change as the operation progresses. This attribute was
|
||
added in vSphere API 6.7.</p></li>
|
||
<li><p><strong>error</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Description of the error if the operation status is “FAILED”. This
|
||
attribute was added in vSphere API 6.7.
|
||
If None the description of why the operation failed will be
|
||
included in the result of the operation (see <code class="xref py py-attr docutils literal notranslate"><span class="pre">Info.result</span></code>).</p></li>
|
||
<li><p><strong>start_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the operation is started. This attribute was added in
|
||
vSphere API 6.7.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">status</span></code> is one of <a class="reference internal" href="#com.vmware.cis.task_client.Status.RUNNING" title="com.vmware.cis.task_client.Status.RUNNING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Status.RUNNING</span></code></a>,
|
||
<a class="reference internal" href="#com.vmware.cis.task_client.Status.BLOCKED" title="com.vmware.cis.task_client.Status.BLOCKED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Status.BLOCKED</span></code></a>, <a class="reference internal" href="#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Status.SUCCEEDED</span></code></a>, or
|
||
<a class="reference internal" href="#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Status.FAILED</span></code></a>.</p></li>
|
||
<li><p><strong>end_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the operation is completed. This attribute was added in
|
||
vSphere API 6.7.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">status</span></code> is one of <a class="reference internal" href="#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Status.SUCCEEDED</span></code></a> or
|
||
<a class="reference internal" href="#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Status.FAILED</span></code></a>.</p></li>
|
||
<li><p><strong>user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Name of the user who performed the operation. This attribute was
|
||
added in vSphere API 6.7.
|
||
This attribute will be None if the operation is performed by the
|
||
system.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.task_client.Info">
|
||
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.cis.task_client.</span></span><span class="sig-name descname"><span class="pre">Info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">progress</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">result</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">operation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">target</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cancelable</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start_time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">end_time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.task_client.Info" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Info</span></code> class contains information about a task. This class was added
|
||
in vSphere API 6.7.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>progress</strong> (<a class="reference internal" href="#com.vmware.cis.task_client.Progress" title="com.vmware.cis.task_client.Progress"><code class="xref py py-class docutils literal notranslate"><span class="pre">Progress</span></code></a>) – Progress of the operation. This attribute was added in vSphere API
|
||
6.7.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">status</span></code> is one of <a class="reference internal" href="#com.vmware.cis.task_client.Status.RUNNING" title="com.vmware.cis.task_client.Status.RUNNING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Status.RUNNING</span></code></a>,
|
||
<a class="reference internal" href="#com.vmware.cis.task_client.Status.BLOCKED" title="com.vmware.cis.task_client.Status.BLOCKED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Status.BLOCKED</span></code></a>, <a class="reference internal" href="#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Status.SUCCEEDED</span></code></a>, or
|
||
<a class="reference internal" href="#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Status.FAILED</span></code></a>.</p></li>
|
||
<li><p><strong>result</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">DataValue</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Result of the operation.</p>
|
||
<p>If an operation reports partial results before it completes, this
|
||
attribute could be <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> before the
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">CommonInfo.status</span></code> has the value <a class="reference internal" href="#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Status.SUCCEEDED</span></code></a>.
|
||
The value could change as the operation progresses.. This attribute
|
||
was added in vSphere API 6.7.
|
||
This attribute will be None if the operation does not return a
|
||
result or if the result is not available at the current step of the
|
||
operation.</p>
|
||
</p></li>
|
||
<li><p><strong>description</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Description of the operation associated with the task. This
|
||
attribute was added in vSphere API 6.7.</p></li>
|
||
<li><p><strong>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the service containing the operation. This attribute
|
||
was added in vSphere API 6.7.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>. When methods return a value of this
|
||
class as a return value, the attribute will be an identifier for
|
||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>.</p></li>
|
||
<li><p><strong>operation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the operation associated with the task. This
|
||
attribute was added in vSphere API 6.7.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>. When methods return a value of this
|
||
class as a return value, the attribute will be an identifier for
|
||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>.</p></li>
|
||
<li><p><strong>parent</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>) – Parent of the current task. This attribute was added in vSphere API
|
||
6.7.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.task</span></code>. When methods return a value of this class
|
||
as a return value, the attribute will be an identifier for the
|
||
resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.cis.task</span></code>.
|
||
This attribute will be None if the task has no parent.</p></li>
|
||
<li><p><strong>target</strong> (<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> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifier of the target created by the operation or an existing
|
||
one the operation performed on. This attribute was added in vSphere
|
||
API 6.7.
|
||
This attribute will be None if the operation has no target or
|
||
multiple targets.</p></li>
|
||
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.cis.task_client.Status" title="com.vmware.cis.task_client.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">Status</span></code></a>) – Status of the operation associated with the task. This attribute
|
||
was added in vSphere API 6.7.</p></li>
|
||
<li><p><strong>cancelable</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag to indicate whether or not the operation can be cancelled. The
|
||
value may change as the operation progresses. This attribute was
|
||
added in vSphere API 6.7.</p></li>
|
||
<li><p><strong>error</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Description of the error if the operation status is “FAILED”. This
|
||
attribute was added in vSphere API 6.7.
|
||
If None the description of why the operation failed will be
|
||
included in the result of the operation (see <code class="xref py py-attr docutils literal notranslate"><span class="pre">Info.result</span></code>).</p></li>
|
||
<li><p><strong>start_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the operation is started. This attribute was added in
|
||
vSphere API 6.7.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">status</span></code> is one of <a class="reference internal" href="#com.vmware.cis.task_client.Status.RUNNING" title="com.vmware.cis.task_client.Status.RUNNING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Status.RUNNING</span></code></a>,
|
||
<a class="reference internal" href="#com.vmware.cis.task_client.Status.BLOCKED" title="com.vmware.cis.task_client.Status.BLOCKED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Status.BLOCKED</span></code></a>, <a class="reference internal" href="#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Status.SUCCEEDED</span></code></a>, or
|
||
<a class="reference internal" href="#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Status.FAILED</span></code></a>.</p></li>
|
||
<li><p><strong>end_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the operation is completed. This attribute was added in
|
||
vSphere API 6.7.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">status</span></code> is one of <a class="reference internal" href="#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Status.SUCCEEDED</span></code></a> or
|
||
<a class="reference internal" href="#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Status.FAILED</span></code></a>.</p></li>
|
||
<li><p><strong>user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Name of the user who performed the operation. This attribute was
|
||
added in vSphere API 6.7.
|
||
This attribute will be None if the operation is performed by the
|
||
system.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.task_client.Progress">
|
||
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.cis.task_client.</span></span><span class="sig-name descname"><span class="pre">Progress</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">total</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">completed</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.task_client.Progress" 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">Progress</span></code> class contains information describe the progress of an
|
||
operation. This class was added in vSphere API 6.7.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>total</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Total amount of the work for the operation. This attribute was
|
||
added in vSphere API 6.7.</p></li>
|
||
<li><p><strong>completed</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The amount of work completed for the operation. The value can only
|
||
be incremented. This attribute was added in vSphere API 6.7.</p></li>
|
||
<li><p><strong>message</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Message about the work progress. This attribute was added in
|
||
vSphere API 6.7.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.task_client.Status">
|
||
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.cis.task_client.</span></span><span class="sig-name descname"><span class="pre">Status</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.task_client.Status" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Status</span></code> class defines the status values that can be reported for an
|
||
operation. This enumeration was added in vSphere API 6.7.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <a class="reference internal" href="#com.vmware.cis.task_client.Status" title="com.vmware.cis.task_client.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">Status</span></code></a> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.task_client.Status.BLOCKED">
|
||
<span class="sig-name descname"><span class="pre">BLOCKED</span></span><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='BLOCKED')</span></em><a class="headerlink" href="#com.vmware.cis.task_client.Status.BLOCKED" title="Permalink to this definition"></a></dt>
|
||
<dd><p>The operation is blocked. This class attribute was added in vSphere API
|
||
6.7.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.task_client.Status.FAILED">
|
||
<span class="sig-name descname"><span class="pre">FAILED</span></span><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='FAILED')</span></em><a class="headerlink" href="#com.vmware.cis.task_client.Status.FAILED" title="Permalink to this definition"></a></dt>
|
||
<dd><p>The operation failed. This class attribute was added in vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.task_client.Status.PENDING">
|
||
<span class="sig-name descname"><span class="pre">PENDING</span></span><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='PENDING')</span></em><a class="headerlink" href="#com.vmware.cis.task_client.Status.PENDING" title="Permalink to this definition"></a></dt>
|
||
<dd><p>The operation is in pending state. This class attribute was added in
|
||
vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.task_client.Status.RUNNING">
|
||
<span class="sig-name descname"><span class="pre">RUNNING</span></span><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='RUNNING')</span></em><a class="headerlink" href="#com.vmware.cis.task_client.Status.RUNNING" title="Permalink to this definition"></a></dt>
|
||
<dd><p>The operation is in progress. This class attribute was added in vSphere API
|
||
6.7.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.task_client.Status.SUCCEEDED">
|
||
<span class="sig-name descname"><span class="pre">SUCCEEDED</span></span><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='SUCCEEDED')</span></em><a class="headerlink" href="#com.vmware.cis.task_client.Status.SUCCEEDED" title="Permalink to this definition"></a></dt>
|
||
<dd><p>The operation completed successfully. This class attribute was added in
|
||
vSphere API 6.7.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="com.vmware.cis.task_client.StubFactory">
|
||
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.cis.task_client.</span></span><span class="sig-name descname"><span class="pre">StubFactory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.cis.task_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>
|
||
|
||
</section>
|
||
</section>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||
<a href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html" class="btn btn-neutral float-left" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||
<a href="com.vmware.content.html" class="btn btn-neutral float-right" title="com.vmware.content package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||
</div>
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>© Copyright 2023, VMware, Inc..</p>
|
||
</div>
|
||
|
||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
||
|
||
</footer>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<script>
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
</body>
|
||
</html> |