mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-29 20:09:58 -05:00
1404 lines
130 KiB
HTML
1404 lines
130 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. 7.0.1.0 documentation</title>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
|||
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<!--[if lt IE 9]>
|
|||
|
|
<script src="_static/js/html5shiv.min.js"></script>
|
|||
|
|
<![endif]-->
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
|||
|
|
<script src="_static/jquery.js"></script>
|
|||
|
|
<script src="_static/underscore.js"></script>
|
|||
|
|
<script src="_static/doctools.js"></script>
|
|||
|
|
<script src="_static/language_data.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.cis package" href="com.vmware.cis.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" alt="Documentation Home"> vSphere Automation SDK for Python.
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="version">
|
|||
|
|
7.0.1.0
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div role="search">
|
|||
|
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
|||
|
|
<input type="text" name="q" placeholder="Search docs" />
|
|||
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|||
|
|
<input type="hidden" name="area" value="default" />
|
|||
|
|
</form>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<p class="caption"><span class="caption-text">Contents:</span></p>
|
|||
|
|
<ul class="current">
|
|||
|
|
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
|
|||
|
|
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
|
|||
|
|
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
|||
|
|
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.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="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.ApplianceManagement">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</code><code class="sig-name descname">ApplianceManagement</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">software_update_policy</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">backup_schedules</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">ssh</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">dcui</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">console_cli</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">shell</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">time_zone</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">time_sync</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">ntp</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">syslog</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">local_accounts_policy</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">root_local_account</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">smtp</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">network</span><span class="o">=</span><span class="default_value">None</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>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>) – 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>) – 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>) – 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>) – Get/Set enabled state of BASH. <code class="docutils literal notranslate"><span class="pre">Shell</span></code> class provides methods</p></li>
|
|||
|
|
<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>
|
|||
|
|
<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>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_local_account</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>
|
|||
|
|
<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>
|
|||
|
|
</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">class </em><code class="sig-prename descclassname">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</code><code class="sig-name descname">ApplianceNetwork</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">firewall_rule_policies</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">dns_server_configuration</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">proxy_configuration</span><span class="o">=</span><span class="default_value">None</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>
|
|||
|
|
</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">class </em><code class="sig-prename descclassname">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</code><code class="sig-name descname">BackupSchedule</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">parts</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">backup_password</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">location</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">location_user</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">location_password</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">enable</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">recurrence_info</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">retention_info</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">schedule_id</span><span class="o">=</span><span class="default_value">None</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.Consolecli">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</code><code class="sig-name descname">Consolecli</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">enabled</span><span class="o">=</span><span class="default_value">None</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>) – 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.Dcui">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</code><code class="sig-name descname">Dcui</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">enabled</span><span class="o">=</span><span class="default_value">None</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>) – 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">class </em><code class="sig-prename descclassname">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</code><code class="sig-name descname">DnsServerConfiguration</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mode</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">servers</span><span class="o">=</span><span class="default_value">None</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>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.DnsServerConfiguration.DNSServerMode">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">DNSServerMode</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</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">DHCP</code><em class="property"> = DNSServerMode(string='DHCP')</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.STATIC">
|
|||
|
|
<code class="sig-name descname">STATIC</code><em class="property"> = DNSServerMode(string='STATIC')</em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.DnsServerConfiguration.DNSServerMode.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">class </em><code class="sig-prename descclassname">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</code><code class="sig-name descname">FirewallRulePolicy</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">address</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">prefix</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">policy</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">interface_name</span><span class="o">=</span><span class="default_value">None</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">class </em><code class="sig-name descname">Policy</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</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">ACCEPT</code><em class="property"> = Policy(string='ACCEPT')</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">IGNORE</code><em class="property"> = Policy(string='IGNORE')</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">REJECT</code><em class="property"> = Policy(string='REJECT')</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">RETURN</code><em class="property"> = Policy(string='RETURN')</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.LocalAccounts">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</code><code class="sig-name descname">LocalAccounts</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">fullname</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">roles</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">enabled</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">has_password</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">last_password_change</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">password_expires_at</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">min_days_between_password_change</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">max_days_between_password_change</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">warn_days_before_password_expiration</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">password</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">email</span><span class="o">=</span><span class="default_value">None</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>) – 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>) – Is the user password set.</p></li>
|
|||
|
|
<li><p><strong>last_password_change</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Date and time password was changed.
|
|||
|
|
If None, the password was never set.</p></li>
|
|||
|
|
<li><p><strong>password_expires_at</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Date when the account’s password will expire
|
|||
|
|
If None, the password never expires.</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">class </em><code class="sig-prename descclassname">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</code><code class="sig-name descname">LocalAccountsPolicy</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">max_days</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">min_days</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">warn_days</span><span class="o">=</span><span class="default_value">None</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">class </em><code class="sig-prename descclassname">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</code><code class="sig-name descname">LogForwarding</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">hostname</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">port</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">protocol</span><span class="o">=</span><span class="default_value">None</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>) – 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>) – 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>) – 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">class </em><code class="sig-name descname">Protocol</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</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.TCP">
|
|||
|
|
<code class="sig-name descname">TCP</code><em class="property"> = Protocol(string='TCP')</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">TLS</code><em class="property"> = Protocol(string='TLS')</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">UDP</code><em class="property"> = Protocol(string='UDP')</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">class </em><code class="sig-prename descclassname">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</code><code class="sig-name descname">Ntp</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">servers</span><span class="o">=</span><span class="default_value">None</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">class </em><code class="sig-prename descclassname">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</code><code class="sig-name descname">ProxyConfiguration</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">protocol</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">server</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">port</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">username</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">password</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">enabled</span><span class="o">=</span><span class="default_value">None</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>) – URL of the proxy server</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>) – 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">class </em><code class="sig-name descname">Protocol</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</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">FTP</code><em class="property"> = Protocol(string='FTP')</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">HTTP</code><em class="property"> = Protocol(string='HTTP')</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">HTTPS</code><em class="property"> = Protocol(string='HTTPS')</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">class </em><code class="sig-prename descclassname">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</code><code class="sig-name descname">RecurrenceInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">minute</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">hour</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">days</span><span class="o">=</span><span class="default_value">None</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">class </em><code class="sig-name descname">DayOfWeek</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</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">FRIDAY</code><em class="property"> = DayOfWeek(string='FRIDAY')</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">MONDAY</code><em class="property"> = DayOfWeek(string='MONDAY')</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">SATURDAY</code><em class="property"> = DayOfWeek(string='SATURDAY')</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">SUNDAY</code><em class="property"> = DayOfWeek(string='SUNDAY')</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">THURSDAY</code><em class="property"> = DayOfWeek(string='THURSDAY')</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">TUESDAY</code><em class="property"> = DayOfWeek(string='TUESDAY')</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">WEDNESDAY</code><em class="property"> = DayOfWeek(string='WEDNESDAY')</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">class </em><code class="sig-prename descclassname">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</code><code class="sig-name descname">RetentionInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">max_count</span><span class="o">=</span><span class="default_value">None</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">class </em><code class="sig-prename descclassname">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</code><code class="sig-name descname">Shell</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">enabled</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">timeout</span><span class="o">=</span><span class="default_value">None</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>) – 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">class </em><code class="sig-prename descclassname">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</code><code class="sig-name descname">Smtp</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mail_server</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">relay_port</span><span class="o">=</span><span class="default_value">None</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">class </em><code class="sig-prename descclassname">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</code><code class="sig-name descname">SoftwareUpdatePolicy</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">custom_url</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">default_url</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">auto_stage</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">check_schedule</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">username</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">password</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">certificate_check</span><span class="o">=</span><span class="default_value">None</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>custom_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> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.SoftwareUpdatePolicy.AutoUpdateNotification" title="com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.SoftwareUpdatePolicy.AutoUpdateNotification"><code class="xref py py-class docutils literal notranslate"><span class="pre">SoftwareUpdatePolicy.AutoUpdateNotification</span></code></a>) – Check for update at the pre-configured repository URL.</p></li>
|
|||
|
|
<li><p><strong>check_schedule</strong> (<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>certificate_check</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</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">class </em><code class="sig-name descname">AutoUpdateNotification</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</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">DISABLED</code><em class="property"> = AutoUpdateNotification(string='DISABLED')</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">ENABLED</code><em class="property"> = AutoUpdateNotification(string='ENABLED')</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">class </em><code class="sig-prename descclassname">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</code><code class="sig-name descname">Ssh</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">enabled</span><span class="o">=</span><span class="default_value">None</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>) – 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">class </em><code class="sig-prename descclassname">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</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">class </em><code class="sig-prename descclassname">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</code><code class="sig-name descname">Time</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">hour</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">minute</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">day</span><span class="o">=</span><span class="default_value">None</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">class </em><code class="sig-name descname">UpdateDay</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</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">EVERYDAY</code><em class="property"> = UpdateDay(string='EVERYDAY')</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">FRIDAY</code><em class="property"> = UpdateDay(string='FRIDAY')</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">MONDAY</code><em class="property"> = UpdateDay(string='MONDAY')</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">SATURDAY</code><em class="property"> = UpdateDay(string='SATURDAY')</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">SUNDAY</code><em class="property"> = UpdateDay(string='SUNDAY')</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">THURSDAY</code><em class="property"> = UpdateDay(string='THURSDAY')</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">TUESDAY</code><em class="property"> = UpdateDay(string='TUESDAY')</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">WEDNESDAY</code><em class="property"> = UpdateDay(string='WEDNESDAY')</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">class </em><code class="sig-prename descclassname">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</code><code class="sig-name descname">Timesync</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mode</span><span class="o">=</span><span class="default_value">None</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">class </em><code class="sig-name descname">TimeSyncMode</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</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">DISABLED</code><em class="property"> = TimeSyncMode(string='DISABLED')</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">HOST</code><em class="property"> = TimeSyncMode(string='HOST')</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">NTP</code><em class="property"> = TimeSyncMode(string='NTP')</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">class </em><code class="sig-prename descclassname">com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.</code><code class="sig-name descname">Timezone</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">None</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>
|
|||
|
|
|
|||
|
|
</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">class </em><code class="sig-prename descclassname">com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.</code><code class="sig-name descname">AuthenticationManagement</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">privileges_list</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">global_permission_list</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">role_list</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">password_policy</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">token_policy</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">lockout_policy</span><span class="o">=</span><span class="default_value">None</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_list</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_permission_list</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>role_list</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">class </em><code class="sig-prename descclassname">com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.</code><code class="sig-name descname">GlobalPermission</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">principal</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">role_ids</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">propagate</span><span class="o">=</span><span class="default_value">None</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.authmanagement_client.Principal" title="com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.Principal"><code class="xref py py-class docutils literal notranslate"><span class="pre">Principal</span></code></a>) – Role identifier.</p></li>
|
|||
|
|
<li><p><strong>role_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">long</span></code>) – Role Ids 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">class </em><code class="sig-prename descclassname">com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.</code><code class="sig-name descname">LockoutPolicy</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">failed_login_attempts</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">failure_interval</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">unlock_time</span><span class="o">=</span><span class="default_value">None</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">class </em><code class="sig-prename descclassname">com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.</code><code class="sig-name descname">PasswordPolicy</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">special_chars</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">alpha_chars</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">uppercase_chars</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">lowercase_chars</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">numeric_chars</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">adj_identical_chars</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">password_reuse</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">max_life</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">max_length</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">min_length</span><span class="o">=</span><span class="default_value">None</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.Principal">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.</code><code class="sig-name descname">Principal</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">group</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_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>
|
|||
|
|
<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.authmanagement_client.Privileges">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.</code><code class="sig-name descname">Privileges</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">description</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">group</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">is_on_parent</span><span class="o">=</span><span class="default_value">None</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>) – 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>) – Is on parent.</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">class </em><code class="sig-prename descclassname">com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.</code><code class="sig-name descname">Roles</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">description</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">privilege_id</span><span class="o">=</span><span class="default_value">None</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>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Role identifier.</p></li>
|
|||
|
|
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Role name.</p></li>
|
|||
|
|
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Role description.</p></li>
|
|||
|
|
<li><p><strong>privilege_id</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 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">class </em><code class="sig-prename descclassname">com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</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">class </em><code class="sig-prename descclassname">com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.</code><code class="sig-name descname">TokenPolicy</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">clock_tolerance</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">token_renewal</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">token_delegation</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">bearer_refresh</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">hok_refresh</span><span class="o">=</span><span class="default_value">None</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>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<footer>
|
|||
|
|
|
|||
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|||
|
|
|
|||
|
|
<a href="com.vmware.cis.html" class="btn btn-neutral float-right" title="com.vmware.cis package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></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"></span> Previous</a>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<hr/>
|
|||
|
|
|
|||
|
|
<div role="contentinfo">
|
|||
|
|
<p>
|
|||
|
|
|
|||
|
|
© Copyright 2020, VMware, Inc.
|
|||
|
|
|
|||
|
|
</p>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
|
|||
|
|
|
|||
|
|
<a href="https://github.com/rtfd/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>
|