<spanid="com-vmware-cis-package"></span><h1>com.vmware.cis package<aclass="headerlink"href="#module-com.vmware.cis"title="Permalink to this headline">¶</a></h1>
<divclass="section"id="submodules">
<h2>Submodules<aclass="headerlink"href="#submodules"title="Permalink to this headline">¶</a></h2>
<spanid="com-vmware-cis-tagging-client-module"></span><h2>com.vmware.cis.tagging_client module<aclass="headerlink"href="#module-com.vmware.cis.tagging_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="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
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.cis.tagging_client.</code><codeclass="sig-name descname">Category</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.tagging_client.Category"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property">class </em><codeclass="sig-name descname">CreateSpec</code><spanclass="sig-paren">(</span><emclass="sig-param">name=None</em>, <emclass="sig-param">description=None</em>, <emclass="sig-param">cardinality=None</em>, <emclass="sig-param">associable_types=None</em>, <emclass="sig-param">category_id=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.tagging_client.Category.CreateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Category.CreateSpec</span></code> class is used to create a category.</p>
<p>Use the <aclass="reference internal"href="#com.vmware.cis.tagging_client.Category.create"title="com.vmware.cis.tagging_client.Category.create"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Category.create()</span></code></a> method to create a category defined by the
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The display name of the category.</p></li>
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The description of the category.</p></li>
<li><p><strong>cardinality</strong> (<aclass="reference internal"href="#com.vmware.cis.tagging_client.CategoryModel.Cardinality"title="com.vmware.cis.tagging_client.CategoryModel.Cardinality"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">CategoryModel.Cardinality</span></code></a>) – The associated cardinality (SINGLE, MULTIPLE) of the category.</p></li>
<li><p><strong>associable_types</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Object types to which this category’s tags can be attached.</p></li>
<li><p><strong>category_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This attribute was added in vSphere API 6.7.
<emclass="property">class </em><codeclass="sig-name descname">UpdateSpec</code><spanclass="sig-paren">(</span><emclass="sig-param">name=None</em>, <emclass="sig-param">description=None</em>, <emclass="sig-param">cardinality=None</em>, <emclass="sig-param">associable_types=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.tagging_client.Category.UpdateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Category.UpdateSpec</span></code> class describes the updates to be made to an
existing category.</p>
<p>Use the <aclass="reference internal"href="#com.vmware.cis.tagging_client.Category.update"title="com.vmware.cis.tagging_client.Category.update"><codeclass="xref py py-func docutils literal notranslate"><spanclass="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 <aclass="reference internal"href="#com.vmware.cis.tagging_client.Category.create"title="com.vmware.cis.tagging_client.Category.create"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Category.create()</span></code></a> method. You can also
retrieve an identifier by using the <aclass="reference internal"href="#com.vmware.cis.tagging_client.Category.list"title="com.vmware.cis.tagging_client.Category.list"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Category.list()</span></code></a> method.</p>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The description of the category.
If None the description will not be modified.</p></li>
<li><p><strong>cardinality</strong> (<aclass="reference internal"href="#com.vmware.cis.tagging_client.CategoryModel.Cardinality"title="com.vmware.cis.tagging_client.CategoryModel.Cardinality"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">CategoryModel.Cardinality</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Object types to which this category’s tags can be attached.</p>
<codeclass="sig-name descname">add_to_used_by</code><spanclass="sig-paren">(</span><emclass="sig-param">category_id</em>, <emclass="sig-param">used_by_entity</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.tagging_client.Category.add_to_used_by"title="Permalink to this definition">¶</a></dt>
<dd><p>Adds the <codeclass="docutils literal notranslate"><spanclass="pre">used_by_entity</span></code> to the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">CategoryModel.used_by</span></code>
subscribers <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> for the specified category. If the
<codeclass="docutils literal notranslate"><spanclass="pre">used_by_entity</span></code> is already in the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code>, then this becomes an
idempotent no-op. To invoke this method, you need the modify
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">CategoryModel.used_by</span></code> privilege on the category.</p>
<li><p><strong>category_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the input category.
<li><p><strong>used_by_entity</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the user to be added to the
<codeclass="sig-name descname">create</code><spanclass="sig-paren">(</span><emclass="sig-param">create_spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.tagging_client.Category.create"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>create_spec</strong> (<aclass="reference internal"href="#com.vmware.cis.tagging_client.Category.CreateSpec"title="com.vmware.cis.tagging_client.Category.CreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Category.CreateSpec</span></code></a>) – Specification for the new category to be created.</p>
<codeclass="sig-name descname">delete</code><spanclass="sig-paren">(</span><emclass="sig-param">category_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.tagging_client.Category.delete"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>category_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of category to be deleted.
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">category_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.tagging_client.Category.get"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>category_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the input category.
<codeclass="sig-name descname">list</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="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 <aclass="reference internal"href="#com.vmware.cis.tagging_client.Category.list"title="com.vmware.cis.tagging_client.Category.list"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code></a>
will only contain those categories for which you have read privileges.</p>
<ddclass="field-even"><p>The <aclass="reference internal"href="#com.vmware.cis.tagging_client.Category.list"title="com.vmware.cis.tagging_client.Category.list"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code></a> of resource identifiers for the categories in the
<codeclass="sig-name descname">list_used_categories</code><spanclass="sig-paren">(</span><emclass="sig-param">used_by_entity</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.tagging_client.Category.list_used_categories"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>used_by_entity</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The field on which the results will be filtered.</p>
<ddclass="field-odd"><p>The <aclass="reference internal"href="#com.vmware.cis.tagging_client.Category.list"title="com.vmware.cis.tagging_client.Category.list"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code></a> of resource identifiers for the categories in the
<codeclass="sig-name descname">remove_from_used_by</code><spanclass="sig-paren">(</span><emclass="sig-param">category_id</em>, <emclass="sig-param">used_by_entity</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.tagging_client.Category.remove_from_used_by"title="Permalink to this definition">¶</a></dt>
<dd><p>Removes the <codeclass="docutils literal notranslate"><spanclass="pre">used_by_entity</span></code> from the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">CategoryModel.used_by</span></code>
subscribers <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code>. If the <codeclass="docutils literal notranslate"><spanclass="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 <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">CategoryModel.used_by</span></code> privilege on the category.</p>
<li><p><strong>category_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the input category.
<li><p><strong>used_by_entity</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the user to be removed from the
<codeclass="sig-name descname">revoke_propagating_permissions</code><spanclass="sig-paren">(</span><emclass="sig-param">category_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.tagging_client.Category.revoke_propagating_permissions"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>category_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the input category.
<codeclass="sig-name descname">update</code><spanclass="sig-paren">(</span><emclass="sig-param">category_id</em>, <emclass="sig-param">update_spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.tagging_client.Category.update"title="Permalink to this definition">¶</a></dt>
<li><p><strong>category_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the category to be updated.
<li><p><strong>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The unique identifier of the category.
for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.cis.tagging.Category</span></code>.</p></li>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The display name of the category.</p></li>
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The description of the category.</p></li>
<li><p><strong>cardinality</strong> (<aclass="reference internal"href="#com.vmware.cis.tagging_client.CategoryModel.Cardinality"title="com.vmware.cis.tagging_client.CategoryModel.Cardinality"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">CategoryModel.Cardinality</span></code></a>) – The associated cardinality (SINGLE, MULTIPLE) of the category.</p></li>
<li><p><strong>associable_types</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The types of objects that the tags in this category can be attached
<li><p><strong>used_by</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of users that can use this category. To add users
<emclass="property">class </em><codeclass="sig-name descname">Cardinality</code><spanclass="sig-paren">(</span><emclass="sig-param">string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.tagging_client.CategoryModel.Cardinality"title="Permalink to this definition">¶</a></dt>
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 <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="sig-name descname">MULTIPLE</code><emclass="property"> = Cardinality(string='MULTIPLE')</em><aclass="headerlink"href="#com.vmware.cis.tagging_client.CategoryModel.Cardinality.MULTIPLE"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">SINGLE</code><emclass="property"> = Cardinality(string='SINGLE')</em><aclass="headerlink"href="#com.vmware.cis.tagging_client.CategoryModel.Cardinality.SINGLE"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.cis.tagging_client.</code><codeclass="sig-name descname">StubFactory</code><spanclass="sig-paren">(</span><emclass="sig-param">stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.tagging_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.cis.tagging_client.</code><codeclass="sig-name descname">Tag</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.tagging_client.Tag"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property">class </em><codeclass="sig-name descname">CreateSpec</code><spanclass="sig-paren">(</span><emclass="sig-param">name=None</em>, <emclass="sig-param">description=None</em>, <emclass="sig-param">category_id=None</em>, <emclass="sig-param">tag_id=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.tagging_client.Tag.CreateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Tag.CreateSpec</span></code> class describes a tag.</p>
<p>Use the <aclass="reference internal"href="#com.vmware.cis.tagging_client.Tag.create"title="com.vmware.cis.tagging_client.Tag.create"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Tag.create()</span></code></a> method to create a tag defined by the create
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The description of the tag.</p></li>
<li><p><strong>category_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The unique identifier of the parent category in which this tag will
for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.cis.tagging.Category</span></code>.</p></li>
<li><p><strong>tag_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This attribute was added in vSphere API 6.7.
<emclass="property">class </em><codeclass="sig-name descname">UpdateSpec</code><spanclass="sig-paren">(</span><emclass="sig-param">name=None</em>, <emclass="sig-param">description=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.tagging_client.Tag.UpdateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Tag.UpdateSpec</span></code> class describes the updates to be made to an
existing tag.</p>
<p>Use the <aclass="reference internal"href="#com.vmware.cis.tagging_client.Tag.update"title="com.vmware.cis.tagging_client.Tag.update"><codeclass="xref py py-func docutils literal notranslate"><spanclass="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 <aclass="reference internal"href="#com.vmware.cis.tagging_client.Tag.create"title="com.vmware.cis.tagging_client.Tag.create"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Tag.create()</span></code></a> method. You can also retrieve an identifier
by using the <aclass="reference internal"href="#com.vmware.cis.tagging_client.Tag.list"title="com.vmware.cis.tagging_client.Tag.list"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Tag.list()</span></code></a> method.</p>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The description of the tag.
If None the description will not be modified.</p></li>
<codeclass="sig-name descname">add_to_used_by</code><spanclass="sig-paren">(</span><emclass="sig-param">tag_id</em>, <emclass="sig-param">used_by_entity</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.tagging_client.Tag.add_to_used_by"title="Permalink to this definition">¶</a></dt>
<dd><p>Adds the <codeclass="docutils literal notranslate"><spanclass="pre">used_by_entity</span></code> to the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">TagModel.used_by</span></code> subscribers
<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code>. If the <codeclass="docutils literal notranslate"><spanclass="pre">used_by_entity</span></code> is already in the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code>,
then this becomes a no-op. To invoke this method, you need the modify
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">TagModel.used_by</span></code> privilege on the tag.</p>
<li><p><strong>tag_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the input tag.
<li><p><strong>used_by_entity</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the user to be added to the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">TagModel.used_by</span></code>
<codeclass="sig-name descname">create</code><spanclass="sig-paren">(</span><emclass="sig-param">create_spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.tagging_client.Tag.create"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>create_spec</strong> (<aclass="reference internal"href="#com.vmware.cis.tagging_client.Tag.CreateSpec"title="com.vmware.cis.tagging_client.Tag.CreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Tag.CreateSpec</span></code></a>) – Specification for the new tag to be created.</p>
if the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Tag.CreateSpec.name</span></code> provided in the <codeclass="docutils literal notranslate"><spanclass="pre">create_spec</span></code>
<codeclass="sig-name descname">delete</code><spanclass="sig-paren">(</span><emclass="sig-param">tag_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.tagging_client.Tag.delete"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>tag_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the input tag.
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">tag_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.tagging_client.Tag.get"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>tag_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the input tag.
<codeclass="sig-name descname">list</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="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 <aclass="reference internal"href="#com.vmware.cis.tagging_client.Tag.list"title="com.vmware.cis.tagging_client.Tag.list"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code></a> will only contain
<ddclass="field-even"><p>The <aclass="reference internal"href="#com.vmware.cis.tagging_client.Tag.list"title="com.vmware.cis.tagging_client.Tag.list"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code></a> of resource identifiers for the tags in the
<codeclass="sig-name descname">list_tags_for_category</code><spanclass="sig-paren">(</span><emclass="sig-param">category_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.tagging_client.Tag.list_tags_for_category"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>category_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the input category.
<ddclass="field-odd"><p>The <aclass="reference internal"href="#com.vmware.cis.tagging_client.Tag.list"title="com.vmware.cis.tagging_client.Tag.list"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code></a> of resource identifiers for the tags in the given
<codeclass="sig-name descname">list_used_tags</code><spanclass="sig-paren">(</span><emclass="sig-param">used_by_entity</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.tagging_client.Tag.list_used_tags"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>used_by_entity</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The field on which the results will be filtered.</p>
<ddclass="field-odd"><p>The <aclass="reference internal"href="#com.vmware.cis.tagging_client.Tag.list"title="com.vmware.cis.tagging_client.Tag.list"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code></a> of resource identifiers for the tags in the
<codeclass="sig-name descname">remove_from_used_by</code><spanclass="sig-paren">(</span><emclass="sig-param">tag_id</em>, <emclass="sig-param">used_by_entity</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.tagging_client.Tag.remove_from_used_by"title="Permalink to this definition">¶</a></dt>
<dd><p>Removes the <codeclass="docutils literal notranslate"><spanclass="pre">used_by_entity</span></code> from the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">TagModel.used_by</span></code>
subscribers set. If the <codeclass="docutils literal notranslate"><spanclass="pre">used_by_entity</span></code> is not using this tag, then
this becomes a no-op. To invoke this method, you need modify
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">TagModel.used_by</span></code> privilege on the tag.</p>
<li><p><strong>tag_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the input tag.
<li><p><strong>used_by_entity</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the user to be removed from the
<codeclass="sig-name descname">revoke_propagating_permissions</code><spanclass="sig-paren">(</span><emclass="sig-param">tag_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.tagging_client.Tag.revoke_propagating_permissions"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>tag_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the input tag.
<codeclass="sig-name descname">update</code><spanclass="sig-paren">(</span><emclass="sig-param">tag_id</em>, <emclass="sig-param">update_spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.tagging_client.Tag.update"title="Permalink to this definition">¶</a></dt>
<li><p><strong>tag_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the input tag.
if the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Tag.UpdateSpec.name</span></code> provided in the <codeclass="docutils literal notranslate"><spanclass="pre">update_spec</span></code>
is the name of an already existing tag in the same category.</p>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.cis.tagging_client.</code><codeclass="sig-name descname">TagAssociation</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.tagging_client.TagAssociation"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property">class </em><codeclass="sig-name descname">BatchResult</code><spanclass="sig-paren">(</span><emclass="sig-param">success=None</em>, <emclass="sig-param">error_messages=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.tagging_client.TagAssociation.BatchResult"title="Permalink to this definition">¶</a></dt>
<li><p><strong>success</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – This is true if the batch method completed without any errors.
<emclass="property">class </em><codeclass="sig-name descname">ObjectToTags</code><spanclass="sig-paren">(</span><emclass="sig-param">object_id=None</em>, <emclass="sig-param">tag_ids=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.tagging_client.TagAssociation.ObjectToTags"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">TagAssociation.ObjectToTags</span></code> class describes an object and its
related tags. Use the <aclass="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"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">TagAssociation.list_attached_tags_on_objects()</span></code></a>
method to retrieve a <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> with each element containing an object
<li><p><strong>object_id</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID"title="com.vmware.vapi.std_client.DynamicID"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifiers of the related tags. This attribute was added in
<emclass="property">class </em><codeclass="sig-name descname">TagToObjects</code><spanclass="sig-paren">(</span><emclass="sig-param">tag_id=None</em>, <emclass="sig-param">object_ids=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.tagging_client.TagAssociation.TagToObjects"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">TagAssociation.TagToObjects</span></code> class describes a tag and its related
objects. Use the <aclass="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"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">TagAssociation.list_attached_objects_on_tags()</span></code></a>
method to retrieve a <codeclass="xref py py-class docutils literal notranslate"><spanclass="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
<li><p><strong>tag_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the tag. This attribute was added in vSphere API
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.cis.tagging.Tag</span></code>.</p></li>
<li><p><strong>object_ids</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID"title="com.vmware.vapi.std_client.DynamicID"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.DynamicID</span></code></a>) – The identifiers of the related objects. This attribute was added in
<codeclass="sig-name descname">attach</code><spanclass="sig-paren">(</span><emclass="sig-param">tag_id</em>, <emclass="sig-param">object_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.tagging_client.TagAssociation.attach"title="Permalink to this definition">¶</a></dt>
<li><p><strong>tag_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the input tag.
<li><p><strong>object_id</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID"title="com.vmware.vapi.std_client.DynamicID"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.DynamicID</span></code></a>) – The identifier of the input object.</p></li>
<codeclass="sig-name descname">attach_multiple_tags_to_object</code><spanclass="sig-paren">(</span><emclass="sig-param">object_id</em>, <emclass="sig-param">tag_ids</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.tagging_client.TagAssociation.attach_multiple_tags_to_object"title="Permalink to this definition">¶</a></dt>
privilege on each tag. This method was added in vSphere API 6.5.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>object_id</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID"title="com.vmware.vapi.std_client.DynamicID"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.DynamicID</span></code></a>) – The identifier of the input object.</p></li>
<li><p><strong>tag_ids</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifiers of the input tags.
<ddclass="field-odd"><p>The outcome of the batch method and the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of error
<codeclass="sig-name descname">attach_tag_to_multiple_objects</code><spanclass="sig-paren">(</span><emclass="sig-param">tag_id</em>, <emclass="sig-param">object_ids</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.tagging_client.TagAssociation.attach_tag_to_multiple_objects"title="Permalink to this definition">¶</a></dt>
privilege on each object. This method was added in vSphere API 6.5.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>tag_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the input tag.
<ddclass="field-odd"><p>The outcome of the batch method and the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of error
<codeclass="sig-name descname">detach</code><spanclass="sig-paren">(</span><emclass="sig-param">tag_id</em>, <emclass="sig-param">object_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.tagging_client.TagAssociation.detach"title="Permalink to this definition">¶</a></dt>
<li><p><strong>tag_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the input tag.
<li><p><strong>object_id</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID"title="com.vmware.vapi.std_client.DynamicID"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.DynamicID</span></code></a>) – The identifier of the input object.</p></li>
<codeclass="sig-name descname">detach_multiple_tags_from_object</code><spanclass="sig-paren">(</span><emclass="sig-param">object_id</em>, <emclass="sig-param">tag_ids</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.tagging_client.TagAssociation.detach_multiple_tags_from_object"title="Permalink to this definition">¶</a></dt>
privilege each tag. This method was added in vSphere API 6.5.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>object_id</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID"title="com.vmware.vapi.std_client.DynamicID"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.DynamicID</span></code></a>) – The identifier of the input object.</p></li>
<li><p><strong>tag_ids</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifiers of the input tags.
<ddclass="field-odd"><p>The outcome of the batch method and the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of error
<codeclass="sig-name descname">detach_tag_from_multiple_objects</code><spanclass="sig-paren">(</span><emclass="sig-param">tag_id</em>, <emclass="sig-param">object_ids</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.tagging_client.TagAssociation.detach_tag_from_multiple_objects"title="Permalink to this definition">¶</a></dt>
privilege on each object. This method was added in vSphere API 6.5.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>tag_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the input tag.
<ddclass="field-odd"><p>The outcome of the batch method and the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of error
<codeclass="sig-name descname">list_attachable_tags</code><spanclass="sig-paren">(</span><emclass="sig-param">object_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.tagging_client.TagAssociation.list_attachable_tags"title="Permalink to this definition">¶</a></dt>
<dd><p>Fetches the <codeclass="xref py py-class docutils literal notranslate"><spanclass="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
(<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">CategoryModel.cardinality</span></code>) and associability
(<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">CategoryModel.associable_types</span></code>) constructs. To invoke this
method, you need the read privilege on the input object. The
<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> will only contain those tags for which you have read
<ddclass="field-odd"><p><strong>object_id</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID"title="com.vmware.vapi.std_client.DynamicID"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.DynamicID</span></code></a>) – The identifier of the input object.</p>
<ddclass="field-odd"><p>The <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of tag identifiers that are eligible to be
<codeclass="sig-name descname">list_attached_objects</code><spanclass="sig-paren">(</span><emclass="sig-param">tag_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.tagging_client.TagAssociation.list_attached_objects"title="Permalink to this definition">¶</a></dt>
<dd><p>Fetches the <codeclass="xref py py-class docutils literal notranslate"><spanclass="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>
<ddclass="field-odd"><p><strong>tag_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the input tag.
<codeclass="sig-name descname">list_attached_objects_on_tags</code><spanclass="sig-paren">(</span><emclass="sig-param">tag_ids</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.tagging_client.TagAssociation.list_attached_objects_on_tags"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p>The <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of the tag identifiers to all object identifiers
<codeclass="sig-name descname">list_attached_tags</code><spanclass="sig-paren">(</span><emclass="sig-param">object_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.tagging_client.TagAssociation.list_attached_tags"title="Permalink to this definition">¶</a></dt>
<dd><p>Fetches the <codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> will only contain those tags for which you have the
<ddclass="field-odd"><p><strong>object_id</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID"title="com.vmware.vapi.std_client.DynamicID"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.DynamicID</span></code></a>) – The identifier of the input object.</p>
<ddclass="field-odd"><p>The <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of all tag identifiers that correspond to the
<codeclass="sig-name descname">list_attached_tags_on_objects</code><spanclass="sig-paren">(</span><emclass="sig-param">object_ids</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.tagging_client.TagAssociation.list_attached_tags_on_objects"title="Permalink to this definition">¶</a></dt>
<dd><p>Fetches the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.cis.tagging_client.TagAssociation.ObjectToTags"title="com.vmware.cis.tagging_client.TagAssociation.ObjectToTags"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">TagAssociation.ObjectToTags.tag_ids</span></code> will only
contain those tags for which you have the read privilege. This method
<ddclass="field-odd"><p>The <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of the object identifiers to all tag identifiers
<li><p><strong>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The unique identifier of the tag.
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.cis.tagging.Tag</span></code>.</p></li>
<li><p><strong>category_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the parent category in which this tag will be
for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.cis.tagging.Category</span></code>.</p></li>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The display name of the tag.</p></li>
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The description of the tag.</p></li>
<li><p><strong>used_by</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of users that can use this tag. To add users to
<spanid="com-vmware-cis-task-client-module"></span><h2>com.vmware.cis.task_client module<aclass="headerlink"href="#module-com.vmware.cis.task_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.cis.task_client</span></code> module provides classes and classes used for
<li><p><strong>description</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the service containing the operation. This attribute
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.service</span></code>.</p></li>
<li><p><strong>operation</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the operation associated with the task. This
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.operation</span></code>.</p></li>
<li><p><strong>parent</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Parent of the current task. This attribute was added in vSphere API
This attribute will be None if the task has no parent.</p></li>
<li><p><strong>target</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID"title="com.vmware.vapi.std_client.DynamicID"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifier of the target created by the operation or an existing
<li><p><strong>status</strong> (<aclass="reference internal"href="#com.vmware.cis.task_client.Status"title="com.vmware.cis.task_client.Status"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag to indicate whether or not the operation can be cancelled. The
<li><p><strong>error</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Exception</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Description of the error if the operation status is “FAILED”. This
included in the result of the operation (see <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Info.result</span></code>).</p></li>
<li><p><strong>start_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Time when the operation is started. This attribute was added in
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">status</span></code> is one of <aclass="reference internal"href="#com.vmware.cis.task_client.Status.RUNNING"title="com.vmware.cis.task_client.Status.RUNNING"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Status.RUNNING</span></code></a>,
<li><p><strong>end_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Time when the operation is completed. This attribute was added in
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">status</span></code> is one of <aclass="reference internal"href="#com.vmware.cis.task_client.Status.SUCCEEDED"title="com.vmware.cis.task_client.Status.SUCCEEDED"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Status.SUCCEEDED</span></code></a> or
<li><p><strong>user</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name of the user who performed the operation. This attribute was
<li><p><strong>progress</strong> (<aclass="reference internal"href="#com.vmware.cis.task_client.Progress"title="com.vmware.cis.task_client.Progress"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Progress</span></code></a>) – Progress of the operation. This attribute was added in vSphere API
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">#status</span></code> is one of <aclass="reference internal"href="#com.vmware.cis.task_client.Status.RUNNING"title="com.vmware.cis.task_client.Status.RUNNING"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Status.RUNNING</span></code></a>,
<li><p><strong>result</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DataValue</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Result of the operation. If an operation reports partial results
before it completes, this attribute could be <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> before
the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">CommonInfo.status</span></code> has the value
<aclass="reference internal"href="#com.vmware.cis.task_client.Status.SUCCEEDED"title="com.vmware.cis.task_client.Status.SUCCEEDED"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Status.SUCCEEDED</span></code></a>. The value could change as the operation
<li><p><strong>description</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the service containing the operation. This attribute
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.service</span></code>.</p></li>
<li><p><strong>operation</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the operation associated with the task. This
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.operation</span></code>.</p></li>
<li><p><strong>parent</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Parent of the current task. This attribute was added in vSphere API
This attribute will be None if the task has no parent.</p></li>
<li><p><strong>target</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID"title="com.vmware.vapi.std_client.DynamicID"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifier of the target created by the operation or an existing
<li><p><strong>status</strong> (<aclass="reference internal"href="#com.vmware.cis.task_client.Status"title="com.vmware.cis.task_client.Status"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag to indicate whether or not the operation can be cancelled. The
<li><p><strong>error</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Exception</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Description of the error if the operation status is “FAILED”. This
included in the result of the operation (see <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Info.result</span></code>).</p></li>
<li><p><strong>start_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Time when the operation is started. This attribute was added in
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">status</span></code> is one of <aclass="reference internal"href="#com.vmware.cis.task_client.Status.RUNNING"title="com.vmware.cis.task_client.Status.RUNNING"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Status.RUNNING</span></code></a>,
<li><p><strong>end_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Time when the operation is completed. This attribute was added in
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">status</span></code> is one of <aclass="reference internal"href="#com.vmware.cis.task_client.Status.SUCCEEDED"title="com.vmware.cis.task_client.Status.SUCCEEDED"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Status.SUCCEEDED</span></code></a> or
<li><p><strong>user</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name of the user who performed the operation. This attribute was
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.cis.task_client.</code><codeclass="sig-name descname">Progress</code><spanclass="sig-paren">(</span><emclass="sig-param">total=None</em>, <emclass="sig-param">completed=None</em>, <emclass="sig-param">message=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.task_client.Progress"title="Permalink to this definition">¶</a></dt>
<li><p><strong>total</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Message about the work progress. This attribute was added in
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.cis.task_client.</code><codeclass="sig-name descname">Status</code><spanclass="sig-paren">(</span><emclass="sig-param">string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.task_client.Status"title="Permalink to this definition">¶</a></dt>
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 <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="sig-name descname">BLOCKED</code><emclass="property"> = Status(string='BLOCKED')</em><aclass="headerlink"href="#com.vmware.cis.task_client.Status.BLOCKED"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">FAILED</code><emclass="property"> = Status(string='FAILED')</em><aclass="headerlink"href="#com.vmware.cis.task_client.Status.FAILED"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">PENDING</code><emclass="property"> = Status(string='PENDING')</em><aclass="headerlink"href="#com.vmware.cis.task_client.Status.PENDING"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">RUNNING</code><emclass="property"> = Status(string='RUNNING')</em><aclass="headerlink"href="#com.vmware.cis.task_client.Status.RUNNING"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">SUCCEEDED</code><emclass="property"> = Status(string='SUCCEEDED')</em><aclass="headerlink"href="#com.vmware.cis.task_client.Status.SUCCEEDED"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.cis.task_client.</code><codeclass="sig-name descname">StubFactory</code><spanclass="sig-paren">(</span><emclass="sig-param">stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.task_client.StubFactory"title="Permalink to this definition">¶</a></dt>
Built with <ahref="http://sphinx-doc.org/">Sphinx</a> using a <ahref="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <ahref="https://readthedocs.org">Read the Docs</a>.
