mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-22 09:39:58 -05:00
721 lines
55 KiB
HTML
721 lines
55 KiB
HTML
|
||
|
||
<!DOCTYPE html>
|
||
<html class="writer-html5" lang="en" >
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
|
||
<title>com.vmware.vcenter.compute package — vSphere Automation SDK for Python. 8.0.0.1 documentation</title>
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<!--[if lt IE 9]>
|
||
<script src="_static/js/html5shiv.min.js"></script>
|
||
<![endif]-->
|
||
|
||
|
||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||
<script src="_static/jquery.js"></script>
|
||
<script src="_static/underscore.js"></script>
|
||
<script src="_static/doctools.js"></script>
|
||
|
||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||
|
||
|
||
<link rel="index" title="Index" href="genindex.html" />
|
||
<link rel="search" title="Search" href="search.html" />
|
||
<link rel="next" title="com.vmware.vcenter.compute.policies package" href="com.vmware.vcenter.compute.policies.html" />
|
||
<link rel="prev" title="com.vmware.vcenter.certificate_management package" href="com.vmware.vcenter.certificate_management.html" />
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav">
|
||
|
||
|
||
<div class="wy-grid-for-nav">
|
||
|
||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
<div class="wy-side-scroll">
|
||
<div class="wy-side-nav-search" >
|
||
|
||
|
||
|
||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python.
|
||
|
||
|
||
|
||
</a>
|
||
|
||
|
||
|
||
|
||
<div class="version">
|
||
8.0.0.1
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||
<input type="text" name="q" placeholder="Search docs" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
|
||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<p class="caption"><span class="caption-text">Contents:</span></p>
|
||
<ul class="current">
|
||
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
|
||
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
|
||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="vmware.html">vmware package</a></li>
|
||
</ul>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||
|
||
|
||
<nav class="wy-nav-top" aria-label="top navigation">
|
||
|
||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
<a href="index.html">vSphere Automation SDK for Python.</a>
|
||
|
||
</nav>
|
||
|
||
|
||
<div class="wy-nav-content">
|
||
|
||
<div class="rst-content">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||
|
||
<ul class="wy-breadcrumbs">
|
||
|
||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||
|
||
<li><a href="com.html">com package</a> »</li>
|
||
|
||
<li><a href="com.vmware.html">com.vmware package</a> »</li>
|
||
|
||
<li><a href="com.vmware.vcenter.html">com.vmware.vcenter package</a> »</li>
|
||
|
||
<li>com.vmware.vcenter.compute package</li>
|
||
|
||
|
||
<li class="wy-breadcrumbs-aside">
|
||
|
||
|
||
<a href="_sources/com.vmware.vcenter.compute.rst.txt" rel="nofollow"> View page source</a>
|
||
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
|
||
<hr/>
|
||
</div>
|
||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
<div itemprop="articleBody">
|
||
|
||
<div class="section" id="module-com.vmware.vcenter.compute">
|
||
<span id="com-vmware-vcenter-compute-package"></span><h1>com.vmware.vcenter.compute package<a class="headerlink" href="#module-com.vmware.vcenter.compute" title="Permalink to this headline">¶</a></h1>
|
||
<div class="section" id="subpackages">
|
||
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
|
||
<div class="toctree-wrapper compound">
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vcenter.compute.policies.html">com.vmware.vcenter.compute.policies package</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.compute.policies.html#subpackages">Subpackages</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html">com.vmware.vcenter.compute.policies.capabilities package</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#subpackages">Subpackages</a><ul>
|
||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.vm.html">com.vmware.vcenter.compute.policies.capabilities.vm package</a><ul>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.vm.html#subpackages">Subpackages</a><ul>
|
||
<li class="toctree-l7"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.html">com.vmware.vcenter.compute.policies.capabilities.vm.evacuation package</a><ul>
|
||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.html#module-com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client">com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l7"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.vm.placement.html">com.vmware.vcenter.compute.policies.capabilities.vm.placement package</a><ul>
|
||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.vm.placement.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.vm.placement.html#module-com.vmware.vcenter.compute.policies.capabilities.vm.placement.anti_affinity_with_vcls_client">com.vmware.vcenter.compute.policies.capabilities.vm.placement.anti_affinity_with_vcls_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.vm.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.vm.html#module-com.vmware.vcenter.compute.policies.capabilities.vm.placement_client">com.vmware.vcenter.compute.policies.capabilities.vm.placement_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities_client">com.vmware.vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client">com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client">com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client">com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client">com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client">com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.compute.policies.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.compute.policies.html#module-com.vmware.vcenter.compute.policies.capabilities_client">com.vmware.vcenter.compute.policies.capabilities_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<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.vcenter.compute.policies_client">
|
||
<span id="com-vmware-vcenter-compute-policies-client-module"></span><h2>com.vmware.vcenter.compute.policies_client module<a class="headerlink" href="#module-com.vmware.vcenter.compute.policies_client" title="Permalink to this headline">¶</a></h2>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies_client</span></code> module provides classes for
|
||
managing compute policies.</p>
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vcenter.compute.policies_client.Capabilities">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.compute.policies_client.</span></code><code class="sig-name descname"><span class="pre">Capabilities</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.Capabilities" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Capabilities</span></code> class provides methods to manage compute policy
|
||
capabilities. The description of the capability provides information about
|
||
the intent of a policy based on this capability. A capability provides a
|
||
type to create a policy (see
|
||
<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.compute_client.Policies.create" title="com.vmware.vcenter.compute_client.Policies.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute_client.Policies.create()</span></code></a>). A capability
|
||
also provides a type that describes the information returned when
|
||
retrieving information about a policy (see
|
||
<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.compute_client.Policies.get" title="com.vmware.vcenter.compute_client.Policies.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute_client.Policies.get()</span></code></a>).</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vcenter.compute.policies_client.Capabilities.Info">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">create_spec_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">info_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.Capabilities.Info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Capabilities.Info</span></code> class contains information about a compute policy
|
||
capability.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the capability.</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Description of the capability.</p></li>
|
||
<li><p><strong>create_spec_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the class used to create a policy based on this
|
||
capability. See
|
||
<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.compute_client.Policies.create" title="com.vmware.vcenter.compute_client.Policies.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute_client.Policies.create()</span></code></a>.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.structure</span></code>. When methods return a value of this
|
||
class as a return value, the attribute will be an identifier for
|
||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.structure</span></code>.</p></li>
|
||
<li><p><strong>info_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the class returned when retrieving information about
|
||
a policy based on this capability. See
|
||
<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.compute_client.Policies.get" title="com.vmware.vcenter.compute_client.Policies.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute_client.Policies.get()</span></code></a>.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.structure</span></code>. When methods return a value of this
|
||
class as a return value, the attribute will be an identifier for
|
||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.structure</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vcenter.compute.policies_client.Capabilities.RESOURCE_TYPE">
|
||
<code class="sig-name descname"><span class="pre">RESOURCE_TYPE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.vcenter.compute.policies.Capability'</span></em><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.Capabilities.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The resource type for the compute policy capability.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vcenter.compute.policies_client.Capabilities.Summary">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Summary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">capability</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.Capabilities.Summary" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Capabilities.Summary</span></code> class contains commonly used information about
|
||
a compute policy capability.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>capability</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the capability.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.Capability</span></code>. When methods
|
||
return a value of this class as a return value, the attribute will
|
||
be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.Capability</span></code>.</p></li>
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the capability.</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Description of the capability.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="com.vmware.vcenter.compute.policies_client.Capabilities.get">
|
||
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">capability</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.Capabilities.get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns information about a specific compute policy capability.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>capability</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the capability for which information should be
|
||
retrieved.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.Capability</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.compute.policies_client.Capabilities.Info" title="com.vmware.vcenter.compute.policies_client.Capabilities.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Capabilities.Info</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Detailed information about the capability.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if a capability with this identifier does not exist.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if the user doesn’t have the required privileges.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have all of the privileges described as follows:</p>
|
||
<ul class="simple">
|
||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="com.vmware.vcenter.compute.policies_client.Capabilities.list">
|
||
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.Capabilities.list" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns information about the compute policy capabilities available in
|
||
this vCenter server.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.compute.policies_client.Capabilities.list" title="com.vmware.vcenter.compute.policies_client.Capabilities.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.compute.policies_client.Capabilities.Summary" title="com.vmware.vcenter.compute.policies_client.Capabilities.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Capabilities.Summary</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>The list of compute policy capabilities available on this vCenter
|
||
server.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if the user doesn’t have the required privileges.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have all of the privileges described as follows:</p>
|
||
<ul class="simple">
|
||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vcenter.compute.policies_client.CreateSpec">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.compute.policies_client.</span></code><code class="sig-name descname"><span class="pre">CreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">capability</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">CreateSpec</span></code> class contains common information used to create a new
|
||
policy.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>capability</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the capability this policy is based on.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.Capability</span></code>. When methods
|
||
return a value of this class as a return value, the attribute will
|
||
be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.Capability</span></code>.</p></li>
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the policy. The name needs to be unique within this vCenter
|
||
server.</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Description of the policy.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py method">
|
||
<dt id="com.vmware.vcenter.compute.policies_client.CreateSpec.capability">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">capability</span></code><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.CreateSpec.capability" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return the discriminator value</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vcenter.compute.policies_client.Info">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.compute.policies_client.</span></code><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">capability</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.Info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Info</span></code> class contains common information about a compute policy.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the policy.</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Description of the policy.</p></li>
|
||
<li><p><strong>capability</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the capability this policy is based on.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.Capability</span></code>. When methods
|
||
return a value of this class as a return value, the attribute will
|
||
be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.Capability</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py method">
|
||
<dt id="com.vmware.vcenter.compute.policies_client.Info.capability">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">capability</span></code><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.Info.capability" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return the discriminator value</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vcenter.compute.policies_client.ObjectCompliance">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.compute.policies_client.</span></code><code class="sig-name descname"><span class="pre">ObjectCompliance</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.ObjectCompliance" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">ObjectCompliance</span></code> class defines the compliance states a policy can
|
||
be in on a particular object.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <a class="reference internal" href="#com.vmware.vcenter.compute.policies_client.ObjectCompliance" title="com.vmware.vcenter.compute.policies_client.ObjectCompliance"><code class="xref py py-class docutils literal notranslate"><span class="pre">ObjectCompliance</span></code></a> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vcenter.compute.policies_client.ObjectCompliance.COMPLIANT">
|
||
<code class="sig-name descname"><span class="pre">COMPLIANT</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ObjectCompliance(string='COMPLIANT')</span></em><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.ObjectCompliance.COMPLIANT" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The policy is in compliance on the object.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vcenter.compute.policies_client.ObjectCompliance.NOT_APPLICABLE">
|
||
<code class="sig-name descname"><span class="pre">NOT_APPLICABLE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ObjectCompliance(string='NOT_APPLICABLE')</span></em><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.ObjectCompliance.NOT_APPLICABLE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The object is in a state for which the policy does not apply.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vcenter.compute.policies_client.ObjectCompliance.NOT_COMPLIANT">
|
||
<code class="sig-name descname"><span class="pre">NOT_COMPLIANT</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ObjectCompliance(string='NOT_COMPLIANT')</span></em><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.ObjectCompliance.NOT_COMPLIANT" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The policy is not in compliance on the object.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.vcenter.compute.policies_client.ObjectCompliance.UNKNOWN">
|
||
<code class="sig-name descname"><span class="pre">UNKNOWN</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ObjectCompliance(string='UNKNOWN')</span></em><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.ObjectCompliance.UNKNOWN" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The object has an unknown compliance state.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vcenter.compute.policies_client.Status">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.compute.policies_client.</span></code><code class="sig-name descname"><span class="pre">Status</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.Status" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Status</span></code> class describes the current status of a compute policy.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.vcenter.compute.policies_client.ObjectCompliance" title="com.vmware.vcenter.compute.policies_client.ObjectCompliance"><code class="xref py py-class docutils literal notranslate"><span class="pre">ObjectCompliance</span></code></a>) – The compliance status of the policy on a specified object.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vcenter.compute.policies_client.StubFactory">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.compute.policies_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||
<p>Initialize StubFactoryBase</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vcenter.compute.policies_client.TagUsage">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.compute.policies_client.</span></code><code class="sig-name descname"><span class="pre">TagUsage</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.TagUsage" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">TagUsage</span></code> class provides methods to query which tags are used by
|
||
policies.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vcenter.compute.policies_client.TagUsage.FilterSpec">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">FilterSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">policies</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tags</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tag_types</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.TagUsage.FilterSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">TagUsage.FilterSpec</span></code> class contains attributes used to filter the
|
||
results when listing the tags used by policies as available in this vCenter
|
||
server (see <a class="reference internal" href="#com.vmware.vcenter.compute.policies_client.TagUsage.list" title="com.vmware.vcenter.compute.policies_client.TagUsage.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">TagUsage.list()</span></code></a>). If multiple attributes are specified,
|
||
only the tags used by policies that match an element of each attribute
|
||
match the filter.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>policies</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifiers that compute policies must have to match the filter.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must contain identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.Policy</span></code>. When methods return a value
|
||
of this class as a return value, the attribute will contain
|
||
identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.Policy</span></code>.
|
||
If None or empty, then tags used by any policy match this filter.</p></li>
|
||
<li><p><strong>tags</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifiers that tags must have to match the filter.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must contain identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag</span></code>. When methods return a value of this
|
||
class as a return value, the attribute will contain identifiers for
|
||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag</span></code>.
|
||
If None or empty, then tags with any tag identifier match this
|
||
filter.</p></li>
|
||
<li><p><strong>tag_types</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifiers that tag types must have to match the filter.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must contain identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.resource</span></code>. When methods return a value of this
|
||
class as a return value, the attribute will contain identifiers for
|
||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.resource</span></code>.
|
||
If None or empty, then tags of any type match this filter.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.vcenter.compute.policies_client.TagUsage.Summary">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Summary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tag_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tag</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tag_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">category_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.TagUsage.Summary" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">TagUsage.Summary</span></code> class contains common information about a tag used
|
||
by a policy.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the policy that uses the tag indicated by
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">TagUsage.Summary.tag</span></code>.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.Policy</span></code>. When methods return a value
|
||
of this class as a return value, the attribute will be an
|
||
identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.Policy</span></code>.</p></li>
|
||
<li><p><strong>tag_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the tag type used by the policy indicated by
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">TagUsage.Summary.policy</span></code>.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.resource</span></code>. When methods return a value of this
|
||
class as a return value, the attribute will be an identifier for
|
||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.resource</span></code>.</p></li>
|
||
<li><p><strong>tag</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the tag used by the policy indicated by
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">TagUsage.Summary.policy</span></code>.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute <code class="docutils literal notranslate"><span class="pre">tagType</span></code> must contain the actual resource type. When
|
||
methods return a value of this class as a return value, the
|
||
attribute <code class="docutils literal notranslate"><span class="pre">tagType</span></code> will contain the actual resource type.</p></li>
|
||
<li><p><strong>tag_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the tag used by the policy indicated by
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">TagUsage.Summary.policy</span></code>.</p></li>
|
||
<li><p><strong>category_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the category that has <code class="xref py py-attr docutils literal notranslate"><span class="pre">TagUsage.Summary.tag</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="com.vmware.vcenter.compute.policies_client.TagUsage.list">
|
||
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute.policies_client.TagUsage.list" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns information about the tags used by policies available in this
|
||
vCenter server matching the <a class="reference internal" href="#com.vmware.vcenter.compute.policies_client.TagUsage.FilterSpec" title="com.vmware.vcenter.compute.policies_client.TagUsage.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">TagUsage.FilterSpec</span></code></a>.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter.compute.policies_client.TagUsage.FilterSpec" title="com.vmware.vcenter.compute.policies_client.TagUsage.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">TagUsage.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Specification for matching tags used by policies.
|
||
If None, the behavior is equivalent to a
|
||
<a class="reference internal" href="#com.vmware.vcenter.compute.policies_client.TagUsage.FilterSpec" title="com.vmware.vcenter.compute.policies_client.TagUsage.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">TagUsage.FilterSpec</span></code></a> with all attributes None, which means
|
||
all tags used by policies match the filter.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.compute.policies_client.TagUsage.list" title="com.vmware.vcenter.compute.policies_client.TagUsage.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.compute.policies_client.TagUsage.Summary" title="com.vmware.vcenter.compute.policies_client.TagUsage.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">TagUsage.Summary</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>The list of tags used by policies available on this vCenter server
|
||
matching the <a class="reference internal" href="#com.vmware.vcenter.compute.policies_client.TagUsage.FilterSpec" title="com.vmware.vcenter.compute.policies_client.TagUsage.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">TagUsage.FilterSpec</span></code></a>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if the user doesn’t have the required privileges.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have all of the privileges described as follows:</p>
|
||
<ul class="simple">
|
||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<footer>
|
||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||
<a href="com.vmware.vcenter.compute.policies.html" class="btn btn-neutral float-right" title="com.vmware.vcenter.compute.policies package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||
<a href="com.vmware.vcenter.certificate_management.html" class="btn btn-neutral float-left" title="com.vmware.vcenter.certificate_management package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||
</div>
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>
|
||
© Copyright 2022, VMware, Inc..
|
||
|
||
</p>
|
||
</div>
|
||
|
||
|
||
|
||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||
|
||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||
|
||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
||
</footer>
|
||
</div>
|
||
</div>
|
||
|
||
</section>
|
||
|
||
</div>
|
||
|
||
|
||
<script type="text/javascript">
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</body>
|
||
</html> |