<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
attached tags and attached objects.</p>
<dlclass="class">
<dtid="com.vmware.cis.tagging_client.Category">
<emclass="property">class </em><codeclass="descclassname">com.vmware.cis.tagging_client.</code><codeclass="descname">Category</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.tagging_client.Category"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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.</td>
<emclass="property">class </em><codeclass="descname">CreateSpec</code><spanclass="sig-paren">(</span><em>name=None</em>, <em>description=None</em>, <em>cardinality=None</em>, <em>associable_types=None</em>, <em>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
create specification.</p>
<divclass="admonition tip">
<pclass="first admonition-title">Tip</p>
<pclass="last">The arguments are used to initialize data attributes with the same
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The display name of the category.</li>
<li><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The description of the category.</li>
<li><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.</li>
<li><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.</li>
<li><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.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="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: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.cis.tagging.Category</span></code>.
If None an identifier will be generated by the server</li>
<emclass="property">class </em><codeclass="descname">UpdateSpec</code><spanclass="sig-paren">(</span><em>name=None</em>, <em>description=None</em>, <em>cardinality=None</em>, <em>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>
<divclass="admonition tip">
<pclass="first admonition-title">Tip</p>
<pclass="last">The arguments are used to initialize data attributes with the same
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><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.</li>
<li><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.</li>
<li><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.</li>
<li><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>
<p>The <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of associable types cannot be updated
incrementally. For example, if
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="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 <codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <codeclass="xref py py-class docutils literal notranslate"><spanclass="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>
<codeclass="descname">add_to_used_by</code><spanclass="sig-paren">(</span><em>category_id</em>, <em>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><strong>category_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the input category.
The parameter must be an identifier for the resource type:
<li><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="descname">create</code><spanclass="sig-paren">(</span><em>create_spec</em><spanclass="sig-paren">)</span><aclass="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
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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.</td>
<codeclass="descname">delete</code><spanclass="sig-paren">(</span><em>category_id</em><spanclass="sig-paren">)</span><aclass="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
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>category_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of category to be deleted.
The parameter must be an identifier for the resource type:
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>category_id</em><spanclass="sig-paren">)</span><aclass="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
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>category_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the input category.
The parameter must be an identifier for the resource type:
<codeclass="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>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body">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
system.
The return value will contain identifiers for the resource type:
<codeclass="descname">list_used_categories</code><spanclass="sig-paren">(</span><em>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>
<dd><p>Enumerates all categories for which the <codeclass="docutils literal notranslate"><spanclass="pre">used_by_entity</span></code> is part of
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>. To invoke
this method, you need the read privilege on the individual categories.</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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.</td>
<trclass="field-odd field"><thclass="field-name">Returns:</th><tdclass="field-body">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
system that are used by <codeclass="docutils literal notranslate"><spanclass="pre">used_by_entity</span></code>.
The return value will contain identifiers for the resource type:
<codeclass="descname">remove_from_used_by</code><spanclass="sig-paren">(</span><em>category_id</em>, <em>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><strong>category_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the input category.
The parameter must be an identifier for the resource type:
<li><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="descname">revoke_propagating_permissions</code><spanclass="sig-paren">(</span><em>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>
<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>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>category_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the input category.
The parameter must be an identifier for the resource type:
<codeclass="descname">update</code><spanclass="sig-paren">(</span><em>category_id</em>, <em>update_spec</em><spanclass="sig-paren">)</span><aclass="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
<li><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.
The parameter must be an identifier for the resource type:
<emclass="property">class </em><codeclass="descclassname">com.vmware.cis.tagging_client.</code><codeclass="descname">CategoryModel</code><spanclass="sig-paren">(</span><em>id=None</em>, <em>name=None</em>, <em>description=None</em>, <em>cardinality=None</em>, <em>associable_types=None</em>, <em>used_by=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.tagging_client.CategoryModel"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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:
<codeclass="docutils literal notranslate"><spanclass="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: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.cis.tagging.Category</span></code>.</li>
<li><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The display name of the category.</li>
<li><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The description of the category.</li>
<li><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.</li>
<li><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
to. If the <codeclass="xref py py-class docutils literal notranslate"><spanclass="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.</li>
<li><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
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 <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code>.</li>
<emclass="property">class </em><codeclass="descname">Cardinality</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.tagging_client.CategoryModel.Cardinality"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">CategoryModel.Cardinality</span></code> class defines the number of tags in a
category that can be assigned to an object.</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">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 <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="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>
<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
<codeclass="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>
<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
<emclass="property">class </em><codeclass="descclassname">com.vmware.cis.tagging_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>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="descclassname">com.vmware.cis.tagging_client.</code><codeclass="descname">Tag</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.tagging_client.Tag"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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.</td>
<emclass="property">class </em><codeclass="descname">CreateSpec</code><spanclass="sig-paren">(</span><em>name=None</em>, <em>description=None</em>, <em>category_id=None</em>, <em>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
specification.</p>
<divclass="admonition tip">
<pclass="first admonition-title">Tip</p>
<pclass="last">The arguments are used to initialize data attributes with the same
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><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.</li>
<li><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The description of the tag.</li>
<li><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
be created.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="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: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.cis.tagging.Category</span></code>.</li>
<li><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.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="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: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.cis.tagging.Tag</span></code>.
If None an identifier will be generated by the server</li>
<emclass="property">class </em><codeclass="descname">UpdateSpec</code><spanclass="sig-paren">(</span><em>name=None</em>, <em>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>
<divclass="admonition tip">
<pclass="first admonition-title">Tip</p>
<pclass="last">The arguments are used to initialize data attributes with the same
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><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.</li>
<li><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.</li>
<codeclass="descname">add_to_used_by</code><spanclass="sig-paren">(</span><em>tag_id</em>, <em>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><strong>tag_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the input tag.
The parameter must be an identifier for the resource type:
<li><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="descname">create</code><spanclass="sig-paren">(</span><em>create_spec</em><spanclass="sig-paren">)</span><aclass="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
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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.</td>
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>
is the name of an already existing tag in the input category.</td>
if you do not have the privilege to create tag.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="com.vmware.cis.tagging_client.Tag.delete">
<codeclass="descname">delete</code><spanclass="sig-paren">(</span><em>tag_id</em><spanclass="sig-paren">)</span><aclass="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
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>tag_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the input tag.
The parameter must be an identifier for the resource type:
if you do not have the privilege to delete the tag.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="com.vmware.cis.tagging_client.Tag.get">
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>tag_id</em><spanclass="sig-paren">)</span><aclass="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
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>tag_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the input tag.
The parameter must be an identifier for the resource type:
if the user does not have the privilege to read the tag.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="com.vmware.cis.tagging_client.Tag.list">
<codeclass="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
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body">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
system.
The return value will contain identifiers for the resource type:
<codeclass="descname">list_tags_for_category</code><spanclass="sig-paren">(</span><em>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>
<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
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>category_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the input category.
The parameter must be an identifier for the resource type:
<trclass="field-odd field"><thclass="field-name">Returns:</th><tdclass="field-body">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
input category.
The return value will contain identifiers for the resource type:
<codeclass="descname">list_used_tags</code><spanclass="sig-paren">(</span><em>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>
<dd><p>Enumerates all tags for which the <codeclass="docutils literal notranslate"><spanclass="pre">used_by_entity</span></code> is part of 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>. To invoke this
method, you need the read privilege on the individual tags.</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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.</td>
<trclass="field-odd field"><thclass="field-name">Returns:</th><tdclass="field-body">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
system that are used by <codeclass="docutils literal notranslate"><spanclass="pre">used_by_entity</span></code>.
The return value will contain identifiers for the resource type:
<codeclass="descname">remove_from_used_by</code><spanclass="sig-paren">(</span><em>tag_id</em>, <em>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><strong>tag_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the input tag.
The parameter must be an identifier for the resource type:
<li><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="descname">revoke_propagating_permissions</code><spanclass="sig-paren">(</span><em>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>
<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
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>tag_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the input tag.
The parameter must be an identifier for the resource type:
if you do not have the privilege to revoke propagating permissions
on the tag.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="com.vmware.cis.tagging_client.Tag.update">
<codeclass="descname">update</code><spanclass="sig-paren">(</span><em>tag_id</em>, <em>update_spec</em><spanclass="sig-paren">)</span><aclass="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
<li><strong>tag_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the input tag.
The parameter must be an identifier for the resource type:
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="descclassname">com.vmware.cis.tagging_client.</code><codeclass="descname">TagAssociation</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.tagging_client.TagAssociation"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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.</td>
<emclass="property">class </em><codeclass="descname">BatchResult</code><spanclass="sig-paren">(</span><em>success=None</em>, <em>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>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><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.
Otherwise it is false and all or some methods have failed. This
attribute was added in vSphere API 6.5.</li>
<li><strong>error_messages</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.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>) – The <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of error messages. This attribute was added in
<emclass="property">class </em><codeclass="descname">ObjectToTags</code><spanclass="sig-paren">(</span><em>object_id=None</em>, <em>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
and the tags attached to it. This class was added in vSphere API 6.5.</p>
<divclass="admonition tip">
<pclass="first admonition-title">Tip</p>
<pclass="last">The arguments are used to initialize data attributes with the same
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><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.</li>
<li><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
vSphere API 6.5.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<codeclass="docutils literal notranslate"><spanclass="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: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.cis.tagging.Tag</span></code>.</li>
<emclass="property">class </em><codeclass="descname">TagToObjects</code><spanclass="sig-paren">(</span><em>tag_id=None</em>, <em>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
6.5.</p>
<divclass="admonition tip">
<pclass="first admonition-title">Tip</p>
<pclass="last">The arguments are used to initialize data attributes with the same
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><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
6.5.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="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: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.cis.tagging.Tag</span></code>.</li>
<li><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="descname">attach</code><spanclass="sig-paren">(</span><em>tag_id</em>, <em>object_id</em><spanclass="sig-paren">)</span><aclass="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 (<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>) 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
<li><strong>tag_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the input tag.
The parameter must be an identifier for the resource type:
<li><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.</li>
<codeclass="descname">attach_multiple_tags_to_object</code><spanclass="sig-paren">(</span><em>object_id</em>, <em>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>
<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
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="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>
<li><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.</li>
<li><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.
The parameter must contain identifiers for the resource type:
<trclass="field-odd field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first">The outcome of the batch method and the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of error
<codeclass="descname">attach_tag_to_multiple_objects</code><spanclass="sig-paren">(</span><em>tag_id</em>, <em>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>
<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
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="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>
<li><strong>tag_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the input tag.
The parameter must be an identifier for the resource type:
<trclass="field-odd field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first">The outcome of the batch method and the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of error
<codeclass="descname">detach</code><spanclass="sig-paren">(</span><em>tag_id</em>, <em>object_id</em><spanclass="sig-paren">)</span><aclass="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
<li><strong>tag_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the input tag.
The parameter must be an identifier for the resource type:
<li><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.</li>
<codeclass="descname">detach_multiple_tags_from_object</code><spanclass="sig-paren">(</span><em>object_id</em>, <em>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>
<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
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="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>
<li><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.</li>
<li><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.
The parameter must contain identifiers for the resource type:
<trclass="field-odd field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first">The outcome of the batch method and the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of error
<codeclass="descname">detach_tag_from_multiple_objects</code><spanclass="sig-paren">(</span><em>tag_id</em>, <em>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>
<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
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="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>
<li><strong>tag_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the input tag.
The parameter must be an identifier for the resource type:
<trclass="field-odd field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first">The outcome of the batch method and the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of error
<codeclass="descname">list_attachable_tags</code><spanclass="sig-paren">(</span><em>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
<trclass="field-odd field"><thclass="field-name">Returns:</th><tdclass="field-body">The <codeclass="xref py py-class docutils literal notranslate"><spanclass="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:
<codeclass="descname">list_attached_objects</code><spanclass="sig-paren">(</span><em>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>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>tag_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the input tag.
The parameter must be an identifier for the resource type:
<codeclass="descname">list_attached_objects_on_tags</code><spanclass="sig-paren">(</span><em>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>
<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.TagToObjects"title="com.vmware.cis.tagging_client.TagAssociation.TagToObjects"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">TagAssociation.TagToObjects.object_ids</span></code> will only
contain those objects for which you have the read privilege. This
<trclass="field-odd field"><thclass="field-name">Returns:</th><tdclass="field-body">The <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of the tag identifiers to all object identifiers
<codeclass="descname">list_attached_tags</code><spanclass="sig-paren">(</span><em>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
<trclass="field-odd field"><thclass="field-name">Returns:</th><tdclass="field-body">The <codeclass="xref py py-class docutils literal notranslate"><spanclass="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:
<codeclass="descname">list_attached_tags_on_objects</code><spanclass="sig-paren">(</span><em>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
<trclass="field-odd field"><thclass="field-name">Returns:</th><tdclass="field-body">The <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of the object identifiers to all tag identifiers
that are attached to that object.</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.cis.tagging_client.TagModel">
<emclass="property">class </em><codeclass="descclassname">com.vmware.cis.tagging_client.</code><codeclass="descname">TagModel</code><spanclass="sig-paren">(</span><em>id=None</em>, <em>category_id=None</em>, <em>name=None</em>, <em>description=None</em>, <em>used_by=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.tagging_client.TagModel"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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:
<codeclass="docutils literal notranslate"><spanclass="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: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.cis.tagging.Tag</span></code>.</li>
<li><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
created.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="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: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.cis.tagging.Category</span></code>.</li>
<li><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The display name of the tag.</li>
<li><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The description of the tag.</li>
<li><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
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
<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
managing tasks.</p>
<dlclass="class">
<dtid="com.vmware.cis.task_client.CommonInfo">
<emclass="property">class </em><codeclass="descclassname">com.vmware.cis.task_client.</code><codeclass="descname">CommonInfo</code><spanclass="sig-paren">(</span><em>description=None</em>, <em>service=None</em>, <em>operation=None</em>, <em>parent=None</em>, <em>target=None</em>, <em>status=None</em>, <em>cancelable=None</em>, <em>error=None</em>, <em>start_time=None</em>, <em>end_time=None</em>, <em>user=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.task_client.CommonInfo"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><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.</li>
<li><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
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:
<codeclass="docutils literal notranslate"><spanclass="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: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.service</span></code>.</li>
<li><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
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:
<codeclass="docutils literal notranslate"><spanclass="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: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.operation</span></code>.</li>
<li><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
6.7.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="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
This attribute will be None if the task has no parent.</li>
<li><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
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.</li>
<li><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.</li>
<li><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
value may change as the operation progresses. This attribute was
added in vSphere API 6.7.</li>
<li><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
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 <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Info.result</span></code>).</li>
<li><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
vSphere API 6.7.
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><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
vSphere API 6.7.
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><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
added in vSphere API 6.7.
This attribute will be None if the operation is performed by the
system.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.cis.task_client.Info">
<emclass="property">class </em><codeclass="descclassname">com.vmware.cis.task_client.</code><codeclass="descname">Info</code><spanclass="sig-paren">(</span><em>progress=None</em>, <em>result=None</em>, <em>description=None</em>, <em>service=None</em>, <em>operation=None</em>, <em>parent=None</em>, <em>target=None</em>, <em>status=None</em>, <em>cancelable=None</em>, <em>error=None</em>, <em>start_time=None</em>, <em>end_time=None</em>, <em>user=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.task_client.Info"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><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
6.7.
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><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
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.</li>
<li><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.</li>
<li><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
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:
<codeclass="docutils literal notranslate"><spanclass="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: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.service</span></code>.</li>
<li><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
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:
<codeclass="docutils literal notranslate"><spanclass="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: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.operation</span></code>.</li>
<li><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
6.7.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="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
This attribute will be None if the task has no parent.</li>
<li><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
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.</li>
<li><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.</li>
<li><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
value may change as the operation progresses. This attribute was
added in vSphere API 6.7.</li>
<li><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
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 <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Info.result</span></code>).</li>
<li><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
vSphere API 6.7.
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><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
vSphere API 6.7.
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><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
added in vSphere API 6.7.
This attribute will be None if the operation is performed by the
system.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.cis.task_client.Progress">
<emclass="property">class </em><codeclass="descclassname">com.vmware.cis.task_client.</code><codeclass="descname">Progress</code><spanclass="sig-paren">(</span><em>total=None</em>, <em>completed=None</em>, <em>message=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.task_client.Progress"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><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.</li>
<li><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.</li>
<li><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
vSphere API 6.7.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.cis.task_client.Status">
<emclass="property">class </em><codeclass="descclassname">com.vmware.cis.task_client.</code><codeclass="descname">Status</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis.task_client.Status"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">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 <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="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>
<dd><p>The operation is blocked. This class attribute was added in vSphere API
6.7.</p>
</dd></dl>
<dlclass="attribute">
<dtid="com.vmware.cis.task_client.Status.FAILED">
<codeclass="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>
<dd><p>The operation failed. This class attribute was added in vSphere API 6.7.</p>
<codeclass="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>
<dd><p>The operation is in pending state. This class attribute was added in
<codeclass="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>
<dd><p>The operation is in progress. This class attribute was added in vSphere API
<codeclass="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>
<dd><p>The operation completed successfully. This class attribute was added in
vSphere API 6.7.</p>
</dd></dl>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.cis.task_client.StubFactory">
<emclass="property">class </em><codeclass="descclassname">com.vmware.cis.task_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>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>.
