mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-22 17:39:59 -05:00
1476 lines
112 KiB
HTML
1476 lines
112 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
|
|
||
|
|
|
||
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||
|
|
|
||
|
|
<title>com.vmware.cis package — vSphere Automation SDK for Python 6.6.1 documentation</title>
|
||
|
|
|
||
|
|
<link rel="stylesheet" href="_static/vapitheme.css" type="text/css" />
|
||
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||
|
|
|
||
|
|
<script type="text/javascript">
|
||
|
|
var DOCUMENTATION_OPTIONS = {
|
||
|
|
URL_ROOT: './',
|
||
|
|
VERSION: '6.6.1',
|
||
|
|
COLLAPSE_INDEX: false,
|
||
|
|
FILE_SUFFIX: '.html',
|
||
|
|
HAS_SOURCE: true
|
||
|
|
};
|
||
|
|
</script>
|
||
|
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
||
|
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
||
|
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
||
|
|
<link rel="top" title="vSphere Automation SDK for Python 6.6.1 documentation" href="index.html" />
|
||
|
|
<link rel="up" title="com.vmware package" href="com.vmware.html" />
|
||
|
|
<link rel="next" title="com.vmware.content package" href="com.vmware.content.html" />
|
||
|
|
<link rel="prev" title="com.vmware.appliance.techpreview.networking.firewall package" href="com.vmware.appliance.techpreview.networking.firewall.html" />
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<div class="related">
|
||
|
|
<h3>Navigation</h3>
|
||
|
|
<ul>
|
||
|
|
<li class="right" style="margin-right: 10px">
|
||
|
|
<a href="genindex.html" title="General Index"
|
||
|
|
accesskey="I">index</a></li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="py-modindex.html" title="Python Module Index"
|
||
|
|
>modules</a> |</li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="com.vmware.content.html" title="com.vmware.content package"
|
||
|
|
accesskey="N">next</a> |</li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="com.vmware.appliance.techpreview.networking.firewall.html" title="com.vmware.appliance.techpreview.networking.firewall package"
|
||
|
|
accesskey="P">previous</a> |</li>
|
||
|
|
<li><a href="index.html">vSphere Automation SDK for Python 6.6.1 documentation</a> »</li>
|
||
|
|
<li><a href="com.html" >com package</a> »</li>
|
||
|
|
<li><a href="com.vmware.html" accesskey="U">com.vmware package</a> »</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="document">
|
||
|
|
<div class="documentwrapper">
|
||
|
|
<div class="bodywrapper">
|
||
|
|
<div class="body">
|
||
|
|
|
||
|
|
<div class="section" id="com-vmware-cis-package">
|
||
|
|
<h1>com.vmware.cis package<a class="headerlink" href="#com-vmware-cis-package" title="Permalink to this headline">¶</a></h1>
|
||
|
|
<div class="section" id="submodules">
|
||
|
|
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="module-com.vmware.cis.tagging_client">
|
||
|
|
<span id="com-vmware-cis-tagging-client-module"></span><h2>com.vmware.cis.tagging_client module<a class="headerlink" href="#module-com.vmware.cis.tagging_client" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">com.vmware.cis.tagging_client</span></tt> 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. Copyright 2013-2014 VMware, Inc. All rights
|
||
|
|
reserved. – VMware Confidential Copyright 2013-2014 VMware, Inc. All rights
|
||
|
|
reserved. – VMware Confidential Copyright 2013-2014 VMware, Inc. All rights
|
||
|
|
reserved. – VMware Confidential Copyright 2013-2015 VMware, Inc. All rights
|
||
|
|
reserved. – VMware Confidential Copyright 2013-2014 VMware, Inc. All rights
|
||
|
|
reserved. – VMware Confidential</p>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.cis.tagging_client.Category">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.cis.tagging_client.</tt><tt class="descname">Category</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.cis.tagging_client.Category" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Category</span></tt> class provides methods to create, read, update, delete,
|
||
|
|
and enumerate categories.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.cis.tagging_client.Category.CreateSpec">
|
||
|
|
<em class="property">class </em><tt class="descname">CreateSpec</tt><big>(</big><em>name=None</em>, <em>description=None</em>, <em>cardinality=None</em>, <em>associable_types=None</em><big>)</big><a class="headerlink" href="#com.vmware.cis.tagging_client.Category.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Category.CreateSpec</span></tt> class is used to create a category.</p>
|
||
|
|
<p>Use the <a class="reference internal" href="#com.vmware.cis.tagging_client.Category.create" title="com.vmware.cis.tagging_client.Category.create"><tt class="xref py py-func docutils literal"><span class="pre">Category.create()</span></tt></a> method to create a category defined by the
|
||
|
|
create specification.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The display name of the category.</li>
|
||
|
|
<li><strong>description</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The description of the category.</li>
|
||
|
|
<li><strong>cardinality</strong> (<a class="reference internal" href="#com.vmware.cis.tagging_client.CategoryModel.Cardinality" title="com.vmware.cis.tagging_client.CategoryModel.Cardinality"><tt class="xref py py-class docutils literal"><span class="pre">CategoryModel.Cardinality</span></tt></a>) – The associated cardinality (SINGLE, MULTIPLE) of the category.</li>
|
||
|
|
<li><strong>associable_types</strong> (<tt class="xref py py-class docutils literal"><span class="pre">set</span></tt> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Object types to which this category’s tags can be attached.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.cis.tagging_client.Category.UpdateSpec">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Category.</tt><tt class="descname">UpdateSpec</tt><big>(</big><em>name=None</em>, <em>description=None</em>, <em>cardinality=None</em>, <em>associable_types=None</em><big>)</big><a class="headerlink" href="#com.vmware.cis.tagging_client.Category.UpdateSpec" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Category.UpdateSpec</span></tt> class describes the updates to be made to an
|
||
|
|
existing category.</p>
|
||
|
|
<p>Use the <a class="reference internal" href="#com.vmware.cis.tagging_client.Category.update" title="com.vmware.cis.tagging_client.Category.update"><tt class="xref py py-func docutils literal"><span class="pre">Category.update()</span></tt></a> method to modify a category. When you call
|
||
|
|
the method, specify the category identifier. You obtain the category
|
||
|
|
identifier when you call the <a class="reference internal" href="#com.vmware.cis.tagging_client.Category.create" title="com.vmware.cis.tagging_client.Category.create"><tt class="xref py py-func docutils literal"><span class="pre">Category.create()</span></tt></a> method. You can also
|
||
|
|
retrieve an identifier by using the <a class="reference internal" href="#com.vmware.cis.tagging_client.Category.list" title="com.vmware.cis.tagging_client.Category.list"><tt class="xref py py-func docutils literal"><span class="pre">Category.list()</span></tt></a> method.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – The display name of the category.
|
||
|
|
If None the name will not be modified.</li>
|
||
|
|
<li><strong>description</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – The description of the category.
|
||
|
|
If None the description will not be modified.</li>
|
||
|
|
<li><strong>cardinality</strong> (<a class="reference internal" href="#com.vmware.cis.tagging_client.CategoryModel.Cardinality" title="com.vmware.cis.tagging_client.CategoryModel.Cardinality"><tt class="xref py py-class docutils literal"><span class="pre">CategoryModel.Cardinality</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – The associated cardinality (SINGLE, MULTIPLE) of the category.
|
||
|
|
If None the cardinality will not be modified.</li>
|
||
|
|
<li><strong>associable_types</strong> (<tt class="xref py py-class docutils literal"><span class="pre">set</span></tt> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – <p>Object types to which this category’s tags can be attached.</p>
|
||
|
|
<p>The <tt class="xref py py-class docutils literal"><span class="pre">set</span></tt> of associable types cannot be updated
|
||
|
|
incrementally. For example, if
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">Category.UpdateSpec.associable_types</span></tt> 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 <tt class="xref py py-class docutils literal"><span class="pre">set</span></tt>. For example, if you have {A,B,C}, then you
|
||
|
|
cannot remove say {A} from it. Similarly, if you start with an
|
||
|
|
empty <tt class="xref py py-class docutils literal"><span class="pre">set</span></tt>, 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>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.cis.tagging_client.Category.add_to_used_by">
|
||
|
|
<tt class="descclassname">Category.</tt><tt class="descname">add_to_used_by</tt><big>(</big><em>category_id</em>, <em>used_by_entity</em><big>)</big><a class="headerlink" href="#com.vmware.cis.tagging_client.Category.add_to_used_by" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Adds the <tt class="docutils literal"><span class="pre">used_by_entity</span></tt> to the <tt class="xref py py-attr docutils literal"><span class="pre">CategoryModel.used_by</span></tt>
|
||
|
|
subscribers <tt class="xref py py-class docutils literal"><span class="pre">set</span></tt> for the specified category. If the
|
||
|
|
<tt class="docutils literal"><span class="pre">used_by_entity</span></tt> is already in the <tt class="xref py py-class docutils literal"><span class="pre">set</span></tt>, then this becomes an
|
||
|
|
idempotent no-op. To invoke this method, you need the modify
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">CategoryModel.used_by</span></tt> privilege on the category.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>category_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The identifier of the input category.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.cis.tagging.Category</span></tt>.</li>
|
||
|
|
<li><strong>used_by_entity</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The name of the user to be added to the
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">CategoryModel.used_by</span></tt> <tt class="xref py py-class docutils literal"><span class="pre">set</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the category for the given <tt class="docutils literal"><span class="pre">category_id</span></tt> does not exist in the
|
||
|
|
system.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have the privilege to add an entity to the
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">CategoryModel.used_by</span></tt> field.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.cis.tagging_client.Category.create">
|
||
|
|
<tt class="descclassname">Category.</tt><tt class="descname">create</tt><big>(</big><em>create_spec</em><big>)</big><a class="headerlink" href="#com.vmware.cis.tagging_client.Category.create" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Creates a category. To invoke this method, you need the create category
|
||
|
|
privilege.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>create_spec</strong> (<a class="reference internal" href="#com.vmware.cis.tagging_client.Category.CreateSpec" title="com.vmware.cis.tagging_client.Category.CreateSpec"><tt class="xref py py-class docutils literal"><span class="pre">Category.CreateSpec</span></tt></a>) – Specification for the new category to be created.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">str</span></tt></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The identifier of the created category.
|
||
|
|
The return value will be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.cis.tagging.Category</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></tt>
|
||
|
|
if the <tt class="xref py py-attr docutils literal"><span class="pre">Category.CreateSpec.name</span></tt> provided in the
|
||
|
|
<tt class="docutils literal"><span class="pre">create_spec</span></tt> is the name of an already existing category.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt>
|
||
|
|
if any of the information in the <tt class="docutils literal"><span class="pre">create_spec</span></tt> is invalid.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have the privilege to create a category.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.cis.tagging_client.Category.delete">
|
||
|
|
<tt class="descclassname">Category.</tt><tt class="descname">delete</tt><big>(</big><em>category_id</em><big>)</big><a class="headerlink" href="#com.vmware.cis.tagging_client.Category.delete" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Deletes an existing category. To invoke this method, you need the
|
||
|
|
delete privilege on the category.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>category_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The identifier of category to be deleted.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.cis.tagging.Category</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the category for the given <tt class="docutils literal"><span class="pre">category_id</span></tt> does not exist in the
|
||
|
|
system.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have the privilege to delete the category.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.cis.tagging_client.Category.get">
|
||
|
|
<tt class="descclassname">Category.</tt><tt class="descname">get</tt><big>(</big><em>category_id</em><big>)</big><a class="headerlink" href="#com.vmware.cis.tagging_client.Category.get" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Fetches the category information for the given category identifier. In
|
||
|
|
order to view the category information, you need the read privilege on
|
||
|
|
the category.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>category_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The identifier of the input category.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.cis.tagging.Category</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.cis.tagging_client.CategoryModel" title="com.vmware.cis.tagging_client.CategoryModel"><tt class="xref py py-class docutils literal"><span class="pre">CategoryModel</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The <a class="reference internal" href="#com.vmware.cis.tagging_client.CategoryModel" title="com.vmware.cis.tagging_client.CategoryModel"><tt class="xref py py-class docutils literal"><span class="pre">CategoryModel</span></tt></a> that corresponds to <tt class="docutils literal"><span class="pre">category_id</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the category for the given <tt class="docutils literal"><span class="pre">category_id</span></tt> does not exist in the
|
||
|
|
system.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have the privilege to read the category.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.cis.tagging_client.Category.list">
|
||
|
|
<tt class="descclassname">Category.</tt><tt class="descname">list</tt><big>(</big><big>)</big><a class="headerlink" href="#com.vmware.cis.tagging_client.Category.list" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Enumerates the categories in the system. To invoke this method, you
|
||
|
|
need the read privilege on the individual categories. The <a class="reference internal" href="#com.vmware.cis.tagging_client.Category.list" title="com.vmware.cis.tagging_client.Category.list"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a>
|
||
|
|
will only contain those categories for which you have read privileges.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.cis.tagging_client.Category.list" title="com.vmware.cis.tagging_client.Category.list"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The <a class="reference internal" href="#com.vmware.cis.tagging_client.Category.list" title="com.vmware.cis.tagging_client.Category.list"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of resource identifiers for the categories in the
|
||
|
|
system.
|
||
|
|
The return value will contain identifiers for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.cis.tagging.Category</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.cis.tagging_client.Category.list_used_categories">
|
||
|
|
<tt class="descclassname">Category.</tt><tt class="descname">list_used_categories</tt><big>(</big><em>used_by_entity</em><big>)</big><a class="headerlink" href="#com.vmware.cis.tagging_client.Category.list_used_categories" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Enumerates all categories for which the <tt class="docutils literal"><span class="pre">used_by_entity</span></tt> is part of
|
||
|
|
the <tt class="xref py py-attr docutils literal"><span class="pre">CategoryModel.used_by</span></tt> subscribers <tt class="xref py py-class docutils literal"><span class="pre">set</span></tt>. To invoke
|
||
|
|
this method, you need the read privilege on the individual categories.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>used_by_entity</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The field on which the results will be filtered.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.cis.tagging_client.Category.list" title="com.vmware.cis.tagging_client.Category.list"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The <a class="reference internal" href="#com.vmware.cis.tagging_client.Category.list" title="com.vmware.cis.tagging_client.Category.list"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of resource identifiers for the categories in the
|
||
|
|
system that are used by <tt class="docutils literal"><span class="pre">used_by_entity</span></tt>.
|
||
|
|
The return value will contain identifiers for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.cis.tagging.Category</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.cis.tagging_client.Category.remove_from_used_by">
|
||
|
|
<tt class="descclassname">Category.</tt><tt class="descname">remove_from_used_by</tt><big>(</big><em>category_id</em>, <em>used_by_entity</em><big>)</big><a class="headerlink" href="#com.vmware.cis.tagging_client.Category.remove_from_used_by" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Removes the <tt class="docutils literal"><span class="pre">used_by_entity</span></tt> from the <tt class="xref py py-attr docutils literal"><span class="pre">CategoryModel.used_by</span></tt>
|
||
|
|
subscribers <tt class="xref py py-class docutils literal"><span class="pre">set</span></tt>. If the <tt class="docutils literal"><span class="pre">used_by_entity</span></tt> is not using this
|
||
|
|
category, then this becomes a no-op. To invoke this method, you need
|
||
|
|
the modify <tt class="xref py py-attr docutils literal"><span class="pre">CategoryModel.used_by</span></tt> privilege on the category.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>category_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The identifier of the input category.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.cis.tagging.Category</span></tt>.</li>
|
||
|
|
<li><strong>used_by_entity</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The name of the user to be removed from the
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">CategoryModel.used_by</span></tt> <tt class="xref py py-class docutils literal"><span class="pre">set</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the category for the given <tt class="docutils literal"><span class="pre">category_id</span></tt> does not exist in the
|
||
|
|
system.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have the privilege to remove an entity from the
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">CategoryModel.used_by</span></tt> field.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.cis.tagging_client.Category.revoke_propagating_permissions">
|
||
|
|
<tt class="descclassname">Category.</tt><tt class="descname">revoke_propagating_permissions</tt><big>(</big><em>category_id</em><big>)</big><a class="headerlink" href="#com.vmware.cis.tagging_client.Category.revoke_propagating_permissions" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Revokes all propagating permissions on the given category. You should
|
||
|
|
then attach a direct permission with tagging privileges on the given
|
||
|
|
category. To invoke this method, you need category related privileges
|
||
|
|
(direct or propagating) on the concerned category.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>category_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The identifier of the input category.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.cis.tagging.Category</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the category for the given <tt class="docutils literal"><span class="pre">category_id</span></tt> does not exist in the
|
||
|
|
system.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have the privilege to revoke propagating permissions
|
||
|
|
on the category.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.cis.tagging_client.Category.update">
|
||
|
|
<tt class="descclassname">Category.</tt><tt class="descname">update</tt><big>(</big><em>category_id</em>, <em>update_spec</em><big>)</big><a class="headerlink" href="#com.vmware.cis.tagging_client.Category.update" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Updates an existing category. To invoke this method, you need the edit
|
||
|
|
privilege on the category.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>category_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The identifier of the category to be updated.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.cis.tagging.Category</span></tt>.</li>
|
||
|
|
<li><strong>update_spec</strong> (<a class="reference internal" href="#com.vmware.cis.tagging_client.Category.UpdateSpec" title="com.vmware.cis.tagging_client.Category.UpdateSpec"><tt class="xref py py-class docutils literal"><span class="pre">Category.UpdateSpec</span></tt></a>) – Specification to update the category.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></tt>
|
||
|
|
if the <tt class="xref py py-attr docutils literal"><span class="pre">Category.UpdateSpec.name</span></tt> provided in the
|
||
|
|
<tt class="docutils literal"><span class="pre">update_spec</span></tt> is the name of an already existing category.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt>
|
||
|
|
if any of the information in the <tt class="docutils literal"><span class="pre">update_spec</span></tt> is invalid.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the category for the given <tt class="docutils literal"><span class="pre">category_id</span></tt> does not exist in the
|
||
|
|
system.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have the privilege to update the category.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.cis.tagging_client.CategoryModel">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.cis.tagging_client.</tt><tt class="descname">CategoryModel</tt><big>(</big><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><big>)</big><a class="headerlink" href="#com.vmware.cis.tagging_client.CategoryModel" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">CategoryModel</span></tt> class defines a category that is used to group one or
|
||
|
|
more tags.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – 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:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.cis.tagging.Category</span></tt>. When methods return a value of
|
||
|
|
this class as a return value, the attribute will be an identifier
|
||
|
|
for the resource type: <tt class="docutils literal"><span class="pre">com.vmware.cis.tagging.Category</span></tt>.</li>
|
||
|
|
<li><strong>name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The display name of the category.</li>
|
||
|
|
<li><strong>description</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The description of the category.</li>
|
||
|
|
<li><strong>cardinality</strong> (<a class="reference internal" href="#com.vmware.cis.tagging_client.CategoryModel.Cardinality" title="com.vmware.cis.tagging_client.CategoryModel.Cardinality"><tt class="xref py py-class docutils literal"><span class="pre">CategoryModel.Cardinality</span></tt></a>) – The associated cardinality (SINGLE, MULTIPLE) of the category.</li>
|
||
|
|
<li><strong>associable_types</strong> (<tt class="xref py py-class docutils literal"><span class="pre">set</span></tt> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The types of objects that the tags in this category can be attached
|
||
|
|
to. If the <tt class="xref py py-class docutils literal"><span class="pre">set</span></tt> 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> (<tt class="xref py py-class docutils literal"><span class="pre">set</span></tt> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The <tt class="xref py py-class docutils literal"><span class="pre">set</span></tt> 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 <tt class="xref py py-class docutils literal"><span class="pre">set</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.cis.tagging_client.CategoryModel.Cardinality">
|
||
|
|
<em class="property">class </em><tt class="descname">Cardinality</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.cis.tagging_client.CategoryModel.Cardinality" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">CategoryModel.Cardinality</span></tt> class defines the number of tags in a
|
||
|
|
category that can be assigned to an object.</p>
|
||
|
|
<div class="admonition note">
|
||
|
|
<p class="first admonition-title">Note</p>
|
||
|
|
<p class="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 <a class="reference internal" href="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
||
|
|
type description page</em></a>.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <tt class="xref py py-class docutils literal"><span class="pre">Cardinality</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.cis.tagging_client.CategoryModel.Cardinality.MULTIPLE">
|
||
|
|
<tt class="descname">MULTIPLE</tt><em class="property"> = Cardinality(string=u'MULTIPLE')</em><a class="headerlink" href="#com.vmware.cis.tagging_client.CategoryModel.Cardinality.MULTIPLE" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>An object can be assigned several of the tags in this category. For
|
||
|
|
example, if a category is “Server”, then different tags of this category
|
||
|
|
would be “AppServer”, “DatabaseServer” and so on. In this case a VM object
|
||
|
|
can be assigned more than one of the above tags and hence the cardinality
|
||
|
|
of the associated category here is multiple.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.cis.tagging_client.CategoryModel.Cardinality.SINGLE">
|
||
|
|
<tt class="descname">SINGLE</tt><em class="property"> = Cardinality(string=u'SINGLE')</em><a class="headerlink" href="#com.vmware.cis.tagging_client.CategoryModel.Cardinality.SINGLE" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>An object can only be assigned one of the tags in this category. For
|
||
|
|
example, if a category is “Operating System”, then different tags of this
|
||
|
|
category would be “Windows”, “Linux”, and so on. In this case a VM object
|
||
|
|
can be assigned only one of these tags and hence the cardinality of the
|
||
|
|
associated category here is single.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.cis.tagging_client.Tag">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.cis.tagging_client.</tt><tt class="descname">Tag</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Tag</span></tt> class provides methods to create, read, update, delete, and
|
||
|
|
enumerate tags.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.cis.tagging_client.Tag.CreateSpec">
|
||
|
|
<em class="property">class </em><tt class="descname">CreateSpec</tt><big>(</big><em>name=None</em>, <em>description=None</em>, <em>category_id=None</em><big>)</big><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Tag.CreateSpec</span></tt> class describes a tag.</p>
|
||
|
|
<p>Use the <a class="reference internal" href="#com.vmware.cis.tagging_client.Tag.create" title="com.vmware.cis.tagging_client.Tag.create"><tt class="xref py py-func docutils literal"><span class="pre">Tag.create()</span></tt></a> method to create a tag defined by the create
|
||
|
|
specification.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The display name of the tag. The name must be unique within its
|
||
|
|
category.</li>
|
||
|
|
<li><strong>description</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The description of the tag.</li>
|
||
|
|
<li><strong>category_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – 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:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.cis.tagging.Category</span></tt>. When methods return a value of
|
||
|
|
this class as a return value, the attribute will be an identifier
|
||
|
|
for the resource type: <tt class="docutils literal"><span class="pre">com.vmware.cis.tagging.Category</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.cis.tagging_client.Tag.UpdateSpec">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Tag.</tt><tt class="descname">UpdateSpec</tt><big>(</big><em>name=None</em>, <em>description=None</em><big>)</big><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag.UpdateSpec" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Tag.UpdateSpec</span></tt> class describes the updates to be made to an
|
||
|
|
existing tag.</p>
|
||
|
|
<p>Use the <a class="reference internal" href="#com.vmware.cis.tagging_client.Tag.update" title="com.vmware.cis.tagging_client.Tag.update"><tt class="xref py py-func docutils literal"><span class="pre">Tag.update()</span></tt></a> method to modify a tag. When you call the
|
||
|
|
method, you specify the tag identifier. You obtain the tag identifier when
|
||
|
|
you call the <a class="reference internal" href="#com.vmware.cis.tagging_client.Tag.create" title="com.vmware.cis.tagging_client.Tag.create"><tt class="xref py py-func docutils literal"><span class="pre">Tag.create()</span></tt></a> method. You can also retrieve an identifier
|
||
|
|
by using the <a class="reference internal" href="#com.vmware.cis.tagging_client.Tag.list" title="com.vmware.cis.tagging_client.Tag.list"><tt class="xref py py-func docutils literal"><span class="pre">Tag.list()</span></tt></a> method.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – The display name of the tag.
|
||
|
|
If None the name will not be modified.</li>
|
||
|
|
<li><strong>description</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – The description of the tag.
|
||
|
|
If None the description will not be modified.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.cis.tagging_client.Tag.add_to_used_by">
|
||
|
|
<tt class="descclassname">Tag.</tt><tt class="descname">add_to_used_by</tt><big>(</big><em>tag_id</em>, <em>used_by_entity</em><big>)</big><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag.add_to_used_by" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Adds the <tt class="docutils literal"><span class="pre">used_by_entity</span></tt> to the <tt class="xref py py-attr docutils literal"><span class="pre">TagModel.used_by</span></tt> subscribers
|
||
|
|
<tt class="xref py py-class docutils literal"><span class="pre">set</span></tt>. If the <tt class="docutils literal"><span class="pre">used_by_entity</span></tt> is already in the <tt class="xref py py-class docutils literal"><span class="pre">set</span></tt>,
|
||
|
|
then this becomes a no-op. To invoke this method, you need the modify
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">TagModel.used_by</span></tt> privilege on the tag.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>tag_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The identifier of the input tag.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.cis.tagging.Tag</span></tt>.</li>
|
||
|
|
<li><strong>used_by_entity</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The name of the user to be added to the <tt class="xref py py-attr docutils literal"><span class="pre">TagModel.used_by</span></tt>
|
||
|
|
<tt class="xref py py-class docutils literal"><span class="pre">set</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the tag for the given <tt class="docutils literal"><span class="pre">tag_id</span></tt> does not exist in the system.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have the privilege to add an entity to the
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">TagModel.used_by</span></tt> field.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.cis.tagging_client.Tag.create">
|
||
|
|
<tt class="descclassname">Tag.</tt><tt class="descname">create</tt><big>(</big><em>create_spec</em><big>)</big><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag.create" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Creates a tag. To invoke this method, you need the create tag privilege
|
||
|
|
on the input category.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>create_spec</strong> (<a class="reference internal" href="#com.vmware.cis.tagging_client.Tag.CreateSpec" title="com.vmware.cis.tagging_client.Tag.CreateSpec"><tt class="xref py py-class docutils literal"><span class="pre">Tag.CreateSpec</span></tt></a>) – Specification for the new tag to be created.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">str</span></tt></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The identifier of the created tag.
|
||
|
|
The return value will be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.cis.tagging.Tag</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></tt>
|
||
|
|
if the <tt class="xref py py-attr docutils literal"><span class="pre">Tag.CreateSpec.name</span></tt> provided in the <tt class="docutils literal"><span class="pre">create_spec</span></tt>
|
||
|
|
is the name of an already existing tag in the input category.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt>
|
||
|
|
if any of the input information in the <tt class="docutils literal"><span class="pre">create_spec</span></tt> is invalid.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the category for in the given <tt class="docutils literal"><span class="pre">create_spec</span></tt> does not exist in
|
||
|
|
the system.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have the privilege to create tag.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.cis.tagging_client.Tag.delete">
|
||
|
|
<tt class="descclassname">Tag.</tt><tt class="descname">delete</tt><big>(</big><em>tag_id</em><big>)</big><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag.delete" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Deletes an existing tag. To invoke this method, you need the delete
|
||
|
|
privilege on the tag.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>tag_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The identifier of the input tag.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.cis.tagging.Tag</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the tag for the given <tt class="docutils literal"><span class="pre">tag_id</span></tt> does not exist in the system.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have the privilege to delete the tag.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.cis.tagging_client.Tag.get">
|
||
|
|
<tt class="descclassname">Tag.</tt><tt class="descname">get</tt><big>(</big><em>tag_id</em><big>)</big><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag.get" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Fetches the tag information for the given tag identifier. To invoke
|
||
|
|
this method, you need the read privilege on the tag in order to view
|
||
|
|
the tag info.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>tag_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The identifier of the input tag.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.cis.tagging.Tag</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.cis.tagging_client.TagModel" title="com.vmware.cis.tagging_client.TagModel"><tt class="xref py py-class docutils literal"><span class="pre">TagModel</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The <a class="reference internal" href="#com.vmware.cis.tagging_client.TagModel" title="com.vmware.cis.tagging_client.TagModel"><tt class="xref py py-class docutils literal"><span class="pre">TagModel</span></tt></a> that corresponds to <tt class="docutils literal"><span class="pre">tag_id</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the tag for the given <tt class="docutils literal"><span class="pre">tag_id</span></tt> does not exist in the system.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if the user does not have the privilege to read the tag.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.cis.tagging_client.Tag.list">
|
||
|
|
<tt class="descclassname">Tag.</tt><tt class="descname">list</tt><big>(</big><big>)</big><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag.list" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Enumerates the tags in the system. To invoke this method, you need read
|
||
|
|
privilege on the individual tags. The <a class="reference internal" href="#com.vmware.cis.tagging_client.Tag.list" title="com.vmware.cis.tagging_client.Tag.list"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> will only contain
|
||
|
|
tags for which you have read privileges.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.cis.tagging_client.Tag.list" title="com.vmware.cis.tagging_client.Tag.list"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The <a class="reference internal" href="#com.vmware.cis.tagging_client.Tag.list" title="com.vmware.cis.tagging_client.Tag.list"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of resource identifiers for the tags in the
|
||
|
|
system.
|
||
|
|
The return value will contain identifiers for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.cis.tagging.Tag</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.cis.tagging_client.Tag.list_tags_for_category">
|
||
|
|
<tt class="descclassname">Tag.</tt><tt class="descname">list_tags_for_category</tt><big>(</big><em>category_id</em><big>)</big><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag.list_tags_for_category" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Enumerates all tags for the given category. To invoke this method, you
|
||
|
|
need the read privilege on the given category and the individual tags
|
||
|
|
in that category.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>category_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The identifier of the input category.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.cis.tagging.Category</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.cis.tagging_client.Tag.list" title="com.vmware.cis.tagging_client.Tag.list"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The <a class="reference internal" href="#com.vmware.cis.tagging_client.Tag.list" title="com.vmware.cis.tagging_client.Tag.list"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of resource identifiers for the tags in the given
|
||
|
|
input category.
|
||
|
|
The return value will contain identifiers for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.cis.tagging.Tag</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the category for the given <tt class="docutils literal"><span class="pre">category_id</span></tt> does not exist in the
|
||
|
|
system.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have the privilege to read the category.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.cis.tagging_client.Tag.list_used_tags">
|
||
|
|
<tt class="descclassname">Tag.</tt><tt class="descname">list_used_tags</tt><big>(</big><em>used_by_entity</em><big>)</big><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag.list_used_tags" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Enumerates all tags for which the <tt class="docutils literal"><span class="pre">used_by_entity</span></tt> is part of the
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">TagModel.used_by</span></tt> subscribers <tt class="xref py py-class docutils literal"><span class="pre">set</span></tt>. To invoke this
|
||
|
|
method, you need the read privilege on the individual tags.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>used_by_entity</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The field on which the results will be filtered.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.cis.tagging_client.Tag.list" title="com.vmware.cis.tagging_client.Tag.list"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The <a class="reference internal" href="#com.vmware.cis.tagging_client.Tag.list" title="com.vmware.cis.tagging_client.Tag.list"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of resource identifiers for the tags in the
|
||
|
|
system that are used by <tt class="docutils literal"><span class="pre">used_by_entity</span></tt>.
|
||
|
|
The return value will contain identifiers for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.cis.tagging.Tag</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.cis.tagging_client.Tag.remove_from_used_by">
|
||
|
|
<tt class="descclassname">Tag.</tt><tt class="descname">remove_from_used_by</tt><big>(</big><em>tag_id</em>, <em>used_by_entity</em><big>)</big><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag.remove_from_used_by" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Removes the <tt class="docutils literal"><span class="pre">used_by_entity</span></tt> from the <tt class="xref py py-attr docutils literal"><span class="pre">TagModel.used_by</span></tt>
|
||
|
|
subscribers set. If the <tt class="docutils literal"><span class="pre">used_by_entity</span></tt> is not using this tag, then
|
||
|
|
this becomes a no-op. To invoke this method, you need modify
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">TagModel.used_by</span></tt> privilege on the tag.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>tag_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The identifier of the input tag.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.cis.tagging.Tag</span></tt>.</li>
|
||
|
|
<li><strong>used_by_entity</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The name of the user to be removed from the
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">TagModel.used_by</span></tt> <tt class="xref py py-class docutils literal"><span class="pre">set</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the tag for the given <tt class="docutils literal"><span class="pre">tag_id</span></tt> does not exist in the system.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have the privilege to remove an entity from the
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">TagModel.used_by</span></tt> field.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.cis.tagging_client.Tag.revoke_propagating_permissions">
|
||
|
|
<tt class="descclassname">Tag.</tt><tt class="descname">revoke_propagating_permissions</tt><big>(</big><em>tag_id</em><big>)</big><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag.revoke_propagating_permissions" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Revokes all propagating permissions on the given tag. You should then
|
||
|
|
attach a direct permission with tagging privileges on the given tag. To
|
||
|
|
invoke this method, you need tag related privileges (direct or
|
||
|
|
propagating) on the concerned tag.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>tag_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The identifier of the input tag.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.cis.tagging.Tag</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the tag for the given <tt class="docutils literal"><span class="pre">tag_id</span></tt> does not exist in the system.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have the privilege to revoke propagating permissions
|
||
|
|
on the tag.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.cis.tagging_client.Tag.update">
|
||
|
|
<tt class="descclassname">Tag.</tt><tt class="descname">update</tt><big>(</big><em>tag_id</em>, <em>update_spec</em><big>)</big><a class="headerlink" href="#com.vmware.cis.tagging_client.Tag.update" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Updates an existing tag. To invoke this method, you need the edit
|
||
|
|
privilege on the tag.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>tag_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The identifier of the input tag.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.cis.tagging.Tag</span></tt>.</li>
|
||
|
|
<li><strong>update_spec</strong> (<a class="reference internal" href="#com.vmware.cis.tagging_client.Tag.UpdateSpec" title="com.vmware.cis.tagging_client.Tag.UpdateSpec"><tt class="xref py py-class docutils literal"><span class="pre">Tag.UpdateSpec</span></tt></a>) – Specification to update the tag.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></tt>
|
||
|
|
if the <tt class="xref py py-attr docutils literal"><span class="pre">Tag.UpdateSpec.name</span></tt> provided in the <tt class="docutils literal"><span class="pre">update_spec</span></tt>
|
||
|
|
is the name of an already existing tag in the same category.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt>
|
||
|
|
if any of the input information in the <tt class="docutils literal"><span class="pre">update_spec</span></tt> is invalid.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the tag for the given <tt class="docutils literal"><span class="pre">tag_id</span></tt> does not exist in the system.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have the privilege to update the tag.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.cis.tagging_client.TagAssociation">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.cis.tagging_client.</tt><tt class="descname">TagAssociation</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">TagAssociation</span></tt> class provides methods to attach, detach, and query
|
||
|
|
tags.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.cis.tagging_client.TagAssociation.BatchResult">
|
||
|
|
<em class="property">class </em><tt class="descname">BatchResult</tt><big>(</big><em>success=None</em>, <em>error_messages=None</em><big>)</big><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.BatchResult" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">TagAssociation.BatchResult</span></tt> class describes the result of performing
|
||
|
|
the same method on several tags or objects in a single invocation.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>success</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – This is true if the batch method completed without any errors.
|
||
|
|
Otherwise it is false and all or some methods have failed.</li>
|
||
|
|
<li><strong>error_messages</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></tt></a>) – The <tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of error messages.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.cis.tagging_client.TagAssociation.ObjectToTags">
|
||
|
|
<em class="property">class </em><tt class="descclassname">TagAssociation.</tt><tt class="descname">ObjectToTags</tt><big>(</big><em>object_id=None</em>, <em>tag_ids=None</em><big>)</big><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.ObjectToTags" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">TagAssociation.ObjectToTags</span></tt> class describes an object and its
|
||
|
|
related tags. Use the <a class="reference internal" href="#com.vmware.cis.tagging_client.TagAssociation.list_attached_tags_on_objects" title="com.vmware.cis.tagging_client.TagAssociation.list_attached_tags_on_objects"><tt class="xref py py-func docutils literal"><span class="pre">TagAssociation.list_attached_tags_on_objects()</span></tt></a>
|
||
|
|
method to retrieve a <tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> with each element containing an object
|
||
|
|
and the tags attached to it.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>object_id</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></tt></a>) – The identifier of the object.</li>
|
||
|
|
<li><strong>tag_ids</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The identifiers of the related tags.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must contain identifiers for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.cis.tagging.Tag</span></tt>. When methods return a value of this
|
||
|
|
class as a return value, the attribute will contain identifiers for
|
||
|
|
the resource type: <tt class="docutils literal"><span class="pre">com.vmware.cis.tagging.Tag</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.cis.tagging_client.TagAssociation.TagToObjects">
|
||
|
|
<em class="property">class </em><tt class="descclassname">TagAssociation.</tt><tt class="descname">TagToObjects</tt><big>(</big><em>tag_id=None</em>, <em>object_ids=None</em><big>)</big><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.TagToObjects" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">TagAssociation.TagToObjects</span></tt> class describes a tag and its related
|
||
|
|
objects. Use the <a class="reference internal" href="#com.vmware.cis.tagging_client.TagAssociation.list_attached_objects_on_tags" title="com.vmware.cis.tagging_client.TagAssociation.list_attached_objects_on_tags"><tt class="xref py py-func docutils literal"><span class="pre">TagAssociation.list_attached_objects_on_tags()</span></tt></a>
|
||
|
|
method to retrieve a <tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> with each element containing a tag and
|
||
|
|
the objects to which it is attached.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>tag_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The 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:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.cis.tagging.Tag</span></tt>. When methods return a value of this
|
||
|
|
class as a return value, the attribute will be an identifier for
|
||
|
|
the resource type: <tt class="docutils literal"><span class="pre">com.vmware.cis.tagging.Tag</span></tt>.</li>
|
||
|
|
<li><strong>object_ids</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></tt></a>) – The identifiers of the related objects.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.cis.tagging_client.TagAssociation.attach">
|
||
|
|
<tt class="descclassname">TagAssociation.</tt><tt class="descname">attach</tt><big>(</big><em>tag_id</em>, <em>object_id</em><big>)</big><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.attach" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Attaches the given tag to the input object. The tag needs to meet the
|
||
|
|
cardinality (<tt class="xref py py-attr docutils literal"><span class="pre">CategoryModel.cardinality</span></tt>) and associability
|
||
|
|
(<tt class="xref py py-attr docutils literal"><span class="pre">CategoryModel.associable_types</span></tt>) criteria in order to be
|
||
|
|
eligible for attachment. If the tag is already attached to the object,
|
||
|
|
then this method is a no-op and an error will not be thrown. To invoke
|
||
|
|
this method, you need the attach tag privilege on the tag and the read
|
||
|
|
privilege on the object.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>tag_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The identifier of the input tag.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.cis.tagging.Tag</span></tt>.</li>
|
||
|
|
<li><strong>object_id</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></tt></a>) – The identifier of the input object.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the tag for the given <tt class="docutils literal"><span class="pre">tag_id</span></tt> does not exist in the system.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt>
|
||
|
|
if the input tag is not eligible to be attached to this object or
|
||
|
|
if the <tt class="docutils literal"><span class="pre">object_id</span></tt> is not valid.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have the privilege to attach the tag or do not have
|
||
|
|
the privilege to read the object.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.cis.tagging_client.TagAssociation.attach_multiple_tags_to_object">
|
||
|
|
<tt class="descclassname">TagAssociation.</tt><tt class="descname">attach_multiple_tags_to_object</tt><big>(</big><em>object_id</em>, <em>tag_ids</em><big>)</big><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.attach_multiple_tags_to_object" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Attaches the given tags to the input object. If a tag is already
|
||
|
|
attached to the object, then the individual method is a no-op and an
|
||
|
|
error will not be added to
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">TagAssociation.BatchResult.error_messages</span></tt>. To invoke this
|
||
|
|
method, you need the read privilege on the object and the attach tag
|
||
|
|
privilege on each tag.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>object_id</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></tt></a>) – The identifier of the input object.</li>
|
||
|
|
<li><strong>tag_ids</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The identifiers of the input tags.
|
||
|
|
The parameter must contain identifiers for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.cis.tagging.Tag</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.cis.tagging_client.TagAssociation.BatchResult" title="com.vmware.cis.tagging_client.TagAssociation.BatchResult"><tt class="xref py py-class docutils literal"><span class="pre">TagAssociation.BatchResult</span></tt></a></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The outcome of the batch method and the <tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of error
|
||
|
|
messages (<tt class="xref py py-attr docutils literal"><span class="pre">TagAssociation.BatchResult.error_messages</span></tt>)
|
||
|
|
describing attachment failures.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have the privilege to read the object.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.cis.tagging_client.TagAssociation.attach_tag_to_multiple_objects">
|
||
|
|
<tt class="descclassname">TagAssociation.</tt><tt class="descname">attach_tag_to_multiple_objects</tt><big>(</big><em>tag_id</em>, <em>object_ids</em><big>)</big><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.attach_tag_to_multiple_objects" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Attaches the given tag to the input objects. If a tag is already
|
||
|
|
attached to the object, then the individual method is a no-op and an
|
||
|
|
error will not be added to
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">TagAssociation.BatchResult.error_messages</span></tt>. To invoke this
|
||
|
|
method, you need the attach tag privilege on the tag and the read
|
||
|
|
privilege on each object.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>tag_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The identifier of the input tag.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.cis.tagging.Tag</span></tt>.</li>
|
||
|
|
<li><strong>object_ids</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></tt></a>) – The identifiers of the input objects.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.cis.tagging_client.TagAssociation.BatchResult" title="com.vmware.cis.tagging_client.TagAssociation.BatchResult"><tt class="xref py py-class docutils literal"><span class="pre">TagAssociation.BatchResult</span></tt></a></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The outcome of the batch method and the <tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of error
|
||
|
|
messages (<tt class="xref py py-attr docutils literal"><span class="pre">TagAssociation.BatchResult.error_messages</span></tt>)
|
||
|
|
describing attachment failures.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the tag for the given <tt class="docutils literal"><span class="pre">tag_id</span></tt> does not exist in the system.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have the attach tag privilege on the tag.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.cis.tagging_client.TagAssociation.detach">
|
||
|
|
<tt class="descclassname">TagAssociation.</tt><tt class="descname">detach</tt><big>(</big><em>tag_id</em>, <em>object_id</em><big>)</big><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.detach" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Detaches the tag from the given object. If the tag is already removed
|
||
|
|
from the object, then this method is a no-op and an error will not be
|
||
|
|
thrown. To invoke this method, you need the attach tag privilege on the
|
||
|
|
tag and the read privilege on the object.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>tag_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The identifier of the input tag.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.cis.tagging.Tag</span></tt>.</li>
|
||
|
|
<li><strong>object_id</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></tt></a>) – The identifier of the input object.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the tag for the given <tt class="docutils literal"><span class="pre">tag_id</span></tt> does not exist in the system.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have the privilege to detach the tag or do not have
|
||
|
|
the privilege to read the given object.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.cis.tagging_client.TagAssociation.detach_multiple_tags_from_object">
|
||
|
|
<tt class="descclassname">TagAssociation.</tt><tt class="descname">detach_multiple_tags_from_object</tt><big>(</big><em>object_id</em>, <em>tag_ids</em><big>)</big><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.detach_multiple_tags_from_object" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Detaches the given tags from the input object. If a tag is already
|
||
|
|
removed from the object, then the individual method is a no-op and an
|
||
|
|
error will not be added to
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">TagAssociation.BatchResult.error_messages</span></tt>. To invoke this
|
||
|
|
method, you need the read privilege on the object and the attach tag
|
||
|
|
privilege each tag.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>object_id</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></tt></a>) – The identifier of the input object.</li>
|
||
|
|
<li><strong>tag_ids</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The identifiers of the input tags.
|
||
|
|
The parameter must contain identifiers for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.cis.tagging.Tag</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.cis.tagging_client.TagAssociation.BatchResult" title="com.vmware.cis.tagging_client.TagAssociation.BatchResult"><tt class="xref py py-class docutils literal"><span class="pre">TagAssociation.BatchResult</span></tt></a></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The outcome of the batch method and the <tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of error
|
||
|
|
messages (<tt class="xref py py-attr docutils literal"><span class="pre">TagAssociation.BatchResult.error_messages</span></tt>)
|
||
|
|
describing detachment failures.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have the privilege to read the object.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.cis.tagging_client.TagAssociation.detach_tag_from_multiple_objects">
|
||
|
|
<tt class="descclassname">TagAssociation.</tt><tt class="descname">detach_tag_from_multiple_objects</tt><big>(</big><em>tag_id</em>, <em>object_ids</em><big>)</big><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.detach_tag_from_multiple_objects" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Detaches the given tag from the input objects. If a tag is already
|
||
|
|
removed from the object, then the individual method is a no-op and an
|
||
|
|
error will not be added to
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">TagAssociation.BatchResult.error_messages</span></tt>. To invoke this
|
||
|
|
method, you need the attach tag privilege on the tag and the read
|
||
|
|
privilege on each object.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>tag_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The identifier of the input tag.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.cis.tagging.Tag</span></tt>.</li>
|
||
|
|
<li><strong>object_ids</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></tt></a>) – The identifiers of the input objects.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.cis.tagging_client.TagAssociation.BatchResult" title="com.vmware.cis.tagging_client.TagAssociation.BatchResult"><tt class="xref py py-class docutils literal"><span class="pre">TagAssociation.BatchResult</span></tt></a></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The outcome of the batch method and the <tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of error
|
||
|
|
messages (<tt class="xref py py-attr docutils literal"><span class="pre">TagAssociation.BatchResult.error_messages</span></tt>)
|
||
|
|
describing detachment failures.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the tag for the given tag does not exist in the system.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have the attach tag privilege on the tag.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.cis.tagging_client.TagAssociation.list_attachable_tags">
|
||
|
|
<tt class="descclassname">TagAssociation.</tt><tt class="descname">list_attachable_tags</tt><big>(</big><em>object_id</em><big>)</big><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.list_attachable_tags" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Fetches the <tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of attachable tags for the given object,
|
||
|
|
omitting the tags that have already been attached. Criteria for
|
||
|
|
attachability is calculated based on tagging cardinality
|
||
|
|
(<tt class="xref py py-attr docutils literal"><span class="pre">CategoryModel.cardinality</span></tt>) and associability
|
||
|
|
(<tt class="xref py py-attr docutils literal"><span class="pre">CategoryModel.associable_types</span></tt>) constructs. To invoke this
|
||
|
|
method, you need the read privilege on the input object. The
|
||
|
|
<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> will only contain those tags for which you have read
|
||
|
|
privileges.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>object_id</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></tt></a>) – The identifier of the input object.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The <tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of tag identifiers that are eligible to be
|
||
|
|
attached to the given object.
|
||
|
|
The return value will contain identifiers for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.cis.tagging.Tag</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have the privilege to read the object.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.cis.tagging_client.TagAssociation.list_attached_objects">
|
||
|
|
<tt class="descclassname">TagAssociation.</tt><tt class="descname">list_attached_objects</tt><big>(</big><em>tag_id</em><big>)</big><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.list_attached_objects" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Fetches the <tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> 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>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>tag_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The identifier of the input tag.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.cis.tagging.Tag</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The <tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of attached object identifiers.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if the tag for the given <tt class="docutils literal"><span class="pre">tag_id</span></tt> does not exist in the system.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have the privilege to read the tag.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.cis.tagging_client.TagAssociation.list_attached_objects_on_tags">
|
||
|
|
<tt class="descclassname">TagAssociation.</tt><tt class="descname">list_attached_objects_on_tags</tt><big>(</big><em>tag_ids</em><big>)</big><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.list_attached_objects_on_tags" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Fetches the <tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="#com.vmware.cis.tagging_client.TagAssociation.TagToObjects" title="com.vmware.cis.tagging_client.TagAssociation.TagToObjects"><tt class="xref py py-class docutils literal"><span class="pre">TagAssociation.TagToObjects</span></tt></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 <tt class="xref py py-attr docutils literal"><span class="pre">TagAssociation.TagToObjects.object_ids</span></tt> will only
|
||
|
|
contain those objects for which you have the read privilege.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>tag_ids</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The identifiers of the input tags.
|
||
|
|
The parameter must contain identifiers for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.cis.tagging.Tag</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="#com.vmware.cis.tagging_client.TagAssociation.TagToObjects" title="com.vmware.cis.tagging_client.TagAssociation.TagToObjects"><tt class="xref py py-class docutils literal"><span class="pre">TagAssociation.TagToObjects</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The <tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of the tag identifiers to all object identifiers
|
||
|
|
that each tag is attached to.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.cis.tagging_client.TagAssociation.list_attached_tags">
|
||
|
|
<tt class="descclassname">TagAssociation.</tt><tt class="descname">list_attached_tags</tt><big>(</big><em>object_id</em><big>)</big><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.list_attached_tags" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Fetches the <tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of tags attached to the given object. To
|
||
|
|
invoke this method, you need the read privilege on the input object.
|
||
|
|
The <tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> will only contain those tags for which you have the
|
||
|
|
read privileges.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>object_id</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></tt></a>) – The identifier of the input object.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The <tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of all tag identifiers that correspond to the
|
||
|
|
tags attached to the given object.
|
||
|
|
The return value will contain identifiers for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.cis.tagging.Tag</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt>
|
||
|
|
if you do not have the privilege to read the object.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.cis.tagging_client.TagAssociation.list_attached_tags_on_objects">
|
||
|
|
<tt class="descclassname">TagAssociation.</tt><tt class="descname">list_attached_tags_on_objects</tt><big>(</big><em>object_ids</em><big>)</big><a class="headerlink" href="#com.vmware.cis.tagging_client.TagAssociation.list_attached_tags_on_objects" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Fetches the <tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="#com.vmware.cis.tagging_client.TagAssociation.ObjectToTags" title="com.vmware.cis.tagging_client.TagAssociation.ObjectToTags"><tt class="xref py py-class docutils literal"><span class="pre">TagAssociation.ObjectToTags</span></tt></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 <tt class="xref py py-attr docutils literal"><span class="pre">TagAssociation.ObjectToTags.tag_ids</span></tt> will only
|
||
|
|
contain those tags for which you have the read privilege.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>object_ids</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></tt></a>) – The identifiers of the input objects.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="#com.vmware.cis.tagging_client.TagAssociation.ObjectToTags" title="com.vmware.cis.tagging_client.TagAssociation.ObjectToTags"><tt class="xref py py-class docutils literal"><span class="pre">TagAssociation.ObjectToTags</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The <tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of the object identifiers to all tag identifiers
|
||
|
|
that are attached to that object.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.cis.tagging_client.TagModel">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.cis.tagging_client.</tt><tt class="descname">TagModel</tt><big>(</big><em>id=None</em>, <em>category_id=None</em>, <em>name=None</em>, <em>description=None</em>, <em>used_by=None</em><big>)</big><a class="headerlink" href="#com.vmware.cis.tagging_client.TagModel" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">TagModel</span></tt> class defines a tag that can be attached to vSphere
|
||
|
|
objects.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – 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:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.cis.tagging.Tag</span></tt>. When methods return a value of this
|
||
|
|
class as a return value, the attribute will be an identifier for
|
||
|
|
the resource type: <tt class="docutils literal"><span class="pre">com.vmware.cis.tagging.Tag</span></tt>.</li>
|
||
|
|
<li><strong>category_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – 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:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.cis.tagging.Category</span></tt>. When methods return a value of
|
||
|
|
this class as a return value, the attribute will be an identifier
|
||
|
|
for the resource type: <tt class="docutils literal"><span class="pre">com.vmware.cis.tagging.Category</span></tt>.</li>
|
||
|
|
<li><strong>name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The display name of the tag.</li>
|
||
|
|
<li><strong>description</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The description of the tag.</li>
|
||
|
|
<li><strong>used_by</strong> (<tt class="xref py py-class docutils literal"><span class="pre">set</span></tt> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The <tt class="xref py py-class docutils literal"><span class="pre">set</span></tt> 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
|
||
|
|
<tt class="xref py py-class docutils literal"><span class="pre">set</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="section" id="module-com.vmware.cis">
|
||
|
|
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-com.vmware.cis" title="Permalink to this headline">¶</a></h2>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="sphinxsidebar">
|
||
|
|
<div class="sphinxsidebarwrapper">
|
||
|
|
<h3><a href="index.html">Table Of Contents</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li><a class="reference internal" href="#">com.vmware.cis package</a><ul>
|
||
|
|
<li><a class="reference internal" href="#submodules">Submodules</a></li>
|
||
|
|
<li><a class="reference internal" href="#module-com.vmware.cis.tagging_client">com.vmware.cis.tagging_client module</a></li>
|
||
|
|
<li><a class="reference internal" href="#module-com.vmware.cis">Module contents</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<h4>Previous topic</h4>
|
||
|
|
<p class="topless"><a href="com.vmware.appliance.techpreview.networking.firewall.html"
|
||
|
|
title="previous chapter">com.vmware.appliance.techpreview.networking.firewall package</a></p>
|
||
|
|
<h4>Next topic</h4>
|
||
|
|
<p class="topless"><a href="com.vmware.content.html"
|
||
|
|
title="next chapter">com.vmware.content package</a></p>
|
||
|
|
<h3>This Page</h3>
|
||
|
|
<ul class="this-page-menu">
|
||
|
|
<li><a href="_sources/com.vmware.cis.txt"
|
||
|
|
rel="nofollow">Show Source</a></li>
|
||
|
|
</ul>
|
||
|
|
<div id="searchbox" style="display: none">
|
||
|
|
<h3>Quick search</h3>
|
||
|
|
<form class="search" action="search.html" method="get">
|
||
|
|
<input type="text" name="q" />
|
||
|
|
<input type="submit" value="Go" />
|
||
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
||
|
|
<input type="hidden" name="area" value="default" />
|
||
|
|
</form>
|
||
|
|
<p class="searchtip" style="font-size: 90%">
|
||
|
|
Enter search terms or a module, class or function name.
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="clearer"></div>
|
||
|
|
</div>
|
||
|
|
<div class="related">
|
||
|
|
<h3>Navigation</h3>
|
||
|
|
<ul>
|
||
|
|
<li class="right" style="margin-right: 10px">
|
||
|
|
<a href="genindex.html" title="General Index"
|
||
|
|
>index</a></li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="py-modindex.html" title="Python Module Index"
|
||
|
|
>modules</a> |</li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="com.vmware.content.html" title="com.vmware.content package"
|
||
|
|
>next</a> |</li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="com.vmware.appliance.techpreview.networking.firewall.html" title="com.vmware.appliance.techpreview.networking.firewall package"
|
||
|
|
>previous</a> |</li>
|
||
|
|
<li><a href="index.html">vSphere Automation SDK for Python 6.6.1 documentation</a> »</li>
|
||
|
|
<li><a href="com.html" >com package</a> »</li>
|
||
|
|
<li><a href="com.vmware.html" >com.vmware package</a> »</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div class="footer">
|
||
|
|
© Copyright 2014-2017, VMware, Inc. All rights reserved.
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|