mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-22 09:39:58 -05:00
2647 lines
280 KiB
HTML
2647 lines
280 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.v1.config.components package — vSphere Automation SDK for Python. 8.0.0.1 documentation</title>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
|||
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<!--[if lt IE 9]>
|
|||
|
|
<script src="_static/js/html5shiv.min.js"></script>
|
|||
|
|
<![endif]-->
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
|||
|
|
<script src="_static/jquery.js"></script>
|
|||
|
|
<script src="_static/underscore.js"></script>
|
|||
|
|
<script src="_static/doctools.js"></script>
|
|||
|
|
|
|||
|
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<link rel="index" title="Index" href="genindex.html" />
|
|||
|
|
<link rel="search" title="Search" href="search.html" />
|
|||
|
|
<link rel="next" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory package" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html" />
|
|||
|
|
<link rel="prev" title="com.vmware.appliance.vcenter.settings.v1.config package" href="com.vmware.appliance.vcenter.settings.v1.config.html" />
|
|||
|
|
</head>
|
|||
|
|
|
|||
|
|
<body class="wy-body-for-nav">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="wy-grid-for-nav">
|
|||
|
|
|
|||
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|||
|
|
<div class="wy-side-scroll">
|
|||
|
|
<div class="wy-side-nav-search" >
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python.
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="version">
|
|||
|
|
8.0.0.1
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div role="search">
|
|||
|
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
|||
|
|
<input type="text" name="q" placeholder="Search docs" />
|
|||
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|||
|
|
<input type="hidden" name="area" value="default" />
|
|||
|
|
</form>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<p class="caption"><span class="caption-text">Contents:</span></p>
|
|||
|
|
<ul class="current">
|
|||
|
|
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
|
|||
|
|
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
|
|||
|
|
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
|||
|
|
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="vmware.html">vmware package</a></li>
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<nav class="wy-nav-top" aria-label="top navigation">
|
|||
|
|
|
|||
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|||
|
|
<a href="index.html">vSphere Automation SDK for Python.</a>
|
|||
|
|
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="wy-nav-content">
|
|||
|
|
|
|||
|
|
<div class="rst-content">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
|||
|
|
|
|||
|
|
<ul class="wy-breadcrumbs">
|
|||
|
|
|
|||
|
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.html">com package</a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.vmware.html">com.vmware package</a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.vmware.appliance.html">com.vmware.appliance package</a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.vmware.appliance.vcenter.html">com.vmware.appliance.vcenter package</a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.vmware.appliance.vcenter.settings.html">com.vmware.appliance.vcenter.settings package</a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.vmware.appliance.vcenter.settings.v1.html">com.vmware.appliance.vcenter.settings.v1 package</a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.vmware.appliance.vcenter.settings.v1.config.html">com.vmware.appliance.vcenter.settings.v1.config package</a> »</li>
|
|||
|
|
|
|||
|
|
<li>com.vmware.appliance.vcenter.settings.v1.config.components package</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="wy-breadcrumbs-aside">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a href="_sources/com.vmware.appliance.vcenter.settings.v1.config.components.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.v1.config.components">
|
|||
|
|
<span id="com-vmware-appliance-vcenter-settings-v1-config-components-package"></span><h1>com.vmware.appliance.vcenter.settings.v1.config.components package<a class="headerlink" href="#module-com.vmware.appliance.vcenter.settings.v1.config.components" 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.config.components.inventory.html">com.vmware.appliance.vcenter.settings.v1.config.components.inventory package</a><ul>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#subpackages">Subpackages</a><ul>
|
|||
|
|
<li class="toctree-l3"><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-l4"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l4"><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-l4"><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-l4"><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-l2"><a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l2"><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-l2"><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.common_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.common_client module</a></li>
|
|||
|
|
<li class="toctree-l2"><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-l2"><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-l2"><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-l2"><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-l2"><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-l2"><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>
|
|||
|
|
<li class="toctree-l2"><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.vm_client">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.vm_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.config.components.applmgmt_client">
|
|||
|
|
<span id="com-vmware-appliance-vcenter-settings-v1-config-components-applmgmt-client-module"></span><h2>com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client module<a class="headerlink" href="#module-com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.AccessSettings">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</span></code><code class="sig-name descname"><span class="pre">AccessSettings</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ssh</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">dcui</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">console_cli</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">shell</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.config.components.applmgmt_client.AccessSettings" 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>This <code class="docutils literal notranslate"><span class="pre">AccessSettings</span></code> class to set/get access settings.</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>ssh</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Ssh" title="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Ssh"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ssh</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Get/Set enabled state of SSH-based controlled CLI. <code class="docutils literal notranslate"><span class="pre">Ssh</span></code> class
|
|||
|
|
provides methods</p></li>
|
|||
|
|
<li><p><strong>dcui</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Dcui" title="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Dcui"><code class="xref py py-class docutils literal notranslate"><span class="pre">Dcui</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Get/Set enabled of Direct Console User Interface (DCUI TTY2).
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">Dcui</span></code> class provides methods</p></li>
|
|||
|
|
<li><p><strong>console_cli</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Consolecli" title="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Consolecli"><code class="xref py py-class docutils literal notranslate"><span class="pre">Consolecli</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Get/Set enabled state of the console-based controlled CLI.
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">Consolecli</span></code> class provides methods</p></li>
|
|||
|
|
<li><p><strong>shell</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Shell" title="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Shell"><code class="xref py py-class docutils literal notranslate"><span class="pre">Shell</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Get/Set enabled state of BASH. <code class="docutils literal notranslate"><span class="pre">Shell</span></code> class provides methods</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Address">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</span></code><code class="sig-name descname"><span class="pre">Address</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">address</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">origin</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">prefix</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><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Address" 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">Address</span></code> class provides the structure used to name an IPv6 address.</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>address</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>) – The IPv6 address, for example, fc00:10:20:83:20c:29ff:fe94:bb5a.
|
|||
|
|
If <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>, the address was never set.</p></li>
|
|||
|
|
<li><p><strong>origin</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Address.Origin" title="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Address.Origin"><code class="xref py py-class docutils literal notranslate"><span class="pre">Address.Origin</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The Origin of the IPv6 address. For more information, see RFC 4293.
|
|||
|
|
If <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>, the origin was never set.</p></li>
|
|||
|
|
<li><p><strong>prefix</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The IPv6 CIDR prefix, for example, 64.
|
|||
|
|
If <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>, the prefix was never set.</p></li>
|
|||
|
|
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Address.Status" title="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Address.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">Address.Status</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The Status of the IPv6 address. For more information, see RFC 4293.
|
|||
|
|
If <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>, the status was never set.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Address.Origin">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Origin</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.config.components.applmgmt_client.Address.Origin" 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">Address.Origin</span></code> class defines IPv6 address origin values.</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">Origin</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Address.Origin.DHCP">
|
|||
|
|
<code class="sig-name descname"><span class="pre">DHCP</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Origin(string='DHCP')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Address.Origin.DHCP" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The IPv6 address is assigned by a DHCP server. See RFC 4293.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Address.Origin.LINKLAYER">
|
|||
|
|
<code class="sig-name descname"><span class="pre">LINKLAYER</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Origin(string='LINKLAYER')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Address.Origin.LINKLAYER" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The IPv6 address is assigned by IPv6 Stateless Address Auto-configuration
|
|||
|
|
(SLAAC). See RFC 4293.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Address.Origin.MANUAL">
|
|||
|
|
<code class="sig-name descname"><span class="pre">MANUAL</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Origin(string='MANUAL')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Address.Origin.MANUAL" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The IPv6 address was manually configured to a specified address, for
|
|||
|
|
example, by user configuration. See RFC 4293.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Address.Origin.OTHER">
|
|||
|
|
<code class="sig-name descname"><span class="pre">OTHER</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Origin(string='OTHER')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Address.Origin.OTHER" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The IPv6 address is assigned by a mechanism other than manual, DHCP, SLAAC,
|
|||
|
|
or random. See RFC 4293.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Address.Origin.RANDOM">
|
|||
|
|
<code class="sig-name descname"><span class="pre">RANDOM</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Origin(string='RANDOM')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Address.Origin.RANDOM" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The IPv6 address is assigned randomly by the system. See RFC 4293.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Address.Status">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Status</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Address.Status" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Address.Status</span></code> class defines IPv6 address status values. See RFC
|
|||
|
|
4293.</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">Status</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Address.Status.DEPRECATED">
|
|||
|
|
<code class="sig-name descname"><span class="pre">DEPRECATED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='DEPRECATED')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Address.Status.DEPRECATED" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The is a valid but deprecated IPv6 address. This address cannot be used as
|
|||
|
|
a source address in new communications, although packets addressed to such
|
|||
|
|
an address are processed as expected.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Address.Status.DUPLICATE">
|
|||
|
|
<code class="sig-name descname"><span class="pre">DUPLICATE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='DUPLICATE')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Address.Status.DUPLICATE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The IPv6 address is not unique on the link and cannot be used.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Address.Status.INACCESSIBLE">
|
|||
|
|
<code class="sig-name descname"><span class="pre">INACCESSIBLE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='INACCESSIBLE')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Address.Status.INACCESSIBLE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The IPv6 address is inaccessible because the interface to which this
|
|||
|
|
address is assigned is not operational.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Address.Status.INVALID">
|
|||
|
|
<code class="sig-name descname"><span class="pre">INVALID</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='INVALID')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Address.Status.INVALID" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The IPv6 address is not a valid address. It should not appear as the
|
|||
|
|
destination or source address of a packet.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Address.Status.OPTIMISTIC">
|
|||
|
|
<code class="sig-name descname"><span class="pre">OPTIMISTIC</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='OPTIMISTIC')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Address.Status.OPTIMISTIC" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The IPv6 address is available for use, subject to restrictions, while its
|
|||
|
|
uniqueness on a link is being verified.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Address.Status.PREFERRED">
|
|||
|
|
<code class="sig-name descname"><span class="pre">PREFERRED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='PREFERRED')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Address.Status.PREFERRED" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>This is a valid IPv6 address that can appear as the destination or source
|
|||
|
|
address of a packet.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Address.Status.TENTATIVE">
|
|||
|
|
<code class="sig-name descname"><span class="pre">TENTATIVE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='TENTATIVE')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Address.Status.TENTATIVE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The IPv6 address is in the process of being verified as unique. An address
|
|||
|
|
in this state cannot be used for general communication. It can be used to
|
|||
|
|
determine the uniqueness of the address.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Address.Status.UNKNOWN">
|
|||
|
|
<code class="sig-name descname"><span class="pre">UNKNOWN</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='UNKNOWN')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Address.Status.UNKNOWN" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The status of this address cannot be determined.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.ApplianceManagement">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</span></code><code class="sig-name descname"><span class="pre">ApplianceManagement</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">software_update_policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">backup_schedules</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">access_settings</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">datetime_config</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">syslog</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_account_settings</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">smtp</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">network</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">ceip</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.config.components.applmgmt_client.ApplianceManagement" 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><code class="docutils literal notranslate"><span class="pre">ApplianceManagement</span></code> class This structure contains the Spec required for
|
|||
|
|
Appliance Management configurations.</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>software_update_policy</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.SoftwareUpdatePolicy" title="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.SoftwareUpdatePolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">SoftwareUpdatePolicy</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Policy to update vCenter.
|
|||
|
|
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if the SoftwareUpdatePolicy is set inside
|
|||
|
|
vCenter.</p></li>
|
|||
|
|
<li><p><strong>backup_schedules</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.config.components.applmgmt_client.BackupSchedule" title="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.BackupSchedule"><code class="xref py py-class docutils literal notranslate"><span class="pre">BackupSchedule</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Backup schedule of vCenter.
|
|||
|
|
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if the Backup is schedule for vCenter</p></li>
|
|||
|
|
<li><p><strong>access_settings</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.AccessSettings" title="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.AccessSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">AccessSettings</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – AccessSettings of vCenter. if access settings are set for vCenter</p></li>
|
|||
|
|
<li><p><strong>datetime_config</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.DatetimeConfig" title="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.DatetimeConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">DatetimeConfig</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Date Time Configuration of vCenter.
|
|||
|
|
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if access settings are set for vCenter</p></li>
|
|||
|
|
<li><p><strong>syslog</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.config.components.applmgmt_client.LogForwarding" title="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.LogForwarding"><code class="xref py py-class docutils literal notranslate"><span class="pre">LogForwarding</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The <code class="docutils literal notranslate"><span class="pre">syslog</span></code> class provides methods to manage forwarding of log
|
|||
|
|
messages to remote logging servers.
|
|||
|
|
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if log forwarding to remote server are set in
|
|||
|
|
vCenter.</p></li>
|
|||
|
|
<li><p><strong>user_account_settings</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.UserAccountSettings" title="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.UserAccountSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">UserAccountSettings</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – User Account Settings of vCenter. if user account settings are set
|
|||
|
|
for vCenter</p></li>
|
|||
|
|
<li><p><strong>smtp</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Smtp" title="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Smtp"><code class="xref py py-class docutils literal notranslate"><span class="pre">Smtp</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The <code class="docutils literal notranslate"><span class="pre">LocalAccounts</span></code> class provides methods to manage local user
|
|||
|
|
account.</p></li>
|
|||
|
|
<li><p><strong>network</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.ApplianceNetwork" title="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.ApplianceNetwork"><code class="xref py py-class docutils literal notranslate"><span class="pre">ApplianceNetwork</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Network configurations to be applied.
|
|||
|
|
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if the network configurations are set in vCenter.</p></li>
|
|||
|
|
<li><p><strong>ceip</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Ceip" title="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Ceip"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ceip</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – CEIP (Customer Experience Improvement Program) enabled state.
|
|||
|
|
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if ceip are set in vcenter.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.ApplianceNetwork">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</span></code><code class="sig-name descname"><span class="pre">ApplianceNetwork</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">firewall_rule_policies</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dns_server_configuration</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">proxy_configuration</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">interfaces</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.config.components.applmgmt_client.ApplianceNetwork" 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><code class="docutils literal notranslate"><span class="pre">ApplianceNetwork</span></code> class This structure contains the Spec required for
|
|||
|
|
Appliance Network configurations.</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>firewall_rule_policies</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.config.components.applmgmt_client.FirewallRulePolicy" title="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.FirewallRulePolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">FirewallRulePolicy</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of Firewall Rules to be applied.
|
|||
|
|
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if the FirewallRulePolicy is set in vCenter.</p></li>
|
|||
|
|
<li><p><strong>dns_server_configuration</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.DnsServerConfiguration" title="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.DnsServerConfiguration"><code class="xref py py-class docutils literal notranslate"><span class="pre">DnsServerConfiguration</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – DNS configuration to be applied.
|
|||
|
|
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if the DnsServerConfiguration is set in vCenter.</p></li>
|
|||
|
|
<li><p><strong>proxy_configuration</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.config.components.applmgmt_client.ProxyConfiguration" title="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.ProxyConfiguration"><code class="xref py py-class docutils literal notranslate"><span class="pre">ProxyConfiguration</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Proxy configuration to be applied.
|
|||
|
|
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if the Proxy server configuration is set in
|
|||
|
|
vCenter.</p></li>
|
|||
|
|
<li><p><strong>interfaces</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.config.components.applmgmt_client.Interface" title="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Interface"><code class="xref py py-class docutils literal notranslate"><span class="pre">Interface</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Interfaces configuration to be applied.
|
|||
|
|
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if the Interfaces configuration is set in
|
|||
|
|
vCenter.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.BackupSchedule">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</span></code><code class="sig-name descname"><span class="pre">BackupSchedule</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parts</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">backup_password</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">location</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">location_user</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">location_password</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">enable</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">recurrence_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">retention_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">schedule_id</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.config.components.applmgmt_client.BackupSchedule" 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">BackupSchedule</span></code> class contains fields to be specified for creating a
|
|||
|
|
new schedule. The structure includes parts, location information,
|
|||
|
|
encryption password and enable flag.</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>parts</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of optional parts to be backed up. Use the
|
|||
|
|
com.vmware.appliance.recovery.backup.Parts#list method to get
|
|||
|
|
information about the supported parts.
|
|||
|
|
If None all the optional parts will not be backed up.</p></li>
|
|||
|
|
<li><p><strong>backup_password</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>) – Password for a backup piece. The backupPassword must adhere to the
|
|||
|
|
following password requirements: At least 8 characters, cannot be
|
|||
|
|
more than 20 characters in length. At least 1 uppercase letter. At
|
|||
|
|
least 1 lowercase letter. At least 1 numeric digit. At least 1
|
|||
|
|
special character (i.e. any character not in [0-9,a-z,A-Z]). Only
|
|||
|
|
visible ASCII characters (for example, no space).
|
|||
|
|
If None the backup piece will not be encrypted.</p></li>
|
|||
|
|
<li><p><strong>location</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – URL of the backup location.</p></li>
|
|||
|
|
<li><p><strong>location_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>) – Username for the given location.
|
|||
|
|
If None authentication will not be used for the specified location.</p></li>
|
|||
|
|
<li><p><strong>location_password</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>) – Password for the given location.
|
|||
|
|
If None authentication will not be used for the specified location.</p></li>
|
|||
|
|
<li><p><strong>enable</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Enable or disable a schedule.
|
|||
|
|
If None the schedule will be enabled.</p></li>
|
|||
|
|
<li><p><strong>recurrence_info</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.RecurrenceInfo" title="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.RecurrenceInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">RecurrenceInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Recurrence information for the schedule.
|
|||
|
|
If None backup job will not be scheduled. See
|
|||
|
|
<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.RecurrenceInfo" title="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.RecurrenceInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">RecurrenceInfo</span></code></a></p></li>
|
|||
|
|
<li><p><strong>retention_info</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.RetentionInfo" title="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.RetentionInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">RetentionInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Retention information for the schedule.
|
|||
|
|
If None all the completed backup jobs will be retained forever. See
|
|||
|
|
<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.RetentionInfo" title="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.RetentionInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">RetentionInfo</span></code></a></p></li>
|
|||
|
|
<li><p><strong>schedule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the schedule.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Ceip">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</span></code><code class="sig-name descname"><span class="pre">Ceip</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">enabled</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.config.components.applmgmt_client.Ceip" 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><code class="docutils literal notranslate"><span class="pre">Ceip</span></code> class provides methods to Get/Set enabled state of CEIP (Customer
|
|||
|
|
Experience Improvement Program) value.</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>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Set enabled state of the CEIP.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Consolecli">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</span></code><code class="sig-name descname"><span class="pre">Consolecli</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">enabled</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.config.components.applmgmt_client.Consolecli" 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>Get/Set of the console-based controlled CLI. <code class="docutils literal notranslate"><span class="pre">Consolecli</span></code> class provides
|
|||
|
|
methods</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>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Set enabled state of the console-based controlled CLI (TTY1).</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.DatetimeConfig">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</span></code><code class="sig-name descname"><span class="pre">DatetimeConfig</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">time_zone</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_sync</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">ntp</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.config.components.applmgmt_client.DatetimeConfig" 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>This <code class="docutils literal notranslate"><span class="pre">DatetimeConfig</span></code> class to set/get date time settings.</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>time_zone</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Timezone" title="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Timezone"><code class="xref py py-class docutils literal notranslate"><span class="pre">Timezone</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The <code class="docutils literal notranslate"><span class="pre">Timezone</span></code> class provides methods to get and set the
|
|||
|
|
appliance timezone.
|
|||
|
|
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if the Timezone is set in vCenter</p></li>
|
|||
|
|
<li><p><strong>time_sync</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Timesync" title="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Timesync"><code class="xref py py-class docutils literal notranslate"><span class="pre">Timesync</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <code class="docutils literal notranslate"><span class="pre">Timesync</span></code> class provides methods Performs time synchronization
|
|||
|
|
configuration.
|
|||
|
|
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if the time sync mode is set in vCenter</p></li>
|
|||
|
|
<li><p><strong>ntp</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Ntp" title="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Ntp"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ntp</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <code class="docutils literal notranslate"><span class="pre">Ntp</span></code> class provides methods Gets NTP configuration status and
|
|||
|
|
tests connection to ntp servers.
|
|||
|
|
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if the ntp server are set in vCenter.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Dcui">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</span></code><code class="sig-name descname"><span class="pre">Dcui</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">enabled</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.config.components.applmgmt_client.Dcui" 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>Get/Set enabled state of Direct Console User Interface (DCUI TTY2).
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">Dcui</span></code> class provides methods</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>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Set enabled state of Direct Console User Interface (DCUI).</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.DnsServerConfiguration">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</span></code><code class="sig-name descname"><span class="pre">DnsServerConfiguration</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mode</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">servers</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">domains</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.config.components.applmgmt_client.DnsServerConfiguration" 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><code class="docutils literal notranslate"><span class="pre">DnsServerConfiguration</span></code> class This structure represents the
|
|||
|
|
configuration state used to determine DNS servers.</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>mode</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.DnsServerConfiguration.DNSServerMode" title="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.DnsServerConfiguration.DNSServerMode"><code class="xref py py-class docutils literal notranslate"><span class="pre">DnsServerConfiguration.DNSServerMode</span></code></a>) – Define how to determine the DNS servers. Leave the servers argument
|
|||
|
|
empty if the mode argument is “DHCP”. Set the servers argument to a
|
|||
|
|
comma-separated list of DNS servers if the mode argument is
|
|||
|
|
“static”. The DNS server are assigned from the specified list.</p></li>
|
|||
|
|
<li><p><strong>servers</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – List of the currently used DNS servers. DNS server configuration.</p></li>
|
|||
|
|
<li><p><strong>domains</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of the search domains. DNS Search Domains.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.DnsServerConfiguration.DNSServerMode">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">DNSServerMode</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.config.components.applmgmt_client.DnsServerConfiguration.DNSServerMode" 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><code class="docutils literal notranslate"><span class="pre">DnsServerConfiguration.DNSServerMode</span></code> class Describes DNS Server source
|
|||
|
|
(DHCP,static).</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">DNSServerMode</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.DnsServerConfiguration.DNSServerMode.DHCP">
|
|||
|
|
<code class="sig-name descname"><span class="pre">DHCP</span></code><em class="property"> <span class="pre">=</span> <span class="pre">DNSServerMode(string='DHCP')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.DnsServerConfiguration.DNSServerMode.DHCP" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>DNS address is automatically assigned by a DHCP server.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.DnsServerConfiguration.DNSServerMode.IS_STATIC">
|
|||
|
|
<code class="sig-name descname"><span class="pre">IS_STATIC</span></code><em class="property"> <span class="pre">=</span> <span class="pre">DNSServerMode(string='IS_STATIC')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.DnsServerConfiguration.DNSServerMode.IS_STATIC" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>DNS address is static.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.FirewallRulePolicy">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</span></code><code class="sig-name descname"><span class="pre">FirewallRulePolicy</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">address</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">prefix</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">policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">interface_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.FirewallRulePolicy" 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><code class="docutils literal notranslate"><span class="pre">FirewallRulePolicy</span></code> class Structure that defines a single address-based
|
|||
|
|
firewall rule.</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>address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – IPv4 or IPv6 address.</p></li>
|
|||
|
|
<li><p><strong>prefix</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – CIDR prefix used to mask address. For example, an IPv4 prefix of 24
|
|||
|
|
ignores the low-order 8 bits of address.</p></li>
|
|||
|
|
<li><p><strong>policy</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.FirewallRulePolicy.Policy" title="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.FirewallRulePolicy.Policy"><code class="xref py py-class docutils literal notranslate"><span class="pre">FirewallRulePolicy.Policy</span></code></a>) – The allow or deny policy of this rule.</p></li>
|
|||
|
|
<li><p><strong>interface_name</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>) – The interface to which this rule applies. An empty string indicates
|
|||
|
|
that the rule applies to all interfaces.
|
|||
|
|
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if interface name required</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.FirewallRulePolicy.Policy">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Policy</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.config.components.applmgmt_client.FirewallRulePolicy.Policy" 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><code class="docutils literal notranslate"><span class="pre">FirewallRulePolicy.Policy</span></code> class Defines firewall rule policies.</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">Policy</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.FirewallRulePolicy.Policy.ACCEPT">
|
|||
|
|
<code class="sig-name descname"><span class="pre">ACCEPT</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Policy(string='ACCEPT')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.FirewallRulePolicy.Policy.ACCEPT" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Allow packet with corresponding address.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.FirewallRulePolicy.Policy.IGNORE">
|
|||
|
|
<code class="sig-name descname"><span class="pre">IGNORE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Policy(string='IGNORE')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.FirewallRulePolicy.Policy.IGNORE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Drop packet with correpsonding address.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.FirewallRulePolicy.Policy.REJECT">
|
|||
|
|
<code class="sig-name descname"><span class="pre">REJECT</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Policy(string='REJECT')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.FirewallRulePolicy.Policy.REJECT" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Drop packet with corresponding address sending destination is not
|
|||
|
|
reachable.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.FirewallRulePolicy.Policy.RETURN">
|
|||
|
|
<code class="sig-name descname"><span class="pre">RETURN</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Policy(string='RETURN')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.FirewallRulePolicy.Policy.RETURN" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Apply default or port-specific rules to packet with corresponding address.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Interface">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</span></code><code class="sig-name descname"><span class="pre">Interface</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">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">mac</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">ipv4</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">ipv6</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.config.components.applmgmt_client.Interface" 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><code class="docutils literal notranslate"><span class="pre">Interfaces</span></code> class Provides information about network interface.</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> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Interface name, for example, “nic0”, “nic1”.
|
|||
|
|
If <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>, the name was never set</p></li>
|
|||
|
|
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Interface.InterfaceStatus" title="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Interface.InterfaceStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">Interface.InterfaceStatus</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Interface status.
|
|||
|
|
If <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>, the name was never set</p></li>
|
|||
|
|
<li><p><strong>mac</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>) – MAC address. For example 00:0C:29:94:BB:5A.
|
|||
|
|
If <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>, the mac was never set</p></li>
|
|||
|
|
<li><p><strong>ipv4</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Ipv4" title="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Ipv4"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv4</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – IPv4 Address information.
|
|||
|
|
ipv4 This <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> IPv4 is not set.</p></li>
|
|||
|
|
<li><p><strong>ipv6</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Ipv6" title="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Ipv6"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv6</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – IPv6 Address information.
|
|||
|
|
ipv6 This <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> IPv6 is not set.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Interface.InterfaceStatus">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">InterfaceStatus</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.config.components.applmgmt_client.Interface.InterfaceStatus" 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><code class="docutils literal notranslate"><span class="pre">Interface.InterfaceStatus</span></code> class Defines interface status</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">InterfaceStatus</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Interface.InterfaceStatus.DOWN">
|
|||
|
|
<code class="sig-name descname"><span class="pre">DOWN</span></code><em class="property"> <span class="pre">=</span> <span class="pre">InterfaceStatus(string='DOWN')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Interface.InterfaceStatus.DOWN" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The interface is down.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Interface.InterfaceStatus.UP">
|
|||
|
|
<code class="sig-name descname"><span class="pre">UP</span></code><em class="property"> <span class="pre">=</span> <span class="pre">InterfaceStatus(string='UP')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Interface.InterfaceStatus.UP" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The interface is up.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Ipv4">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</span></code><code class="sig-name descname"><span class="pre">Ipv4</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mode</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">address</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">prefix</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">default_gateway</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">configurable</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.config.components.applmgmt_client.Ipv4" 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">IPv4</span></code> class defines IPv4 configuration. to perform IPv4 network
|
|||
|
|
configuration for interfaces.</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>mode</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Ipv4.Mode" title="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Ipv4.Mode"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv4.Mode</span></code></a>) – The Address assignment mode.</p></li>
|
|||
|
|
<li><p><strong>address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The IPv4 address, for example, “10.20.80.191”.</p></li>
|
|||
|
|
<li><p><strong>prefix</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The IPv4 CIDR prefix, for example, 24. See
|
|||
|
|
<a class="reference external" href="http://www.oav.net/mirrors/cidr.html">http://www.oav.net/mirrors/cidr.html</a> for netmask-to-prefix
|
|||
|
|
conversion.</p></li>
|
|||
|
|
<li><p><strong>default_gateway</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>) – The IPv4 address of the default gateway. This configures the global
|
|||
|
|
default gateway on the appliance with the specified gateway address
|
|||
|
|
and interface. This gateway replaces the existing default gateway
|
|||
|
|
configured on the appliance. However, if the gateway address is
|
|||
|
|
link-local, then it is added for that interface. This does not
|
|||
|
|
support configuration of multiple global default gateways through
|
|||
|
|
different interfaces.
|
|||
|
|
If <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>, the defaultGateway was never set.</p></li>
|
|||
|
|
<li><p><strong>configurable</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The IPv4 is configured or not.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Ipv4.Mode">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Mode</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.config.components.applmgmt_client.Ipv4.Mode" 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">Ipv4.Mode</span></code> class defines different IPv4 address assignment modes.</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">Mode</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Ipv4.Mode.DHCP">
|
|||
|
|
<code class="sig-name descname"><span class="pre">DHCP</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Mode(string='DHCP')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Ipv4.Mode.DHCP" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The IPv4 address is automatically assigned by a DHCP server.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Ipv4.Mode.STATIC">
|
|||
|
|
<code class="sig-name descname"><span class="pre">STATIC</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Mode(string='STATIC')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Ipv4.Mode.STATIC" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The IPv4 address is static.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Ipv4.Mode.UNCONFIGURED">
|
|||
|
|
<code class="sig-name descname"><span class="pre">UNCONFIGURED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Mode(string='UNCONFIGURED')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Ipv4.Mode.UNCONFIGURED" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The IPv4 protocol is not configured.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Ipv6">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</span></code><code class="sig-name descname"><span class="pre">Ipv6</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dhcp</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">autoconf</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">configurable</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">addresses</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">default_gateway</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.config.components.applmgmt_client.Ipv6" 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">Ipv6</span></code> class defines Ipv6 configuration. to perform Ipv6 network
|
|||
|
|
configuration for interfaces.</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>dhcp</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – An address will be assigned by a DHCP server.</p></li>
|
|||
|
|
<li><p><strong>autoconf</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – An address will be assigned by Stateless Address Autoconfiguration
|
|||
|
|
(SLAAC).</p></li>
|
|||
|
|
<li><p><strong>configurable</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – The IPv6 is configured or not.</p></li>
|
|||
|
|
<li><p><strong>addresses</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.config.components.applmgmt_client.Address" title="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Address"><code class="xref py py-class docutils literal notranslate"><span class="pre">Address</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The list of addresses to be statically assigned.
|
|||
|
|
If <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>, the addresses were never set.</p></li>
|
|||
|
|
<li><p><strong>default_gateway</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The default gateway for static IP address assignment. This
|
|||
|
|
configures the global IPv6 default gateway on the appliance with
|
|||
|
|
the specified gateway address and interface. This gateway replaces
|
|||
|
|
the existing default gateway configured on the appliance. However,
|
|||
|
|
if the gateway address is link-local, then it is added for that
|
|||
|
|
interface. This does not support configuration of multiple global
|
|||
|
|
default gateways through different interfaces.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.LocalAccounts">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</span></code><code class="sig-name descname"><span class="pre">LocalAccounts</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fullname</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">roles</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">enabled</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">has_password</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">min_days_between_password_change</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">max_days_between_password_change</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">warn_days_before_password_expiration</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">password</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">email</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.config.components.applmgmt_client.LocalAccounts" 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">LocalAccounts</span></code> class provides methods to manage local user account.</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>fullname</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>) – Full name of the user
|
|||
|
|
If None, the value was never set.</p></li>
|
|||
|
|
<li><p><strong>roles</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – User roles</p></li>
|
|||
|
|
<li><p><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag indicating if the account is enabled</p></li>
|
|||
|
|
<li><p><strong>has_password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Is the user password set.</p></li>
|
|||
|
|
<li><p><strong>min_days_between_password_change</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Minimum number of days between password change
|
|||
|
|
If None, pasword can be changed any time.</p></li>
|
|||
|
|
<li><p><strong>max_days_between_password_change</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of days between password change
|
|||
|
|
If None, password never expires.</p></li>
|
|||
|
|
<li><p><strong>warn_days_before_password_expiration</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Number of days of warning before password expires
|
|||
|
|
If None, a user is never warned.</p></li>
|
|||
|
|
<li><p><strong>password</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>) – Password
|
|||
|
|
If None, value will not be changed</p></li>
|
|||
|
|
<li><p><strong>email</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>) – Email address of the local account
|
|||
|
|
If None, value will not be changed</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.LocalAccountsPolicy">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</span></code><code class="sig-name descname"><span class="pre">LocalAccountsPolicy</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">max_days</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">min_days</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">warn_days</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.config.components.applmgmt_client.LocalAccountsPolicy" 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">LocalAccountsPolicy</span></code> class provides methods to manage local user
|
|||
|
|
accounts password lifecycle.</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>max_days</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of days a password may be used. If the password is
|
|||
|
|
older than this, a password change will be forced.
|
|||
|
|
If None then the restriction will be ignored.</p></li>
|
|||
|
|
<li><p><strong>min_days</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Minimum number of days allowed between password changes. Any
|
|||
|
|
password changes attempted sooner than this will be rejected.
|
|||
|
|
If None then the restriction will be ignored.</p></li>
|
|||
|
|
<li><p><strong>warn_days</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Number of days warning given before a password expires. A zero
|
|||
|
|
means warning is given only upon the day of expiration.
|
|||
|
|
If None then no warning will be provided.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.LogForwarding">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</span></code><code class="sig-name descname"><span class="pre">LogForwarding</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">hostname</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">port</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">protocol</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.config.components.applmgmt_client.LogForwarding" 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">LogForwarding</span></code> class provides methods to manage forwarding of log
|
|||
|
|
messages to remote logging servers.</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>hostname</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>) – FQDN or IP address of the logging server to which messages are
|
|||
|
|
forwarded.</p></li>
|
|||
|
|
<li><p><strong>port</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The port on which the remote logging server is listening for
|
|||
|
|
forwarded log messages.</p></li>
|
|||
|
|
<li><p><strong>protocol</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.LogForwarding.Protocol" title="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.LogForwarding.Protocol"><code class="xref py py-class docutils literal notranslate"><span class="pre">LogForwarding.Protocol</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Transport protocol used to forward log messages.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.LogForwarding.Protocol">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Protocol</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.config.components.applmgmt_client.LogForwarding.Protocol" 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">LogForwarding.Protocol</span></code> class defines transport protocols for
|
|||
|
|
outbound log messages.</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">Protocol</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.LogForwarding.Protocol.RELP">
|
|||
|
|
<code class="sig-name descname"><span class="pre">RELP</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Protocol(string='RELP')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.LogForwarding.Protocol.RELP" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Log messages will be forwarded to the remote host using the RELP protocol.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.LogForwarding.Protocol.TCP">
|
|||
|
|
<code class="sig-name descname"><span class="pre">TCP</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Protocol(string='TCP')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.LogForwarding.Protocol.TCP" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Log messages will be forwarded to the remote host using the TCP protocol.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.LogForwarding.Protocol.TLS">
|
|||
|
|
<code class="sig-name descname"><span class="pre">TLS</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Protocol(string='TLS')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.LogForwarding.Protocol.TLS" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Log messages will be forwarded to the remote host by using the TLS
|
|||
|
|
protocol.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.LogForwarding.Protocol.UDP">
|
|||
|
|
<code class="sig-name descname"><span class="pre">UDP</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Protocol(string='UDP')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.LogForwarding.Protocol.UDP" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Log messages will be forwarded to the remote host using the UDP protocol.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Ntp">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</span></code><code class="sig-name descname"><span class="pre">Ntp</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">servers</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.config.components.applmgmt_client.Ntp" 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><code class="docutils literal notranslate"><span class="pre">Ntp</span></code> class provides methods Get/Set NTP configuration status and tests
|
|||
|
|
connection to ntp servers.</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>servers</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Set NTP servers. This variable updates old NTP servers from
|
|||
|
|
configuration and sets the input NTP servers in the configuration.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.ProxyConfiguration">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</span></code><code class="sig-name descname"><span class="pre">ProxyConfiguration</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">protocol</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">server</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">port</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">username</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">password</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">enabled</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.config.components.applmgmt_client.ProxyConfiguration" 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">ProxyConfiguration</span></code> class defines proxy configuration.</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>protocol</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.ProxyConfiguration.Protocol" title="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.ProxyConfiguration.Protocol"><code class="xref py py-class docutils literal notranslate"><span class="pre">ProxyConfiguration.Protocol</span></code></a>) – The protocol for which proxy should be set.</p></li>
|
|||
|
|
<li><p><strong>server</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>) – URL of the proxy server
|
|||
|
|
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if server set in ProxyConfiguration.</p></li>
|
|||
|
|
<li><p><strong>port</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Port to connect to the proxy server. In a ‘get’ call, indicates the
|
|||
|
|
port connected to the proxy server. In a ‘set’ call, specifies the
|
|||
|
|
port to connect to the proxy server. A value of -1 indicates the
|
|||
|
|
default port.</p></li>
|
|||
|
|
<li><p><strong>username</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>) – Username for proxy server.
|
|||
|
|
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if proxy requires username.</p></li>
|
|||
|
|
<li><p><strong>password</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>) – Password for proxy server.
|
|||
|
|
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if proxy requires password.</p></li>
|
|||
|
|
<li><p><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – In the result of the <code class="docutils literal notranslate"><span class="pre">#get</span></code> and <code class="docutils literal notranslate"><span class="pre">#list</span></code> methods this attribute
|
|||
|
|
indicates whether proxying is enabled for a particular protocol. In
|
|||
|
|
the input to the <code class="docutils literal notranslate"><span class="pre">test</span></code> and <code class="docutils literal notranslate"><span class="pre">set</span></code> methods this attribute
|
|||
|
|
specifies whether proxying should be enabled for a particular
|
|||
|
|
protocol.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.ProxyConfiguration.Protocol">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Protocol</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.config.components.applmgmt_client.ProxyConfiguration.Protocol" 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><code class="docutils literal notranslate"><span class="pre">ProxyConfiguration.Protocol</span></code> class defines the protocols for which
|
|||
|
|
proxying is supported.</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">Protocol</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.ProxyConfiguration.Protocol.FTP">
|
|||
|
|
<code class="sig-name descname"><span class="pre">FTP</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Protocol(string='FTP')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.ProxyConfiguration.Protocol.FTP" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Proxy configuration for ftp.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.ProxyConfiguration.Protocol.HTTP">
|
|||
|
|
<code class="sig-name descname"><span class="pre">HTTP</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Protocol(string='HTTP')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.ProxyConfiguration.Protocol.HTTP" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Proxy configuration for http.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.ProxyConfiguration.Protocol.HTTPS">
|
|||
|
|
<code class="sig-name descname"><span class="pre">HTTPS</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Protocol(string='HTTPS')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.ProxyConfiguration.Protocol.HTTPS" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Proxy configuration for https.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.RecurrenceInfo">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</span></code><code class="sig-name descname"><span class="pre">RecurrenceInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">minute</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">hour</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">days</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.config.components.applmgmt_client.RecurrenceInfo" 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">RecurrenceInfo</span></code> class contains the recurrence information associated
|
|||
|
|
with a schedule.</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>minute</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Minute when backup should run.</p></li>
|
|||
|
|
<li><p><strong>hour</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Hour when backup should run. The hour should be specified in
|
|||
|
|
24-hour clock format.</p></li>
|
|||
|
|
<li><p><strong>days</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.config.components.applmgmt_client.RecurrenceInfo.DayOfWeek" title="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.RecurrenceInfo.DayOfWeek"><code class="xref py py-class docutils literal notranslate"><span class="pre">RecurrenceInfo.DayOfWeek</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Day of week when the backup should be run. Days can be specified as
|
|||
|
|
list of days.
|
|||
|
|
If None the backup will be run everyday.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.RecurrenceInfo.DayOfWeek">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">DayOfWeek</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.config.components.applmgmt_client.RecurrenceInfo.DayOfWeek" 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">RecurrenceInfo.DayOfWeek</span></code> class defines the set of days when backup
|
|||
|
|
can be scheduled. The days can be specified as a list of individual days.
|
|||
|
|
You specify the days when you set the recurrence for a schedule. See
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">RecurrenceInfo.days</span></code>.</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">DayOfWeek</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.RecurrenceInfo.DayOfWeek.FRIDAY">
|
|||
|
|
<code class="sig-name descname"><span class="pre">FRIDAY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">DayOfWeek(string='FRIDAY')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.RecurrenceInfo.DayOfWeek.FRIDAY" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Friday</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.RecurrenceInfo.DayOfWeek.MONDAY">
|
|||
|
|
<code class="sig-name descname"><span class="pre">MONDAY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">DayOfWeek(string='MONDAY')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.RecurrenceInfo.DayOfWeek.MONDAY" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Monday</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.RecurrenceInfo.DayOfWeek.SATURDAY">
|
|||
|
|
<code class="sig-name descname"><span class="pre">SATURDAY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">DayOfWeek(string='SATURDAY')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.RecurrenceInfo.DayOfWeek.SATURDAY" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Saturday</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.RecurrenceInfo.DayOfWeek.SUNDAY">
|
|||
|
|
<code class="sig-name descname"><span class="pre">SUNDAY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">DayOfWeek(string='SUNDAY')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.RecurrenceInfo.DayOfWeek.SUNDAY" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Sunday</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.RecurrenceInfo.DayOfWeek.THURSDAY">
|
|||
|
|
<code class="sig-name descname"><span class="pre">THURSDAY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">DayOfWeek(string='THURSDAY')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.RecurrenceInfo.DayOfWeek.THURSDAY" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Thursday</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.RecurrenceInfo.DayOfWeek.TUESDAY">
|
|||
|
|
<code class="sig-name descname"><span class="pre">TUESDAY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">DayOfWeek(string='TUESDAY')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.RecurrenceInfo.DayOfWeek.TUESDAY" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Tuesday</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.RecurrenceInfo.DayOfWeek.WEDNESDAY">
|
|||
|
|
<code class="sig-name descname"><span class="pre">WEDNESDAY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">DayOfWeek(string='WEDNESDAY')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.RecurrenceInfo.DayOfWeek.WEDNESDAY" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Wednesday</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.RetentionInfo">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</span></code><code class="sig-name descname"><span class="pre">RetentionInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">max_count</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.config.components.applmgmt_client.RetentionInfo" 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">RetentionInfo</span></code> class contains retention information associated with
|
|||
|
|
a schedule.</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>max_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Number of backups which should be retained. If retention is not
|
|||
|
|
set, all the backups will be retained forever.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Shell">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</span></code><code class="sig-name descname"><span class="pre">Shell</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">enabled</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">timeout</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.config.components.applmgmt_client.Shell" 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>Get/Set enabled state of BASH, that is, access to BASH from within the
|
|||
|
|
controlled CLI. <code class="docutils literal notranslate"><span class="pre">Shell</span></code> class provides methods.</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>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Enabled can be set to true or false</p></li>
|
|||
|
|
<li><p><strong>timeout</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The timeout (in seconds) specifies how long you enable the Shell
|
|||
|
|
access. The maximum timeout is 86400 seconds(1 day).</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Smtp">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</span></code><code class="sig-name descname"><span class="pre">Smtp</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mail_server</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">relay_port</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.config.components.applmgmt_client.Smtp" 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">Smtp</span></code> class provides methods to manage send mail configuration.</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>mail_server</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>) – Mail server IP address.
|
|||
|
|
If None then the value will be ignored.</p></li>
|
|||
|
|
<li><p><strong>relay_port</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>) – Relay port number.
|
|||
|
|
If None then the value will be ignored.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.SoftwareUpdatePolicy">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</span></code><code class="sig-name descname"><span class="pre">SoftwareUpdatePolicy</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">url</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">default_url</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">auto_stage</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">check_schedule</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">username</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">password</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">enable_ssl_cert_validation</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.config.components.applmgmt_client.SoftwareUpdatePolicy" 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>This <code class="docutils literal notranslate"><span class="pre">SoftwareUpdatePolicy</span></code> class to set/get background check for the new
|
|||
|
|
updates.</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>url</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>) – Current appliance update repository URL. Enter “default” to reset
|
|||
|
|
the url to the default url.
|
|||
|
|
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if custom URL required</p></li>
|
|||
|
|
<li><p><strong>default_url</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>) – Default appliance update repository URL.
|
|||
|
|
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if default URL required</p></li>
|
|||
|
|
<li><p><strong>auto_stage</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Check for update at the pre-configured repository URL.
|
|||
|
|
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if auto stage is enable.</p></li>
|
|||
|
|
<li><p><strong>check_schedule</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.config.components.applmgmt_client.Time" title="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Time"><code class="xref py py-class docutils literal notranslate"><span class="pre">Time</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The <code class="docutils literal notranslate"><span class="pre">Time</span></code> class defines day and time the automatic check for new
|
|||
|
|
updates will be run.
|
|||
|
|
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if Time required.</p></li>
|
|||
|
|
<li><p><strong>username</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>) – Username for the url update repository
|
|||
|
|
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if SoftwareUpdatePolicy requires username.</p></li>
|
|||
|
|
<li><p><strong>password</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>) – Password for the url update repository
|
|||
|
|
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if SoftwareUpdatePolicy requires password.</p></li>
|
|||
|
|
<li><p><strong>enable_ssl_cert_validation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Indicates whether certificates will be checked during patching.</p>
|
|||
|
|
<p>Warning: If this attribute is set to false, an insecure connection
|
|||
|
|
is made to the update repository which can potentially put the
|
|||
|
|
appliance security at risk.</p>
|
|||
|
|
</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.SoftwareUpdatePolicy.AutoUpdateNotification">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">AutoUpdateNotification</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.config.components.applmgmt_client.SoftwareUpdatePolicy.AutoUpdateNotification" 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>Defines state for automatic update notification.
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">SoftwareUpdatePolicy.AutoUpdateNotification</span></code> class</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">AutoUpdateNotification</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.SoftwareUpdatePolicy.AutoUpdateNotification.DISABLED">
|
|||
|
|
<code class="sig-name descname"><span class="pre">DISABLED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">AutoUpdateNotification(string='DISABLED')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.SoftwareUpdatePolicy.AutoUpdateNotification.DISABLED" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Automatic update notification is disabled. Disable periodically query the
|
|||
|
|
configured url for updates.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.SoftwareUpdatePolicy.AutoUpdateNotification.ENABLED">
|
|||
|
|
<code class="sig-name descname"><span class="pre">ENABLED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">AutoUpdateNotification(string='ENABLED')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.SoftwareUpdatePolicy.AutoUpdateNotification.ENABLED" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Automatic update notification is enabled. Enable periodically query the
|
|||
|
|
configured url for updates.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Ssh">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</span></code><code class="sig-name descname"><span class="pre">Ssh</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">enabled</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.config.components.applmgmt_client.Ssh" 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><code class="docutils literal notranslate"><span class="pre">Ssh</span></code> class provides methods to Get/Set enabled state of SSH-based
|
|||
|
|
controlled CLI.</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>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Set enabled state of the SSH-based controlled CLI.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_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.config.components.applmgmt_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.config.components.applmgmt_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.config.components.applmgmt_client.Time">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</span></code><code class="sig-name descname"><span class="pre">Time</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">hour</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">minute</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">day</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.config.components.applmgmt_client.Time" 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">Time</span></code> class defines weekday and time the automatic check for new
|
|||
|
|
updates will be run</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>hour</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>) – Time to query for updates Format: HH:MM:SS Military (24 hour) Time
|
|||
|
|
Format
|
|||
|
|
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if hour is present in SoftwareUpdatePolicy</p></li>
|
|||
|
|
<li><p><strong>minute</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>) – Time to query for updates Format: HH:MM:SS Military (24 hour) Time
|
|||
|
|
Format
|
|||
|
|
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if minute is present in SoftwareUpdatePolicy</p></li>
|
|||
|
|
<li><p><strong>day</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Time.UpdateDay" title="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Time.UpdateDay"><code class="xref py py-class docutils literal notranslate"><span class="pre">Time.UpdateDay</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Day to query for updates
|
|||
|
|
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if minute is present in SoftwareUpdatePolicy</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Time.UpdateDay">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">UpdateDay</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.config.components.applmgmt_client.Time.UpdateDay" 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><code class="docutils literal notranslate"><span class="pre">Time.UpdateDay</span></code> class Defines days to query for updates.</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">UpdateDay</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Time.UpdateDay.EVERYDAY">
|
|||
|
|
<code class="sig-name descname"><span class="pre">EVERYDAY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">UpdateDay(string='EVERYDAY')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Time.UpdateDay.EVERYDAY" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Query for updates everyday.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Time.UpdateDay.FRIDAY">
|
|||
|
|
<code class="sig-name descname"><span class="pre">FRIDAY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">UpdateDay(string='FRIDAY')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Time.UpdateDay.FRIDAY" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Query for updates on Friday.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Time.UpdateDay.MONDAY">
|
|||
|
|
<code class="sig-name descname"><span class="pre">MONDAY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">UpdateDay(string='MONDAY')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Time.UpdateDay.MONDAY" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Query for updates on Monday.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Time.UpdateDay.SATURDAY">
|
|||
|
|
<code class="sig-name descname"><span class="pre">SATURDAY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">UpdateDay(string='SATURDAY')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Time.UpdateDay.SATURDAY" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Query for updates on Saturday.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Time.UpdateDay.SUNDAY">
|
|||
|
|
<code class="sig-name descname"><span class="pre">SUNDAY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">UpdateDay(string='SUNDAY')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Time.UpdateDay.SUNDAY" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Query for updates on Sunday.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Time.UpdateDay.THURSDAY">
|
|||
|
|
<code class="sig-name descname"><span class="pre">THURSDAY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">UpdateDay(string='THURSDAY')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Time.UpdateDay.THURSDAY" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Query for updates on Thursday.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Time.UpdateDay.TUESDAY">
|
|||
|
|
<code class="sig-name descname"><span class="pre">TUESDAY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">UpdateDay(string='TUESDAY')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Time.UpdateDay.TUESDAY" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Query for updates on Tuesday.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Time.UpdateDay.WEDNESDAY">
|
|||
|
|
<code class="sig-name descname"><span class="pre">WEDNESDAY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">UpdateDay(string='WEDNESDAY')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Time.UpdateDay.WEDNESDAY" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Query for updates on Wednesday.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Timesync">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</span></code><code class="sig-name descname"><span class="pre">Timesync</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mode</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.config.components.applmgmt_client.Timesync" 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><code class="docutils literal notranslate"><span class="pre">Timesync</span></code> class provides methods Performs time synchronization
|
|||
|
|
configuration.</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>mode</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Timesync.TimeSyncMode" title="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Timesync.TimeSyncMode"><code class="xref py py-class docutils literal notranslate"><span class="pre">Timesync.TimeSyncMode</span></code></a>) – </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Timesync.TimeSyncMode">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">TimeSyncMode</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.config.components.applmgmt_client.Timesync.TimeSyncMode" 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">Timesync.TimeSyncMode</span></code> class defines time synchronization modes</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">TimeSyncMode</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Timesync.TimeSyncMode.DISABLED">
|
|||
|
|
<code class="sig-name descname"><span class="pre">DISABLED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">TimeSyncMode(string='DISABLED')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Timesync.TimeSyncMode.DISABLED" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Time synchronization is disabled.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Timesync.TimeSyncMode.HOST">
|
|||
|
|
<code class="sig-name descname"><span class="pre">HOST</span></code><em class="property"> <span class="pre">=</span> <span class="pre">TimeSyncMode(string='HOST')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Timesync.TimeSyncMode.HOST" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>VMware Tool-based time synchronization.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Timesync.TimeSyncMode.NTP">
|
|||
|
|
<code class="sig-name descname"><span class="pre">NTP</span></code><em class="property"> <span class="pre">=</span> <span class="pre">TimeSyncMode(string='NTP')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Timesync.TimeSyncMode.NTP" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>NTP-based time synchronization.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Timezone">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</span></code><code class="sig-name descname"><span class="pre">Timezone</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><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Timezone" 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">Timezone</span></code> class provides methods to get and set the appliance
|
|||
|
|
timezone.</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>name</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>) – Set time zone.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.UserAccountSettings">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</span></code><code class="sig-name descname"><span class="pre">UserAccountSettings</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">local_accounts_policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">root_account_policy</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.config.components.applmgmt_client.UserAccountSettings" 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>This <code class="docutils literal notranslate"><span class="pre">UserAccountSettings</span></code> class to set/get user account settings.</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>local_accounts_policy</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.LocalAccountsPolicy" title="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.LocalAccountsPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">LocalAccountsPolicy</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The <code class="docutils literal notranslate"><span class="pre">localAccountsPolicy</span></code> class provides methods to manage local
|
|||
|
|
user accounts.
|
|||
|
|
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if Password Policy is set to manage local user
|
|||
|
|
accounts.</p></li>
|
|||
|
|
<li><p><strong>root_account_policy</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.LocalAccounts" title="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.LocalAccounts"><code class="xref py py-class docutils literal notranslate"><span class="pre">LocalAccounts</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The <code class="docutils literal notranslate"><span class="pre">LocalAccounts</span></code> class provides methods to manage local user
|
|||
|
|
account.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div class="section" id="module-com.vmware.appliance.vcenter.settings.v1.config.components.authcommon_client">
|
|||
|
|
<span id="com-vmware-appliance-vcenter-settings-v1-config-components-authcommon-client-module"></span><h2>com.vmware.appliance.vcenter.settings.v1.config.components.authcommon_client module<a class="headerlink" href="#module-com.vmware.appliance.vcenter.settings.v1.config.components.authcommon_client" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.authcommon_client.Principal">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.authcommon_client.</span></code><code class="sig-name descname"><span class="pre">Principal</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">group</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.config.components.authcommon_client.Principal" 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><code class="docutils literal notranslate"><span class="pre">Principal</span></code> class represents the configuration for a Principal.</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>) – Principal name.</p></li>
|
|||
|
|
<li><p><strong>group</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Is a Group</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.authcommon_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.config.components.authcommon_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.config.components.authcommon_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>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div class="section" id="module-com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client">
|
|||
|
|
<span id="com-vmware-appliance-vcenter-settings-v1-config-components-authmanagement-client-module"></span><h2>com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client module<a class="headerlink" href="#module-com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.AuthenticationManagement">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.</span></code><code class="sig-name descname"><span class="pre">AuthenticationManagement</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">privileges</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">global_permissions</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">roles</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">password_policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">token_policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lockout_policy</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.config.components.authmanagement_client.AuthenticationManagement" 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><code class="docutils literal notranslate"><span class="pre">AuthenticationManagement</span></code> class This structure contains the Spec
|
|||
|
|
required for Authentication Management configurations.</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>privileges</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.config.components.authmanagement_client.Privileges" title="com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.Privileges"><code class="xref py py-class docutils literal notranslate"><span class="pre">Privileges</span></code></a>) – List of Privileges.</p></li>
|
|||
|
|
<li><p><strong>global_permissions</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.config.components.authmanagement_client.GlobalPermission" title="com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.GlobalPermission"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlobalPermission</span></code></a>) – List of Global Permission.</p></li>
|
|||
|
|
<li><p><strong>roles</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.config.components.authmanagement_client.Roles" title="com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.Roles"><code class="xref py py-class docutils literal notranslate"><span class="pre">Roles</span></code></a>) – List of Roles.</p></li>
|
|||
|
|
<li><p><strong>password_policy</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.PasswordPolicy" title="com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.PasswordPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">PasswordPolicy</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Password Policy.</p></li>
|
|||
|
|
<li><p><strong>token_policy</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.TokenPolicy" title="com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.TokenPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">TokenPolicy</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Token Policy.</p></li>
|
|||
|
|
<li><p><strong>lockout_policy</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.LockoutPolicy" title="com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.LockoutPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">LockoutPolicy</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Lockout Policy.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.GlobalPermission">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.</span></code><code class="sig-name descname"><span class="pre">GlobalPermission</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">principal</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">role_names</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">propagate</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.config.components.authmanagement_client.GlobalPermission" 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><code class="docutils literal notranslate"><span class="pre">GlobalPermissions</span></code> class This structure represents the configuration for
|
|||
|
|
Global Permissions</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>principal</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.authcommon_client.Principal" title="com.vmware.appliance.vcenter.settings.v1.config.components.authcommon_client.Principal"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.authcommon_client.Principal</span></code></a>) – Principal with roles.</p></li>
|
|||
|
|
<li><p><strong>role_names</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Role Names assigned to this Principal</p></li>
|
|||
|
|
<li><p><strong>propagate</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Propagating to child objects.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.LockoutPolicy">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.</span></code><code class="sig-name descname"><span class="pre">LockoutPolicy</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">failed_login_attempts</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">failure_interval</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">unlock_time</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.config.components.authmanagement_client.LockoutPolicy" 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><code class="docutils literal notranslate"><span class="pre">LockoutPolicy</span></code> class This structure represents the configuration in
|
|||
|
|
Lockout Policy.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>failed_login_attempts</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Maximum number of failed login attempts.</p></li>
|
|||
|
|
<li><p><strong>failure_interval</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Time interval between failures.</p></li>
|
|||
|
|
<li><p><strong>unlock_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Unlock time.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.PasswordPolicy">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.</span></code><code class="sig-name descname"><span class="pre">PasswordPolicy</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">special_chars</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">alpha_chars</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">uppercase_chars</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">lowercase_chars</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">numeric_chars</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">adj_identical_chars</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">password_reuse</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">max_life</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">max_length</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">min_length</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.config.components.authmanagement_client.PasswordPolicy" 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><code class="docutils literal notranslate"><span class="pre">PasswordPolicy</span></code> class This structure represents the configuration in
|
|||
|
|
Password Policy.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>special_chars</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Minimum special characters.</p></li>
|
|||
|
|
<li><p><strong>alpha_chars</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Minimum alphabetic characters.</p></li>
|
|||
|
|
<li><p><strong>uppercase_chars</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Minimum uppercase characters.</p></li>
|
|||
|
|
<li><p><strong>lowercase_chars</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Minimum lowercase characters.</p></li>
|
|||
|
|
<li><p><strong>numeric_chars</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Minimum numeric characters.</p></li>
|
|||
|
|
<li><p><strong>adj_identical_chars</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Maximum adjacent identical characters.</p></li>
|
|||
|
|
<li><p><strong>password_reuse</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Previous password reuse restriction.</p></li>
|
|||
|
|
<li><p><strong>max_life</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Maximum lifetime.</p></li>
|
|||
|
|
<li><p><strong>max_length</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Maximum length.</p></li>
|
|||
|
|
<li><p><strong>min_length</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Minimum length.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.Privileges">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.</span></code><code class="sig-name descname"><span class="pre">Privileges</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</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">group</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">is_on_parent</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.config.components.authmanagement_client.Privileges" 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><code class="docutils literal notranslate"><span class="pre">Privileges</span></code> class This structure represents the configuration for
|
|||
|
|
Privileges.</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>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Privilege identifier.</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>) – Privilege description.</p></li>
|
|||
|
|
<li><p><strong>group</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Group to which the privilege belongs to.</p></li>
|
|||
|
|
<li><p><strong>is_on_parent</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – does this apply to the parent entity?</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.Roles">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.</span></code><code class="sig-name descname"><span class="pre">Roles</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">privilege_ids</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.config.components.authmanagement_client.Roles" 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><code class="docutils literal notranslate"><span class="pre">Roles</span></code> class This structure represents the configuration for Roles.</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>) – Role name which is unique across roles.</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>) – Role description.</p></li>
|
|||
|
|
<li><p><strong>privilege_ids</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of Privileges present in the Role.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_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.config.components.authmanagement_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.config.components.authmanagement_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.config.components.authmanagement_client.TokenPolicy">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.</span></code><code class="sig-name descname"><span class="pre">TokenPolicy</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">clock_tolerance</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">token_renewal</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">token_delegation</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">bearer_refresh</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">hok_refresh</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.config.components.authmanagement_client.TokenPolicy" 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><code class="docutils literal notranslate"><span class="pre">TokenPolicy</span></code> class This structure represents the configuration in Token
|
|||
|
|
Policy.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>clock_tolerance</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Clock tolerance ms.</p></li>
|
|||
|
|
<li><p><strong>token_renewal</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Maximum token renewal count.</p></li>
|
|||
|
|
<li><p><strong>token_delegation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Maximum token delegation count.</p></li>
|
|||
|
|
<li><p><strong>bearer_refresh</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Maximum Bearer RefreshToken lifetime.</p></li>
|
|||
|
|
<li><p><strong>hok_refresh</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Maximum HoK RefreshToken lifetime.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div class="section" id="module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client">
|
|||
|
|
<span id="com-vmware-appliance-vcenter-settings-v1-config-components-inventory-client-module"></span><h2>com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client module<a class="headerlink" href="#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<p>The
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client</span></code>
|
|||
|
|
module provides classes to manage the vCenter Server Inventory configurations.</p>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.InventoryManagement">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.</span></code><code class="sig-name descname"><span class="pre">InventoryManagement</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">folders</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">datacenters</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">clusters</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">storage_pods</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">datastores</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">networks</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">hosts</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.config.components.inventory_client.InventoryManagement" 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">InventoryManagement</span></code> class contains attributes describing the
|
|||
|
|
inventory of a vCenter Server.</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>folders</strong> (<a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.Folder" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.Folder"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.Folder</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of Folders.</p></li>
|
|||
|
|
<li><p><strong>datacenters</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.config.components.inventory.html#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter_client.Datacenter" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter_client.Datacenter"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter_client.Datacenter</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of Datacenters.</p></li>
|
|||
|
|
<li><p><strong>clusters</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.config.components.inventory.html#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client.ClusterConfigInfo" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client.ClusterConfigInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client.ClusterConfigInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of ClusterConfigurations.</p></li>
|
|||
|
|
<li><p><strong>storage_pods</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.config.components.inventory.html#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.StoragePod" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.StoragePod"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.StoragePod</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of Datastore Clusters.</p></li>
|
|||
|
|
<li><p><strong>datastores</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.config.components.inventory.html#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.Datastore" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.Datastore"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.Datastore</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of Datastores.</p></li>
|
|||
|
|
<li><p><strong>networks</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.config.components.inventory.html#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network_client.Network" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network_client.Network"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network_client.Network</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of standard networks.</p></li>
|
|||
|
|
<li><p><strong>hosts</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.config.components.inventory.html#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.host_client.HostConfig" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.host_client.HostConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.host_client.HostConfig</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of Hosts.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Settings">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.</span></code><code class="sig-name descname"><span class="pre">Settings</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">settings</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.config.components.inventory_client.Settings" 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">Settings</span></code> class defines vCenter Server settings as key-value pairs.</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>settings</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 <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory_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.config.components.inventory_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.config.components.inventory_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>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div class="section" id="module-com.vmware.appliance.vcenter.settings.v1.config.components.inventoryauthorization_client">
|
|||
|
|
<span id="com-vmware-appliance-vcenter-settings-v1-config-components-inventoryauthorization-client-module"></span><h2>com.vmware.appliance.vcenter.settings.v1.config.components.inventoryauthorization_client module<a class="headerlink" href="#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventoryauthorization_client" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventoryauthorization_client.InventoryAuthorization">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventoryauthorization_client.</span></code><code class="sig-name descname"><span class="pre">InventoryAuthorization</span></code><span class="sig-paren">(</span><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">service_provider_entities</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.config.components.inventoryauthorization_client.InventoryAuthorization" 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><code class="docutils literal notranslate"><span class="pre">InventoryAuthorization</span></code> class contains the Spec required for
|
|||
|
|
InventoryAuthorizationPlugin configurations.</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>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The version of the authorization model this configuration is
|
|||
|
|
applicable to.</p></li>
|
|||
|
|
<li><p><strong>service_provider_entities</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventoryauthorization_client.ServiceProviderEntities" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventoryauthorization_client.ServiceProviderEntities"><code class="xref py py-class docutils literal notranslate"><span class="pre">ServiceProviderEntities</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Service provider managed entities configuration of the vCenter.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventoryauthorization_client.Permission">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventoryauthorization_client.</span></code><code class="sig-name descname"><span class="pre">Permission</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entity</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">principal</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">role_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">propagate</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.config.components.inventoryauthorization_client.Permission" 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><code class="docutils literal notranslate"><span class="pre">Permission</span></code> class represents a single inventory permission inside a
|
|||
|
|
container.</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>entity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Full path to the entity for which the permission is set. The entity
|
|||
|
|
must be either one of the service provider managed entities, or a
|
|||
|
|
child thereof.</p></li>
|
|||
|
|
<li><p><strong>principal</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.authcommon_client.Principal" title="com.vmware.appliance.vcenter.settings.v1.config.components.authcommon_client.Principal"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.authcommon_client.Principal</span></code></a>) – The principal for which the permission is set.</p></li>
|
|||
|
|
<li><p><strong>role_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of a role in vCenter.</p></li>
|
|||
|
|
<li><p><strong>propagate</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Whether this permission propagates to child objects.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventoryauthorization_client.ServiceProviderEntities">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventoryauthorization_client.</span></code><code class="sig-name descname"><span class="pre">ServiceProviderEntities</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entities</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">permissions</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.config.components.inventoryauthorization_client.ServiceProviderEntities" 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><code class="docutils literal notranslate"><span class="pre">ServiceProviderEntities</span></code> class contains the configuration for the
|
|||
|
|
service provider managed entities inside VCenter, together with explicit
|
|||
|
|
inventory permissions inside the container.</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>entities</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – List of full paths to the service provider managed entities inside
|
|||
|
|
the vCenter.</p></li>
|
|||
|
|
<li><p><strong>permissions</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.config.components.inventoryauthorization_client.Permission" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventoryauthorization_client.Permission"><code class="xref py py-class docutils literal notranslate"><span class="pre">Permission</span></code></a>) – List of the inventory permissions to set inside the container.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventoryauthorization_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.config.components.inventoryauthorization_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.config.components.inventoryauthorization_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>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div class="section" id="module-com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client">
|
|||
|
|
<span id="com-vmware-appliance-vcenter-settings-v1-config-components-managementcluster-client-module"></span><h2>com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client module<a class="headerlink" href="#module-com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.DrsConfig">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.</span></code><code class="sig-name descname"><span class="pre">DrsConfig</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">enabled</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">automation_level</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">migration_threshold</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">virtual_machine_automation</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.config.components.managementcluster_client.DrsConfig" 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">DrsConfig</span></code> class contains attributes describing the DRS specific
|
|||
|
|
configurations of the management cluster. <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>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag indicating whether or not DRS service is enabled. <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>automation_level</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.DrsConfig.DrsBehaviorInfo" title="com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.DrsConfig.DrsBehaviorInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">DrsConfig.DrsBehaviorInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Specifies the cluster-wide default DRS behavior for virtual
|
|||
|
|
machines. You can override the default behavior for a virtual
|
|||
|
|
machine. <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 or empty, the value is skipped.</p></li>
|
|||
|
|
<li><p><strong>migration_threshold</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Threshold for generated recommendations. DRS generates only those
|
|||
|
|
recommendations that are above the specified vmotionRate. Ratings
|
|||
|
|
vary from 1 to 5. <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 or empty, the value is skipped.</p></li>
|
|||
|
|
<li><p><strong>virtual_machine_automation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag that dictates whether DRS Behavior overrides for individual
|
|||
|
|
VMs. <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>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.DrsConfig.DrsBehaviorInfo">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">DrsBehaviorInfo</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.config.components.managementcluster_client.DrsConfig.DrsBehaviorInfo" 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">DrsConfig.DrsBehaviorInfo</span></code> class defines the automation levels that
|
|||
|
|
can be set on a DRS cluster. <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">DrsBehaviorInfo</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.DrsConfig.DrsBehaviorInfo.FULLY_AUTOMATED">
|
|||
|
|
<code class="sig-name descname"><span class="pre">FULLY_AUTOMATED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">DrsBehaviorInfo(string='FULLY_AUTOMATED')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.DrsConfig.DrsBehaviorInfo.FULLY_AUTOMATED" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Specifies that VirtualCenter should automate both the migration of virtual
|
|||
|
|
machines and their placement with a host at power on. <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.config.components.managementcluster_client.DrsConfig.DrsBehaviorInfo.MANUAL">
|
|||
|
|
<code class="sig-name descname"><span class="pre">MANUAL</span></code><em class="property"> <span class="pre">=</span> <span class="pre">DrsBehaviorInfo(string='MANUAL')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.DrsConfig.DrsBehaviorInfo.MANUAL" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Specifies that VirtualCenter should generate recommendations for virtual
|
|||
|
|
machine migration and for placement with a host, but should not implement
|
|||
|
|
the recommendations automatically. <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.config.components.managementcluster_client.DrsConfig.DrsBehaviorInfo.PARTIALLY_AUTOMATED">
|
|||
|
|
<code class="sig-name descname"><span class="pre">PARTIALLY_AUTOMATED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">DrsBehaviorInfo(string='PARTIALLY_AUTOMATED')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.DrsConfig.DrsBehaviorInfo.PARTIALLY_AUTOMATED" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Specifies that VirtualCenter should generate recommendations for virtual
|
|||
|
|
machine migration and for placement with a host, but should automatically
|
|||
|
|
implement only the placement at power on. <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.config.components.managementcluster_client.ManagementCluster">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.</span></code><code class="sig-name descname"><span class="pre">ManagementCluster</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">parent_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">drs</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">management_resourcepools</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.config.components.managementcluster_client.ManagementCluster" 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">ManagementCluster</span></code> class contains attributes describing the
|
|||
|
|
configuration of the management cluster that hosts the management virtual
|
|||
|
|
machines. It contains the resource settings of the cluster and the
|
|||
|
|
management virtual machines running inside it. <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 management cluster which hosts the management VMs.
|
|||
|
|
<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>parent_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Absolute path from root folder to management cluster’s parent.
|
|||
|
|
<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>drs</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.DrsConfig" title="com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.DrsConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">DrsConfig</span></code></a>) – Cluster-wide configuration of the vSphere DRS service. <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>management_resourcepools</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.config.components.managementcluster_client.ResourcePool" title="com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.ResourcePool"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourcePool</span></code></a>) – The management cluster provides dedicated resource pools for
|
|||
|
|
running the management virtual machines. Management cluster can can
|
|||
|
|
run workload VMs outside this resource pools. <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.config.components.managementcluster_client.ManagementVirtualMachine">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.</span></code><code class="sig-name descname"><span class="pre">ManagementVirtualMachine</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">vm_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent_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">resource_config</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.config.components.managementcluster_client.ManagementVirtualMachine" 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">ManagementVirtualMachine</span></code> class contains information about the
|
|||
|
|
management virtual machine configurations present in the management
|
|||
|
|
cluster. <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 management virtual machine 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>vm_type</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.ManagementVirtualMachine.ManagementVMType" title="com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.ManagementVirtualMachine.ManagementVMType"><code class="xref py py-class docutils literal notranslate"><span class="pre">ManagementVirtualMachine.ManagementVMType</span></code></a>) – Type of the management virtual machine. <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>parent_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Absolute path from root folder to management virtual machine parent
|
|||
|
|
vm folder. <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>resource_config</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.ResourceConfigSpec" title="com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.ResourceConfigSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceConfigSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Configuration of the management virtual machine. <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, then there is no configuration.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.ManagementVirtualMachine.ManagementVMType">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ManagementVMType</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.config.components.managementcluster_client.ManagementVirtualMachine.ManagementVMType" 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">ManagementVirtualMachine.ManagementVMType</span></code> class defines the type of
|
|||
|
|
management virtual machine. <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">ManagementVMType</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.ManagementVirtualMachine.ManagementVMType.CLOUD_GATEWAY">
|
|||
|
|
<code class="sig-name descname"><span class="pre">CLOUD_GATEWAY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ManagementVMType(string='CLOUD_GATEWAY')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.ManagementVirtualMachine.ManagementVMType.CLOUD_GATEWAY" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The management virtual machine is of type Cloud Gateway. <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.config.components.managementcluster_client.ManagementVirtualMachine.ManagementVMType.VCENTER">
|
|||
|
|
<code class="sig-name descname"><span class="pre">VCENTER</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ManagementVMType(string='VCENTER')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.ManagementVirtualMachine.ManagementVMType.VCENTER" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The management virtual machine is of type vCenter. <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.config.components.managementcluster_client.ResourceAllocationInfo">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.</span></code><code class="sig-name descname"><span class="pre">ResourceAllocationInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">reservation</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">expandable_reservation</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">limit</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">shares</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.config.components.managementcluster_client.ResourceAllocationInfo" 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">ResourceAllocationInfo</span></code> class contains resource allocation
|
|||
|
|
information of a resource pool or management virtual machine. <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>reservation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Amount of resource that is guaranteed available to a resource pool
|
|||
|
|
or a virtual machine. Reserved resources are not wasted if they are
|
|||
|
|
not used. If the utilization is less than the reservation, the
|
|||
|
|
resources can be utilized by other running virtual machines. Units
|
|||
|
|
are MB fo memory, and MHz for CPU. <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>expandable_reservation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – In a resource pool with an expandable reservation, the reservation
|
|||
|
|
can grow beyond the specified value, if the parent resource pool
|
|||
|
|
has unreserved resources. A non-expandable reservation is called a
|
|||
|
|
fixed reservation. <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>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The utilization of a resource pool will not exceed this limit, even
|
|||
|
|
if there are available resources. This is typically used to ensure
|
|||
|
|
a consistent performance of resource pools independent of available
|
|||
|
|
resources. If set to -1, then there is no fixed limit on resource
|
|||
|
|
usage (only bounded by available resources and shares). Units are
|
|||
|
|
MB for memory, and MHz for CPU. <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>shares</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.Shares" title="com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.Shares"><code class="xref py py-class docutils literal notranslate"><span class="pre">Shares</span></code></a>) – Shares are used in case of resource contention. <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.config.components.managementcluster_client.ResourceConfigSpec">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.</span></code><code class="sig-name descname"><span class="pre">ResourceConfigSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cpu_allocation</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">memory_allocation</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.config.components.managementcluster_client.ResourceConfigSpec" 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">ResourceConfigSpec</span></code> class provides resource reserved for a resource
|
|||
|
|
pool or management virtual machine. <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>cpu_allocation</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.ResourceAllocationInfo" title="com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.ResourceAllocationInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceAllocationInfo</span></code></a>) – Resource allocation information for CPU. <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>memory_allocation</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.ResourceAllocationInfo" title="com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.ResourceAllocationInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceAllocationInfo</span></code></a>) – Resource allocation information for memory. <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.config.components.managementcluster_client.ResourcePool">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.</span></code><code class="sig-name descname"><span class="pre">ResourcePool</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">parent_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">config</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">vm</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.config.components.managementcluster_client.ResourcePool" 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">ResourcePool</span></code> class contains information about the management
|
|||
|
|
resource pools present in the cluster. <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 vCenter Server resource pool. <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>parent_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Absolute path from root folder to resource pool’s parent.
|
|||
|
|
<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>config</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.ResourceConfigSpec" title="com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.ResourceConfigSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceConfigSpec</span></code></a>) – Summary of the resource pool containing the resource 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>vm</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.config.components.managementcluster_client.ManagementVirtualMachine" title="com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.ManagementVirtualMachine"><code class="xref py py-class docutils literal notranslate"><span class="pre">ManagementVirtualMachine</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The management virtual machines contained in this resource pool.
|
|||
|
|
<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 or empty, no virtual machine is expected to run in this
|
|||
|
|
resource pool..</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.Shares">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.</span></code><code class="sig-name descname"><span class="pre">Shares</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">level</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">shares</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.config.components.managementcluster_client.Shares" 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">Shares</span></code> class provides specification of shares.</p>
|
|||
|
|
<p>Shares are used to determine relative allocation between resource
|
|||
|
|
consumers. In general, a consumer with more shares gets proportionally more
|
|||
|
|
of the resource, subject to certain other constraints.. <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>level</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.Shares.Level" title="com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.Shares.Level"><code class="xref py py-class docutils literal notranslate"><span class="pre">Shares.Level</span></code></a>) – The allocation level. It maps to a pre-determined set of numeric
|
|||
|
|
values for shares. If the shares value does not map to a predefined
|
|||
|
|
size, then the level is set as CUSTOM. <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>shares</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – <p>When <code class="xref py py-attr docutils literal notranslate"><span class="pre">Shares.level</span></code> is set to CUSTOM, it is the number of
|
|||
|
|
shares allocated. Otherwise, this value is ignored.</p>
|
|||
|
|
<p>There is no unit for this value. It is a relative measure based on
|
|||
|
|
the settings for other resource pools.. <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>
|
|||
|
|
</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.Shares.Level">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Level</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.config.components.managementcluster_client.Shares.Level" 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">Shares.Level</span></code> class defines the possible values for the allocation
|
|||
|
|
level. <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">Level</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.Shares.Level.CUSTOM">
|
|||
|
|
<code class="sig-name descname"><span class="pre">CUSTOM</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Level(string='CUSTOM')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.Shares.Level.CUSTOM" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>If <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>, in case there is resource contention the server uses the
|
|||
|
|
shares value to determine the resource allocation. <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.config.components.managementcluster_client.Shares.Level.HIGH">
|
|||
|
|
<code class="sig-name descname"><span class="pre">HIGH</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Level(string='HIGH')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.Shares.Level.HIGH" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><dl class="simple">
|
|||
|
|
<dt>For CPU: Shares = 2000 * nmumber of virtual CPUs.</dt><dd><p>For Memory: Shares = 20 * virtual machine memory size in MB.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<p>. <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.config.components.managementcluster_client.Shares.Level.LOW">
|
|||
|
|
<code class="sig-name descname"><span class="pre">LOW</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Level(string='LOW')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.Shares.Level.LOW" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><dl class="simple">
|
|||
|
|
<dt>For CPU: Shares = 500 * number of virtual CPUs.</dt><dd><p>For Memory: Shares = 5 * virtual machine memory size in MB.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<p>. <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.config.components.managementcluster_client.Shares.Level.NORMAL">
|
|||
|
|
<code class="sig-name descname"><span class="pre">NORMAL</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Level(string='NORMAL')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.Shares.Level.NORMAL" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><dl class="simple">
|
|||
|
|
<dt>For CPU: Shares = 1000 * number of virtual CPUs.</dt><dd><p>For Memory: Shares = 10 * virtual machine memory size in MB.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<p>. <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.config.components.managementcluster_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.config.components.managementcluster_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.config.components.managementcluster_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>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div class="section" id="module-com.vmware.appliance.vcenter.settings.v1.config.components.vsphereuiconfiguration_client">
|
|||
|
|
<span id="com-vmware-appliance-vcenter-settings-v1-config-components-vsphereuiconfiguration-client-module"></span><h2>com.vmware.appliance.vcenter.settings.v1.config.components.vsphereuiconfiguration_client module<a class="headerlink" href="#module-com.vmware.appliance.vcenter.settings.v1.config.components.vsphereuiconfiguration_client" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.vsphereuiconfiguration_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.config.components.vsphereuiconfiguration_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.config.components.vsphereuiconfiguration_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.config.components.vsphereuiconfiguration_client.VsphereUIConfiguration">
|
|||
|
|
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.vsphereuiconfiguration_client.</span></code><code class="sig-name descname"><span class="pre">VsphereUIConfiguration</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">enable_idp_configuration</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">enable_cloud_admin_role_protection</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">enable_deprecated_vc_alert</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">enable_intercom_chat</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">enable_file_browser_download_upload_from_vc</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">enable_hybrid_management</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">enable_ceip</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">help_url_pointing_to_aws</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">enable_ad_iwa_ids</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">enable_csp_oidc_federation</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.config.components.vsphereuiconfiguration_client.VsphereUIConfiguration" 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><code class="docutils literal notranslate"><span class="pre">VsphereUIConfiguration</span></code> class This spec is used to configure the
|
|||
|
|
behavior of the vsphere-ui service.</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>enable_idp_configuration</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Property to configure the IDPConfiguration view, with this enabled,
|
|||
|
|
user will be able to view and configure IDP</p></li>
|
|||
|
|
<li><p><strong>enable_cloud_admin_role_protection</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Property to enable CloudAdminRoleProtection in the UI</p></li>
|
|||
|
|
<li><p><strong>enable_deprecated_vc_alert</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Property to enable DeprecatedVcAlert in the UI</p></li>
|
|||
|
|
<li><p><strong>enable_intercom_chat</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Property to enable Intercom Chat in the UI</p></li>
|
|||
|
|
<li><p><strong>enable_file_browser_download_upload_from_vc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Property to enable file browser download and upload from VC</p></li>
|
|||
|
|
<li><p><strong>enable_hybrid_management</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Property to enable hybrid management view.</p></li>
|
|||
|
|
<li><p><strong>enable_ceip</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Property to enable CEIP view from Administration -> Deployment.</p></li>
|
|||
|
|
<li><p><strong>help_url_pointing_to_aws</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Property that indicates that Help url should point to url for AWS.</p></li>
|
|||
|
|
<li><p><strong>enable_ad_iwa_ids</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Property that indicates Identity Source of type IWA should be
|
|||
|
|
enabled.</p></li>
|
|||
|
|
<li><p><strong>enable_csp_oidc_federation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Property that indicates CSP OIDC identity provider configured in
|
|||
|
|
vCenter.</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.config.components.inventory.html" class="btn btn-neutral float-right" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
|||
|
|
<a href="com.vmware.appliance.vcenter.settings.v1.config.html" class="btn btn-neutral float-left" title="com.vmware.appliance.vcenter.settings.v1.config package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<hr/>
|
|||
|
|
|
|||
|
|
<div role="contentinfo">
|
|||
|
|
<p>
|
|||
|
|
© Copyright 2022, VMware, Inc..
|
|||
|
|
|
|||
|
|
</p>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
|||
|
|
|
|||
|
|
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
|||
|
|
|
|||
|
|
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|||
|
|
|
|||
|
|
</footer>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
</section>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script type="text/javascript">
|
|||
|
|
jQuery(function () {
|
|||
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|||
|
|
});
|
|||
|
|
</script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</body>
|
|||
|
|
</html>
|