mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-25 02:39:59 -05:00
1309 lines
112 KiB
HTML
1309 lines
112 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.appliance.vcenter.settings package — vSphere Automation SDK for Python. 7.0.2.0 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.appliance.vcenter.settings.v1 package" href="com.vmware.appliance.vcenter.settings.v1.html" />
|
||
<link rel="prev" title="com.vmware.appliance.vcenter package" href="com.vmware.appliance.vcenter.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">
|
||
7.0.2.0
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||
<input type="text" name="q" placeholder="Search docs" />
|
||
<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.appliance.html">com.vmware.appliance package</a> »</li>
|
||
|
||
<li><a href="com.vmware.appliance.vcenter.html">com.vmware.appliance.vcenter package</a> »</li>
|
||
|
||
<li>com.vmware.appliance.vcenter.settings package</li>
|
||
|
||
|
||
<li class="wy-breadcrumbs-aside">
|
||
|
||
|
||
<a href="_sources/com.vmware.appliance.vcenter.settings.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.appliance.vcenter.settings">
|
||
<span id="com-vmware-appliance-vcenter-settings-package"></span><h1>com.vmware.appliance.vcenter.settings package<a class="headerlink" href="#module-com.vmware.appliance.vcenter.settings" 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.appliance.vcenter.settings.v1.html">com.vmware.appliance.vcenter.settings.v1 package</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.html#subpackages">Subpackages</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.html">com.vmware.appliance.vcenter.settings.v1.config package</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.html#subpackages">Subpackages</a><ul>
|
||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.html">com.vmware.appliance.vcenter.settings.v1.config.components package</a><ul>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.html#subpackages">Subpackages</a><ul>
|
||
<li class="toctree-l7"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html">com.vmware.appliance.vcenter.settings.v1.config.components.inventory package</a><ul>
|
||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#subpackages">Subpackages</a><ul>
|
||
<li class="toctree-l9"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster package</a><ul>
|
||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client module</a></li>
|
||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client module</a></li>
|
||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client module</a></li>
|
||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter_client module</a></li>
|
||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client module</a></li>
|
||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client module</a></li>
|
||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.host_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.host_client module</a></li>
|
||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network_client module</a></li>
|
||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client module</a></li>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client">com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client module</a></li>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.html#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.html#module-com.vmware.appliance.vcenter.settings.v1.config.components_client">com.vmware.appliance.vcenter.settings.v1.config.components_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.html#module-com.vmware.appliance.vcenter.settings.v1.config_client">com.vmware.appliance.vcenter.settings.v1.config_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.appliance.vcenter.settings.v1_client">
|
||
<span id="com-vmware-appliance-vcenter-settings-v1-client-module"></span><h2>com.vmware.appliance.vcenter.settings.v1_client module<a class="headerlink" href="#module-com.vmware.appliance.vcenter.settings.v1_client" title="Permalink to this headline">¶</a></h2>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1_client</span></code> module provides classes
|
||
to manage the ConfigManagement.</p>
|
||
<dl class="py class">
|
||
<dt id="com.vmware.appliance.vcenter.settings.v1_client.ComplianceResult">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1_client.</span></code><code class="sig-name descname"><span class="pre">ComplianceResult</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">diff_results</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.appliance.vcenter.settings.v1_client.ComplianceResult" 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">ComplianceResult</span></code> class defines the information about scan results.
|
||
<strong>Warning:</strong> This class is available as Technology Preview. These are early
|
||
access APIs provided to test, automate and provide feedback on the feature.
|
||
Since this can change based on feedback, VMware does not guarantee
|
||
backwards compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable to
|
||
specific environments.</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>diff_results</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1_client.DiffResult" title="com.vmware.appliance.vcenter.settings.v1_client.DiffResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">DiffResult</span></code></a>) – Map of property value differences between current software state
|
||
and working profile. <strong>Warning:</strong> This attribute is available as
|
||
Technology Preview. These are early access APIs provided to test,
|
||
automate and provide feedback on the feature. Since this can change
|
||
based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable
|
||
to specific environments.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.appliance.vcenter.settings.v1_client.Config">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1_client.</span></code><code class="sig-name descname"><span class="pre">Config</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.appliance.vcenter.settings.v1_client.Config" 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">Config</span></code> class provides methods to manage desired configuration
|
||
specification of vCenter.</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.appliance.vcenter.settings.v1_client.Config.CreateSpec">
|
||
<em class="property"><span class="pre">class</span> </em><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">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">desired_state</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.appliance.vcenter.settings.v1_client.Config.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">Config.CreateSpec</span></code> class contains the specification required to
|
||
create a profile in vCenter. the spec contains attributes that describe
|
||
information about the profile. <strong>Warning:</strong> This class is available as
|
||
Technology Preview. These are early access APIs provided to test, automate
|
||
and provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and recommends
|
||
against using them in production environments. Some Technology Preview APIs
|
||
might only be applicable to specific environments.</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 profile. <strong>Warning:</strong> This attribute is available as
|
||
Technology Preview. These are early access APIs provided to test,
|
||
automate and provide feedback on the feature. Since this can change
|
||
based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable
|
||
to specific environments.</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Description of the profile. <strong>Warning:</strong> This attribute is
|
||
available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature.
|
||
Since this can change based on feedback, VMware does not guarantee
|
||
backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.
|
||
If None, the description will be empty.</p></li>
|
||
<li><p><strong>desired_state</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1_client.DesiredState" title="com.vmware.appliance.vcenter.settings.v1_client.DesiredState"><code class="xref py py-class docutils literal notranslate"><span class="pre">DesiredState</span></code></a>) – Defines the desired state. <strong>Warning:</strong> This attribute is available
|
||
as Technology Preview. These are early access APIs provided to
|
||
test, automate and provide feedback on the feature. Since this can
|
||
change based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable
|
||
to specific environments.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.appliance.vcenter.settings.v1_client.Config.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">profile</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">version</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">creation_time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">owner</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">desired_state</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.appliance.vcenter.settings.v1_client.Config.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">Config.Info</span></code> class represents information about the config profile.
|
||
the spec contains attributes that describe information about the profile.
|
||
<strong>Warning:</strong> This class is available as Technology Preview. These are early
|
||
access APIs provided to test, automate and provide feedback on the feature.
|
||
Since this can change based on feedback, VMware does not guarantee
|
||
backwards compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable to
|
||
specific environments.</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>profile</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifier of the profile. <strong>Warning:</strong> This attribute is
|
||
available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature.
|
||
Since this can change based on feedback, VMware does not guarantee
|
||
backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.
|
||
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.appliance.vcenter.settings.v1.config.profile</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.appliance.vcenter.settings.v1.config.profile</span></code>.</p></li>
|
||
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Version of the profile. <strong>Warning:</strong> This attribute is available as
|
||
Technology Preview. These are early access APIs provided to test,
|
||
automate and provide feedback on the feature. Since this can change
|
||
based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable
|
||
to specific environments.
|
||
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.appliance.vcenter.settings.v1.config.version</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.appliance.vcenter.settings.v1.config.version</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 profile. <strong>Warning:</strong> This attribute is available as
|
||
Technology Preview. These are early access APIs provided to test,
|
||
automate and provide feedback on the feature. Since this can change
|
||
based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable
|
||
to specific environments.</p></li>
|
||
<li><p><strong>creation_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Creation time of the profile. <strong>Warning:</strong> This attribute is
|
||
available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature.
|
||
Since this can change based on feedback, VMware does not guarantee
|
||
backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p></li>
|
||
<li><p><strong>owner</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Owner of the profile, the one who created. <strong>Warning:</strong> This
|
||
attribute is available as Technology Preview. These are early
|
||
access APIs provided to test, automate and provide feedback on the
|
||
feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them
|
||
in production environments. Some Technology Preview APIs might only
|
||
be applicable to specific environments.</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Custom description provided by the user. <strong>Warning:</strong> This
|
||
attribute is available as Technology Preview. These are early
|
||
access APIs provided to test, automate and provide feedback on the
|
||
feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them
|
||
in production environments. Some Technology Preview APIs might only
|
||
be applicable to specific environments.
|
||
If None description will be empty.</p></li>
|
||
<li><p><strong>desired_state</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1_client.DesiredState" title="com.vmware.appliance.vcenter.settings.v1_client.DesiredState"><code class="xref py py-class docutils literal notranslate"><span class="pre">DesiredState</span></code></a>) – The desired state. <strong>Warning:</strong> This attribute is available as
|
||
Technology Preview. These are early access APIs provided to test,
|
||
automate and provide feedback on the feature. Since this can change
|
||
based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable
|
||
to specific environments.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.appliance.vcenter.settings.v1_client.Config.ScanSpec">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ScanSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">desired_state</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.appliance.vcenter.settings.v1_client.Config.ScanSpec" 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">Config.ScanSpec</span></code> class contains the specification required for
|
||
compliance check against the vCenter current config state. <strong>Warning:</strong>
|
||
This class is available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature. Since this
|
||
can change based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production environments.
|
||
Some Technology Preview APIs might only be applicable to specific
|
||
environments.</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>message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Message for the scan. This may act as an identification for the
|
||
scan operation. <strong>Warning:</strong> This attribute is available as
|
||
Technology Preview. These are early access APIs provided to test,
|
||
automate and provide feedback on the feature. Since this can change
|
||
based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable
|
||
to specific environments.
|
||
If None, the message will be empty.</p></li>
|
||
<li><p><strong>desired_state</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1_client.DesiredState" title="com.vmware.appliance.vcenter.settings.v1_client.DesiredState"><code class="xref py py-class docutils literal notranslate"><span class="pre">DesiredState</span></code></a>) – Defines the desired state. <strong>Warning:</strong> This attribute is available
|
||
as Technology Preview. These are early access APIs provided to
|
||
test, automate and provide feedback on the feature. Since this can
|
||
change based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable
|
||
to specific environments.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="com.vmware.appliance.vcenter.settings.v1_client.Config.create">
|
||
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1_client.Config.create" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Creates a Profile. <strong>Warning:</strong> This method is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and
|
||
provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and
|
||
recommends against using them in production environments. Some
|
||
Technology Preview APIs might only be applicable to specific
|
||
environments.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1_client.Config.CreateSpec" title="com.vmware.appliance.vcenter.settings.v1_client.Config.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Config.CreateSpec</span></code></a>) – Specification of the profile to be created.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>ID of newly-created profile.
|
||
The return value will be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.profile</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
|
||
if a profile with the specified name already exists.</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.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
if the system reports an error while responding to the request.</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.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||
if any of the specified parameters are invalid.</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.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||
if the system is unable to communicate with a service to complete
|
||
the request.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the user can not be authenticated.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="com.vmware.appliance.vcenter.settings.v1_client.Config.delete">
|
||
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1_client.Config.delete" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Deletes a profile. <strong>Warning:</strong> This method is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and
|
||
provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and
|
||
recommends against using them in production environments. Some
|
||
Technology Preview APIs might only be applicable to specific
|
||
environments.</p>
|
||
<dl class="field-list simple">
|
||
<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.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
if the system reports an error while responding to the request.</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.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||
if any other operation running on the same profile.</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.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the profile is not found.</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.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||
if the system is unable to communicate service to complete the
|
||
request.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the user can not be authenticated.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="com.vmware.appliance.vcenter.settings.v1_client.Config.get">
|
||
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1_client.Config.get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns information about a profile. <strong>Warning:</strong> This method is
|
||
available as Technology Preview. These are early access APIs provided
|
||
to test, automate and provide feedback on the feature. Since this can
|
||
change based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable to
|
||
specific environments.</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.appliance.vcenter.settings.v1_client.Config.Info" title="com.vmware.appliance.vcenter.settings.v1_client.Config.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Config.Info</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>Information about the specified profile.</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.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
if the system reports an error while responding to the request.</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.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||
If given version is different than the latest one.</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.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 there is no profile or version associated with <code class="docutils literal notranslate"><span class="pre">profile</span></code> or
|
||
<code class="docutils literal notranslate"><span class="pre">version</span></code> in the system.</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.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||
if the system is unable to communicate with a service to complete
|
||
the request.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the user can not be authenticated.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="com.vmware.appliance.vcenter.settings.v1_client.Config.scan_desired_state_task">
|
||
<code class="sig-name descname"><span class="pre">scan_desired_state_task</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1_client.Config.scan_desired_state_task" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Scans all the components in the desired state against the applied
|
||
profile. result of this operation can be queried by calling the api
|
||
cis/tasks/{task-id} where the task-id is the response of this
|
||
operation. <strong>Warning:</strong> This method is available as Technology Preview.
|
||
These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback,
|
||
VMware does not guarantee backwards compatibility and recommends
|
||
against using them in production environments. Some Technology Preview
|
||
APIs might only be applicable to specific environments.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1_client.Config.ScanSpec" title="com.vmware.appliance.vcenter.settings.v1_client.Config.ScanSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Config.ScanSpec</span></code></a>) – </p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><dl class="field-list simple">
|
||
<dt class="field-odd">class</dt>
|
||
<dd class="field-odd"><p><cite>vmware.vapi.stdlib.client.task.Task</cite></p>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>Task instance</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.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
If there is unknown internal error. The accompanying error message
|
||
will give more details about the failure.</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.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||
If the service is not available.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
If the caller is not authenticated.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="com.vmware.appliance.vcenter.settings.v1_client.Config.scan_task">
|
||
<code class="sig-name descname"><span class="pre">scan_task</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">version</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1_client.Config.scan_task" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Scans all the components in the profiles against the applied profile.
|
||
result of this operation can be queried by calling the api
|
||
cis/tasks/{task-id} where the task-id is the response of this
|
||
operation. <strong>Warning:</strong> This method is available as Technology Preview.
|
||
These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback,
|
||
VMware does not guarantee backwards compatibility and recommends
|
||
against using them in production environments. Some Technology Preview
|
||
APIs might only be applicable to specific environments.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – version of the profile.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.version</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><dl class="field-list simple">
|
||
<dt class="field-odd">class</dt>
|
||
<dd class="field-odd"><p><cite>vmware.vapi.stdlib.client.task.Task</cite></p>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>Task instance</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.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
If there is unknown internal error. The accompanying error message
|
||
will give more details about the failure.</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 there is no profile associated with <code class="docutils literal notranslate"><span class="pre">profile</span></code> in the system.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||
If the service is not available.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
If the caller is not authenticated.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.appliance.vcenter.settings.v1_client.ConfigCurrent">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1_client.</span></code><code class="sig-name descname"><span class="pre">ConfigCurrent</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.appliance.vcenter.settings.v1_client.ConfigCurrent" 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">ConfigCurrent</span></code> class provides methods to get the current state of
|
||
the vCenter. <strong>Warning:</strong> This class is available as Technology Preview.
|
||
These are early access APIs provided to test, automate and provide feedback
|
||
on the feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</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 method">
|
||
<dt id="com.vmware.appliance.vcenter.settings.v1_client.ConfigCurrent.get">
|
||
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1_client.ConfigCurrent.get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns the current state of the vCenter. <strong>Warning:</strong> This method is
|
||
available as Technology Preview. These are early access APIs provided
|
||
to test, automate and provide feedback on the feature. Since this can
|
||
change based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable to
|
||
specific environments.</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.appliance.vcenter.settings.v1_client.DesiredState" title="com.vmware.appliance.vcenter.settings.v1_client.DesiredState"><code class="xref py py-class docutils literal notranslate"><span class="pre">DesiredState</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p></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.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
If there is unknown internal error. The accompanying error message
|
||
will give more details about the failure.</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.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
|
||
If the service is not available.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
If the caller is not authenticated.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.appliance.vcenter.settings.v1_client.DesiredState">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1_client.</span></code><code class="sig-name descname"><span class="pre">DesiredState</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">appliance</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">authmgmt</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">inventory</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.appliance.vcenter.settings.v1_client.DesiredState" 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">DesiredState</span></code> class defines the configuration about different
|
||
components in vCenter. <strong>Warning:</strong> This class is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback, VMware
|
||
does not guarantee backwards compatibility and recommends against using
|
||
them in production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</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>appliance</strong> (<a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.html#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.ApplianceManagement" title="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.ApplianceManagement"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.ApplianceManagement</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Appliance Management component desired spec. <strong>Warning:</strong> This
|
||
attribute is available as Technology Preview. These are early
|
||
access APIs provided to test, automate and provide feedback on the
|
||
feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them
|
||
in production environments. Some Technology Preview APIs might only
|
||
be applicable to specific environments.</p></li>
|
||
<li><p><strong>authmgmt</strong> (<a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.html#com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.AuthenticationManagement" title="com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.AuthenticationManagement"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.AuthenticationManagement</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Authentication Management component desired spec. <strong>Warning:</strong> This
|
||
attribute is available as Technology Preview. These are early
|
||
access APIs provided to test, automate and provide feedback on the
|
||
feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them
|
||
in production environments. Some Technology Preview APIs might only
|
||
be applicable to specific environments.</p></li>
|
||
<li><p><strong>inventory</strong> (<a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.html#com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.InventoryManagement" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.InventoryManagement"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.InventoryManagement</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Inventory Configurations. <strong>Warning:</strong> This attribute is available
|
||
as Technology Preview. These are early access APIs provided to
|
||
test, automate and provide feedback on the feature. Since this can
|
||
change based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable
|
||
to specific environments.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.appliance.vcenter.settings.v1_client.DiffResult">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1_client.</span></code><code class="sig-name descname"><span class="pre">DiffResult</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">current_value</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">desired_value</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</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">path</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.appliance.vcenter.settings.v1_client.DiffResult" 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">DiffResult</span></code> class defines the information about the feature
|
||
configuration. <strong>Warning:</strong> This class is available as Technology Preview.
|
||
These are early access APIs provided to test, automate and provide feedback
|
||
on the feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</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>current_value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">DataValue</span></code>) – Current property value. <strong>Warning:</strong> This attribute is available as
|
||
Technology Preview. These are early access APIs provided to test,
|
||
automate and provide feedback on the feature. Since this can change
|
||
based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable
|
||
to specific environments.</p></li>
|
||
<li><p><strong>desired_value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">DataValue</span></code>) – Desired property value. <strong>Warning:</strong> This attribute is available as
|
||
Technology Preview. These are early access APIs provided to test,
|
||
automate and provide feedback on the feature. Since this can change
|
||
based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable
|
||
to specific environments.</p></li>
|
||
<li><p><strong>category</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Category of component configuration. <strong>Warning:</strong> This attribute is
|
||
available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature.
|
||
Since this can change based on feedback, VMware does not guarantee
|
||
backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p></li>
|
||
<li><p><strong>path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Path of the component configuration. <strong>Warning:</strong> This attribute is
|
||
available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature.
|
||
Since this can change based on feedback, VMware does not guarantee
|
||
backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</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 component configuration. <strong>Warning:</strong> This
|
||
attribute is available as Technology Preview. These are early
|
||
access APIs provided to test, automate and provide feedback on the
|
||
feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them
|
||
in production environments. Some Technology Preview APIs might only
|
||
be applicable to specific environments.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.appliance.vcenter.settings.v1_client.Notification">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1_client.</span></code><code class="sig-name descname"><span class="pre">Notification</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">notification</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">time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</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">resolution</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.appliance.vcenter.settings.v1_client.Notification" 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">Notification</span></code> class contains attributes to describe any
|
||
info/warning/error messages that Tasks can raise. <strong>Warning:</strong> This class
|
||
is available as Technology Preview. These are early access APIs provided to
|
||
test, automate and provide feedback on the feature. Since this can change
|
||
based on feedback, VMware does not guarantee backwards compatibility and
|
||
recommends against using them in production environments. Some Technology
|
||
Preview APIs might only be applicable to specific environments.</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>notification</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The notification Identifier. <strong>Warning:</strong> This attribute is
|
||
available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature.
|
||
Since this can change based on feedback, VMware does not guarantee
|
||
backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.
|
||
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.appliance.vcenter.settings.v1.config.notification</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.appliance.vcenter.settings.v1.config.notification</span></code>.</p></li>
|
||
<li><p><strong>time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The time the notification was raised. <strong>Warning:</strong> This attribute
|
||
is available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature.
|
||
Since this can change based on feedback, VMware does not guarantee
|
||
backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.
|
||
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if the time information is available.</p></li>
|
||
<li><p><strong>message</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – The notification message. <strong>Warning:</strong> This attribute is available
|
||
as Technology Preview. These are early access APIs provided to
|
||
test, automate and provide feedback on the feature. Since this can
|
||
change based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable
|
||
to specific environments.</p></li>
|
||
<li><p><strong>resolution</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The resolution message, if any. <strong>Warning:</strong> This attribute is
|
||
available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature.
|
||
Since this can change based on feedback, VMware does not guarantee
|
||
backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.
|
||
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> for warnings and errors.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.appliance.vcenter.settings.v1_client.Notifications">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1_client.</span></code><code class="sig-name descname"><span class="pre">Notifications</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">info</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">warnings</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">errors</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.appliance.vcenter.settings.v1_client.Notifications" 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">Notifications</span></code> class contains info/warning/error messages that can
|
||
be reported be the task. <strong>Warning:</strong> This class is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback, VMware
|
||
does not guarantee backwards compatibility and recommends against using
|
||
them in production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</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>info</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1_client.Notification" title="com.vmware.appliance.vcenter.settings.v1_client.Notification"><code class="xref py py-class docutils literal notranslate"><span class="pre">Notification</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Info notification messages reported. <strong>Warning:</strong> This attribute is
|
||
available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature.
|
||
Since this can change based on feedback, VMware does not guarantee
|
||
backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.
|
||
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if an info was reported by the task.</p></li>
|
||
<li><p><strong>warnings</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1_client.Notification" title="com.vmware.appliance.vcenter.settings.v1_client.Notification"><code class="xref py py-class docutils literal notranslate"><span class="pre">Notification</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Warning notification messages reported. <strong>Warning:</strong> This attribute
|
||
is available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature.
|
||
Since this can change based on feedback, VMware does not guarantee
|
||
backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.
|
||
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if an warning was reported by the task.</p></li>
|
||
<li><p><strong>errors</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1_client.Notification" title="com.vmware.appliance.vcenter.settings.v1_client.Notification"><code class="xref py py-class docutils literal notranslate"><span class="pre">Notification</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Error notification messages reported. <strong>Warning:</strong> This attribute
|
||
is available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature.
|
||
Since this can change based on feedback, VMware does not guarantee
|
||
backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.
|
||
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if an error was reported by the task.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.appliance.vcenter.settings.v1_client.ScanResult">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1_client.</span></code><code class="sig-name descname"><span class="pre">ScanResult</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>, <em class="sig-param"><span class="n"><span class="pre">notifications</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start_time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">end_time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">profile</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">version</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">compliant</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">non_compliant</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">unavailable</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">compliance_result</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.appliance.vcenter.settings.v1_client.ScanResult" 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">ScanResult</span></code> class contains attributes to describe the scan result of
|
||
a appliance. <strong>Warning:</strong> This class is available as Technology Preview.
|
||
These are early access APIs provided to test, automate and provide feedback
|
||
on the feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</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>status</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1_client.ScanResult.ComplianceStatus" title="com.vmware.appliance.vcenter.settings.v1_client.ScanResult.ComplianceStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">ScanResult.ComplianceStatus</span></code></a>) – Aggregrated compliance state of the appliance. <strong>Warning:</strong> This
|
||
attribute is available as Technology Preview. These are early
|
||
access APIs provided to test, automate and provide feedback on the
|
||
feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them
|
||
in production environments. Some Technology Preview APIs might only
|
||
be applicable to specific environments.</p></li>
|
||
<li><p><strong>notifications</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1_client.Notifications" title="com.vmware.appliance.vcenter.settings.v1_client.Notifications"><code class="xref py py-class docutils literal notranslate"><span class="pre">Notifications</span></code></a>) – Notifications returned by the scan operation. <strong>Warning:</strong> This
|
||
attribute is available as Technology Preview. These are early
|
||
access APIs provided to test, automate and provide feedback on the
|
||
feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them
|
||
in production environments. Some Technology Preview APIs might only
|
||
be applicable to specific environments.</p></li>
|
||
<li><p><strong>start_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the method started. <strong>Warning:</strong> This attribute is
|
||
available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature.
|
||
Since this can change based on feedback, VMware does not guarantee
|
||
backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.</p></li>
|
||
<li><p><strong>end_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Time when the method completed. <strong>Warning:</strong> This attribute is
|
||
available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature.
|
||
Since this can change based on feedback, VMware does not guarantee
|
||
backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.
|
||
If None, the endTime will be empty.</p></li>
|
||
<li><p><strong>profile</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the apply on which the scan is run to generate this
|
||
result. <strong>Warning:</strong> This attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and
|
||
provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and
|
||
recommends against using them in production environments. Some
|
||
Technology Preview APIs might only be applicable to specific
|
||
environments.
|
||
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.appliance.vcenter.settings.v1.config.profile</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.appliance.vcenter.settings.v1.config.profile</span></code>.</p></li>
|
||
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The version of the profile. <strong>Warning:</strong> This attribute is
|
||
available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature.
|
||
Since this can change based on feedback, VMware does not guarantee
|
||
backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.
|
||
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.appliance.vcenter.settings.v1.config.version</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.appliance.vcenter.settings.v1.config.version</span></code>.</p></li>
|
||
<li><p><strong>compliant</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>) – Identifiers of compliant components. <strong>Warning:</strong> This attribute is
|
||
available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature.
|
||
Since this can change based on feedback, VMware does not guarantee
|
||
backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.
|
||
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.appliance.vcenter.settings.v1.config.component</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.appliance.vcenter.settings.v1.config.component</span></code>.</p></li>
|
||
<li><p><strong>non_compliant</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>) – Identifiers of non-compliant components. <strong>Warning:</strong> This
|
||
attribute is available as Technology Preview. These are early
|
||
access APIs provided to test, automate and provide feedback on the
|
||
feature. Since this can change based on feedback, VMware does not
|
||
guarantee backwards compatibility and recommends against using them
|
||
in production environments. Some Technology Preview APIs might only
|
||
be applicable to specific environments.
|
||
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.appliance.vcenter.settings.v1.config.component</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.appliance.vcenter.settings.v1.config.component</span></code>.</p></li>
|
||
<li><p><strong>unavailable</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>) – Identifiers of unavailable components. There will not be compliance
|
||
details for these components. <strong>Warning:</strong> This attribute is
|
||
available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature.
|
||
Since this can change based on feedback, VMware does not guarantee
|
||
backwards compatibility and recommends against using them in
|
||
production environments. Some Technology Preview APIs might only be
|
||
applicable to specific environments.
|
||
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.appliance.vcenter.settings.v1.config.component</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.appliance.vcenter.settings.v1.config.component</span></code>.</p></li>
|
||
<li><p><strong>compliance_result</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1_client.ComplianceResult" title="com.vmware.appliance.vcenter.settings.v1_client.ComplianceResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComplianceResult</span></code></a>) – Mapping of component identifier to the compliance result.
|
||
<strong>Warning:</strong> This attribute is available as Technology Preview.
|
||
These are early access APIs provided to test, automate and provide
|
||
feedback on the feature. Since this can change based on feedback,
|
||
VMware does not guarantee backwards compatibility and recommends
|
||
against using them in production environments. Some Technology
|
||
Preview APIs might only be applicable to specific environments.
|
||
When clients pass a value of this class as a parameter, the key in
|
||
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
|
||
type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.component</span></code>. When
|
||
methods return a value of this class as a return value, the key in
|
||
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for the resource
|
||
type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.component</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py class">
|
||
<dt id="com.vmware.appliance.vcenter.settings.v1_client.ScanResult.ComplianceStatus">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ComplianceStatus</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.appliance.vcenter.settings.v1_client.ScanResult.ComplianceStatus" 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">ScanResult.ComplianceStatus</span></code> class contains the possible different
|
||
status of compliance with respect to target version. <strong>Warning:</strong> This
|
||
enumeration is available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature. Since this
|
||
can change based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production environments.
|
||
Some Technology Preview APIs might only be applicable to specific
|
||
environments.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">ComplianceStatus</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.appliance.vcenter.settings.v1_client.ScanResult.ComplianceStatus.COMPLIANT">
|
||
<code class="sig-name descname"><span class="pre">COMPLIANT</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ComplianceStatus(string='COMPLIANT')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1_client.ScanResult.ComplianceStatus.COMPLIANT" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Target configuration is same as the current configuration?. <strong>Warning:</strong>
|
||
This class attribute is available as Technology Preview. These are early
|
||
access APIs provided to test, automate and provide feedback on the feature.
|
||
Since this can change based on feedback, VMware does not guarantee
|
||
backwards compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable to
|
||
specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.appliance.vcenter.settings.v1_client.ScanResult.ComplianceStatus.NON_COMPLIANT">
|
||
<code class="sig-name descname"><span class="pre">NON_COMPLIANT</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ComplianceStatus(string='NON_COMPLIANT')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1_client.ScanResult.ComplianceStatus.NON_COMPLIANT" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Target configuration is not same as the current configuration. <strong>Warning:</strong>
|
||
This class attribute is available as Technology Preview. These are early
|
||
access APIs provided to test, automate and provide feedback on the feature.
|
||
Since this can change based on feedback, VMware does not guarantee
|
||
backwards compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable to
|
||
specific environments.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.appliance.vcenter.settings.v1_client.ScanResult.ComplianceStatus.UNAVAILABLE">
|
||
<code class="sig-name descname"><span class="pre">UNAVAILABLE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ComplianceStatus(string='UNAVAILABLE')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1_client.ScanResult.ComplianceStatus.UNAVAILABLE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Scan check failed due to unknown error or check hasn’t happened yet and the
|
||
results are not available. <strong>Warning:</strong> This class attribute is available
|
||
as Technology Preview. These are early access APIs provided to test,
|
||
automate and provide feedback on the feature. Since this can change based
|
||
on feedback, VMware does not guarantee backwards compatibility and
|
||
recommends against using them in production environments. Some Technology
|
||
Preview APIs might only be applicable to specific environments.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.appliance.vcenter.settings.v1_client.StubFactory">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1_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.appliance.vcenter.settings.v1_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.appliance.vcenter.settings.v1_client.TaskInfo">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1_client.</span></code><code class="sig-name descname"><span class="pre">TaskInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">progress</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">notifications</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">result</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">operation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">target</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cancelable</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start_time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">end_time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1_client.TaskInfo" 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">TaskInfo</span></code> class contains information about a task. <strong>Warning:</strong> This
|
||
class is available as Technology Preview. These are early access APIs
|
||
provided to test, automate and provide feedback on the feature. Since this
|
||
can change based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production environments.
|
||
Some Technology Preview APIs might only be applicable to specific
|
||
environments.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>progress</strong> (<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Progress" title="com.vmware.cis.task_client.Progress"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Progress</span></code></a>) – Progress of the operation. <strong>Warning:</strong> This attribute is available
|
||
as Technology Preview. These are early access APIs provided to
|
||
test, automate and provide feedback on the feature. Since this can
|
||
change based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable
|
||
to specific environments.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">#status</span></code> is one of
|
||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.RUNNING" title="com.vmware.cis.task_client.Status.RUNNING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.RUNNING</span></code></a>,
|
||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.BLOCKED" title="com.vmware.cis.task_client.Status.BLOCKED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.BLOCKED</span></code></a>,
|
||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a>, or
|
||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.FAILED</span></code></a>.</p></li>
|
||
<li><p><strong>notifications</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1_client.Notifications" title="com.vmware.appliance.vcenter.settings.v1_client.Notifications"><code class="xref py py-class docutils literal notranslate"><span class="pre">Notifications</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Notifications to the user. <strong>Warning:</strong> This attribute is available
|
||
as Technology Preview. These are early access APIs provided to
|
||
test, automate and provide feedback on the feature. Since this can
|
||
change based on feedback, VMware does not guarantee backwards
|
||
compatibility and recommends against using them in production
|
||
environments. Some Technology Preview APIs might only be applicable
|
||
to specific environments.
|
||
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if the notifications were reported by this
|
||
particular task.</p></li>
|
||
<li><p><strong>result</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">DataValue</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Task result. <strong>Warning:</strong> This attribute is available as Technology
|
||
Preview. These are early access APIs provided to test, automate and
|
||
provide feedback on the feature. Since this can change based on
|
||
feedback, VMware does not guarantee backwards compatibility and
|
||
recommends against using them in production environments. Some
|
||
Technology Preview APIs might only be applicable to specific
|
||
environments.
|
||
This attribute will be None if the task has no result.</p></li>
|
||
<li><p><strong>description</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Description of the operation associated with the task.</p></li>
|
||
<li><p><strong>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the service containing the operation.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>. When methods return a value of this
|
||
class as a return value, the attribute will be an identifier for
|
||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>.</p></li>
|
||
<li><p><strong>operation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the operation associated with the task.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>. When methods return a value of this
|
||
class as a return value, the attribute will be an identifier for
|
||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>.</p></li>
|
||
<li><p><strong>parent</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Parent of the current task.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.task</span></code>. When methods return a value of this class
|
||
as a return value, the attribute will be an identifier for the
|
||
resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.cis.task</span></code>.
|
||
This attribute will be None if the task has no parent.</p></li>
|
||
<li><p><strong>target</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifier of the target created by the operation or an existing
|
||
one the operation performed on.
|
||
This attribute will be None if the operation has no target or
|
||
multiple targets.</p></li>
|
||
<li><p><strong>status</strong> (<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status" title="com.vmware.cis.task_client.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status</span></code></a>) – Status of the operation associated with the task.</p></li>
|
||
<li><p><strong>cancelable</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag to indicate whether or not the operation can be cancelled. The
|
||
value may change as the operation progresses.</p></li>
|
||
<li><p><strong>error</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Description of the error if the operation status is “FAILED”.
|
||
If None the description of why the operation failed will be
|
||
included in the result of the operation (see
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Info.result</span></code>).</p></li>
|
||
<li><p><strong>start_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the operation is started.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">status</span></code> is one of
|
||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.RUNNING" title="com.vmware.cis.task_client.Status.RUNNING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.RUNNING</span></code></a>,
|
||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.BLOCKED" title="com.vmware.cis.task_client.Status.BLOCKED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.BLOCKED</span></code></a>,
|
||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a>, or
|
||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.FAILED</span></code></a>.</p></li>
|
||
<li><p><strong>end_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the operation is completed.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">status</span></code> is one of
|
||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a> or
|
||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.FAILED</span></code></a>.</p></li>
|
||
<li><p><strong>user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Name of the user who performed the operation.
|
||
This attribute will be None if the operation is performed by the
|
||
system.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<footer>
|
||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||
<a href="com.vmware.appliance.vcenter.settings.v1.html" class="btn btn-neutral float-right" title="com.vmware.appliance.vcenter.settings.v1 package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||
<a href="com.vmware.appliance.vcenter.html" class="btn btn-neutral float-left" title="com.vmware.appliance.vcenter 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 2021, 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> |