mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-22 09:39:58 -05:00
7316 lines
709 KiB
HTML
7316 lines
709 KiB
HTML
|
||
|
||
<!DOCTYPE html>
|
||
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
||
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
||
<head>
|
||
<meta charset="utf-8">
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
|
||
<title>com.vmware.vmc package — VMware Cloud on AWS Console API 1.3.1 documentation</title>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||
<link rel="index" title="Index" href="genindex.html" />
|
||
<link rel="search" title="Search" href="search.html" />
|
||
<link rel="next" title="com.vmware.vmc.orgs package" href="com.vmware.vmc.orgs.html" />
|
||
<link rel="prev" title="com.vmware package" href="com.vmware.html" />
|
||
|
||
|
||
<script src="_static/js/modernizr.min.js"></script>
|
||
|
||
</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"> VMware Cloud on AWS Console API
|
||
|
||
|
||
|
||
</a>
|
||
|
||
|
||
|
||
|
||
<div class="version">
|
||
1.3.1
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||
<input type="text" name="q" placeholder="Search docs" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<p class="caption"><span class="caption-text">Contents:</span></p>
|
||
<ul class="current">
|
||
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
|
||
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
|
||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vmc_client">com.vmware.vmc_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">VMware Cloud on AWS Console API</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">Docs</a> »</li>
|
||
|
||
<li><a href="com.html">com package</a> »</li>
|
||
|
||
<li><a href="com.vmware.html">com.vmware package</a> »</li>
|
||
|
||
<li>com.vmware.vmc package</li>
|
||
|
||
|
||
<li class="wy-breadcrumbs-aside">
|
||
|
||
|
||
<a href="_sources/com.vmware.vmc.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.vmc">
|
||
<span id="com-vmware-vmc-package"></span><h1>com.vmware.vmc package<a class="headerlink" href="#module-com.vmware.vmc" title="Permalink to this headline">¶</a></h1>
|
||
<div class="section" id="subpackages">
|
||
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
|
||
<div class="toctree-wrapper compound">
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vmc.orgs.html">com.vmware.vmc.orgs package</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vmc.orgs.html#subpackages">Subpackages</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.html">com.vmware.vmc.orgs.sddcs package</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.html#subpackages">Subpackages</a><ul>
|
||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.html">com.vmware.vmc.orgs.sddcs.networks package</a><ul>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.html#subpackages">Subpackages</a><ul>
|
||
<li class="toctree-l7"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.cgws.html">com.vmware.vmc.orgs.sddcs.networks.cgws package</a><ul>
|
||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.cgws.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.cgws.html#module-com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client">com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l7"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.edges.html">com.vmware.vmc.orgs.sddcs.networks.edges package</a><ul>
|
||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.edges.html#subpackages">Subpackages</a><ul>
|
||
<li class="toctree-l9"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.edges.firewall.html">com.vmware.vmc.orgs.sddcs.networks.edges.firewall package</a><ul>
|
||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.edges.firewall.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.edges.firewall.html#module-com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client">com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l9"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.html">com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn package</a><ul>
|
||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.html#module-com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.config_client">com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.config_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l9"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.edges.nat.html">com.vmware.vmc.orgs.sddcs.networks.edges.nat package</a><ul>
|
||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.edges.nat.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.edges.nat.html#module-com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client">com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l9"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.edges.statistics.html">com.vmware.vmc.orgs.sddcs.networks.edges.statistics package</a><ul>
|
||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.edges.statistics.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.edges.statistics.html#module-com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client">com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client module</a></li>
|
||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.edges.statistics.html#module-com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client">com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.edges.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.edges.html#module-com.vmware.vmc.orgs.sddcs.networks.edges.dhcp_client">com.vmware.vmc.orgs.sddcs.networks.edges.dhcp_client module</a></li>
|
||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.edges.html#module-com.vmware.vmc.orgs.sddcs.networks.edges.dns_client">com.vmware.vmc.orgs.sddcs.networks.edges.dns_client module</a></li>
|
||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.edges.html#module-com.vmware.vmc.orgs.sddcs.networks.edges.firewall_client">com.vmware.vmc.orgs.sddcs.networks.edges.firewall_client module</a></li>
|
||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.edges.html#module-com.vmware.vmc.orgs.sddcs.networks.edges.ipsec_client">com.vmware.vmc.orgs.sddcs.networks.edges.ipsec_client module</a></li>
|
||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.edges.html#module-com.vmware.vmc.orgs.sddcs.networks.edges.nat_client">com.vmware.vmc.orgs.sddcs.networks.edges.nat_client module</a></li>
|
||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.edges.html#module-com.vmware.vmc.orgs.sddcs.networks.edges.statistics_client">com.vmware.vmc.orgs.sddcs.networks.edges.statistics_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.html#module-com.vmware.vmc.orgs.sddcs.networks.edges_client">com.vmware.vmc.orgs.sddcs.networks.edges_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.html#module-com.vmware.vmc.orgs.sddcs.dns_client">com.vmware.vmc.orgs.sddcs.dns_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.html#module-com.vmware.vmc.orgs.sddcs.networking_client">com.vmware.vmc.orgs.sddcs.networking_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.html#module-com.vmware.vmc.orgs.sddcs.networks_client">com.vmware.vmc.orgs.sddcs.networks_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vmc.orgs.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vmc.orgs.html#module-com.vmware.vmc.orgs.account_link_client">com.vmware.vmc.orgs.account_link_client module</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vmc.orgs.html#module-com.vmware.vmc.orgs.reservations_client">com.vmware.vmc.orgs.reservations_client module</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vmc.orgs.html#module-com.vmware.vmc.orgs.sddcs_client">com.vmware.vmc.orgs.sddcs_client module</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vmc.orgs.html#module-com.vmware.vmc.orgs.storage_client">com.vmware.vmc.orgs.storage_client module</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vmc.orgs.html#module-com.vmware.vmc.orgs.subscriptions_client">com.vmware.vmc.orgs.subscriptions_client module</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vmc.orgs.html#module-com.vmware.vmc.orgs.tbrs_client">com.vmware.vmc.orgs.tbrs_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="submodules">
|
||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||
</div>
|
||
<div class="section" id="module-com.vmware.vmc.model_client">
|
||
<span id="com-vmware-vmc-model-client-module"></span><h2>com.vmware.vmc.model_client module<a class="headerlink" href="#module-com.vmware.vmc.model_client" title="Permalink to this headline">¶</a></h2>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.AbstractEntity">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">AbstractEntity</code><span class="sig-paren">(</span><em>updated=None</em>, <em>user_id=None</em>, <em>updated_by_user_id=None</em>, <em>created=None</em>, <em>version=None</em>, <em>updated_by_user_name=None</em>, <em>user_name=None</em>, <em>id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.AbstractEntity" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>updated</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – </li>
|
||
<li><strong>user_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User id that last updated this record</li>
|
||
<li><strong>updated_by_user_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User id that last updated this record</li>
|
||
<li><strong>created</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – </li>
|
||
<li><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Version of this entity format: int32</li>
|
||
<li><strong>updated_by_user_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>) – User name that last updated this record</li>
|
||
<li><strong>user_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User name that last updated this record</li>
|
||
<li><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Unique ID for this entity</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.AccountLinkConfig">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">AccountLinkConfig</code><span class="sig-paren">(</span><em>delay_account_link=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.AccountLinkConfig" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>delay_account_link</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>) – Boolean flag identifying whether account linking should be delayed
|
||
or not for the SDDC.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.AccountLinkSddcConfig">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">AccountLinkSddcConfig</code><span class="sig-paren">(</span><em>customer_subnet_ids=None</em>, <em>connected_account_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.AccountLinkSddcConfig" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>customer_subnet_ids</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>connected_account_id</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 ID of the customer connected account to work with.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.AddressFWSourceDestination">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">AddressFWSourceDestination</code><span class="sig-paren">(</span><em>exclude=None</em>, <em>ip_address=None</em>, <em>grouping_object_id=None</em>, <em>vnic_group_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.AddressFWSourceDestination" 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>Source or Destination for firewall rule. Default is ‘any’.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>exclude</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>) – Exclude the specified source or destination.</li>
|
||
<li><strong>ip_address</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 string. Can specify single IP address, range of IP address,
|
||
or in CIDR format. Can define multiple.</li>
|
||
<li><strong>grouping_object_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> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of string. Id of cluster, datacenter, distributedPortGroup,
|
||
legacyPortGroup, VirtualMachine, vApp, resourcePool, logicalSwitch,
|
||
IPSet, securityGroup. Can define multiple.</li>
|
||
<li><strong>vnic_group_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> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of string. Possible values are vnic-index-[1-9], vse, external
|
||
or internal. Can define multiple.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.Agent">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">Agent</code><span class="sig-paren">(</span><em>addresses=None</em>, <em>reserved_ip=None</em>, <em>healthy=None</em>, <em>custom_properties=None</em>, <em>last_health_status_change=None</em>, <em>cert_enabled=None</em>, <em>internal_ip=None</em>, <em>hostname_verifier_enabled=None</em>, <em>network_netmask=None</em>, <em>network_gateway=None</em>, <em>provider='Agent'</em>, <em>is_master=None</em>, <em>network_cidr=None</em>, <em>id=None</em>, <em>agent_url=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.Agent" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>addresses</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>) – </li>
|
||
<li><strong>reserved_ip</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>) – </li>
|
||
<li><strong>healthy</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>) – </li>
|
||
<li><strong>custom_properties</strong> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>last_health_status_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>) – </li>
|
||
<li><strong>cert_enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Boolean flag to indicate if the agent is using CA signed
|
||
certificate</li>
|
||
<li><strong>internal_ip</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>) – </li>
|
||
<li><strong>hostname_verifier_enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Boolean flag to indicate if the agent is using FQDN in the
|
||
certificate</li>
|
||
<li><strong>network_netmask</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>) – </li>
|
||
<li><strong>network_gateway</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </li>
|
||
<li><strong>is_master</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>) – Boolean flag to indicate if the agent is the master</li>
|
||
<li><strong>network_cidr</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>) – </li>
|
||
<li><strong>id</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>) – </li>
|
||
<li><strong>agent_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>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.AmiInfo">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">AmiInfo</code><span class="sig-paren">(</span><em>region=None</em>, <em>id=None</em>, <em>name=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.AmiInfo" 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 AmiInfo used for deploying esx of the sddc</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>region</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 region of the esx ami</li>
|
||
<li><strong>id</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 ami id for the esx</li>
|
||
<li><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>) – the name of the esx ami</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.AppliancesSummary">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">AppliancesSummary</code><span class="sig-paren">(</span><em>data_store_moid_of_active_vse=None</em>, <em>enable_fips=None</em>, <em>host_name_of_active_vse=None</em>, <em>vm_build_info=None</em>, <em>deploy_appliances=None</em>, <em>communication_channel=None</em>, <em>vm_name_of_active_vse=None</em>, <em>number_of_deployed_vms=None</em>, <em>resource_pool_moid_of_active_vse=None</em>, <em>data_store_name_of_active_vse=None</em>, <em>vm_moid_of_active_vse=None</em>, <em>status_from_vse_updated_on=None</em>, <em>fqdn=None</em>, <em>appliance_size=None</em>, <em>resource_pool_name_of_active_vse=None</em>, <em>active_vse_ha_index=None</em>, <em>vm_version=None</em>, <em>host_moid_of_active_vse=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.AppliancesSummary" 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>NSX Edge appliance summary.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>data_store_moid_of_active_vse</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>) – vCenter MOID of the active NSX Edge appliance’s data store.</li>
|
||
<li><strong>enable_fips</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>) – Value is true if FIPS is enabled on NSX Edge appliance.</li>
|
||
<li><strong>host_name_of_active_vse</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>) – Host name of the active NSX Edge appliance.</li>
|
||
<li><strong>vm_build_info</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>) – NSX Edge appliance build version.</li>
|
||
<li><strong>deploy_appliances</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>) – Value is true if NSX Edge appliances are to be deployed.</li>
|
||
<li><strong>communication_channel</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>) – Communication channel used to communicate with NSX Edge appliance.</li>
|
||
<li><strong>vm_name_of_active_vse</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Name of the active NSX Edge appliance.</li>
|
||
<li><strong>number_of_deployed_vms</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 deployed appliances of the NSX Edge. format: int32</li>
|
||
<li><strong>resource_pool_moid_of_active_vse</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>) – vCenter MOID of the active NSX Edge appliance’s resource
|
||
pool/cluster. Can be resource pool ID, e.g. resgroup-15 or cluster
|
||
ID, e.g. domain-c41.</li>
|
||
<li><strong>data_store_name_of_active_vse</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>) – Datastore name of the active NSX Edge appliance.</li>
|
||
<li><strong>vm_moid_of_active_vse</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>) – vCenter MOID of the active NSX Edge appliance.</li>
|
||
<li><strong>status_from_vse_updated_on</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>) – Time stamp value when healthcheck status was last updated for the
|
||
NSX Edge appliance. format: int64</li>
|
||
<li><strong>fqdn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – FQDN of the NSX Edge.</li>
|
||
<li><strong>appliance_size</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>) – NSX Edge appliance size.</li>
|
||
<li><strong>resource_pool_name_of_active_vse</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>) – Resource Pool/Cluster name of the active NSX Edge appliance.</li>
|
||
<li><strong>active_vse_ha_index</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>) – HA index of the active NSX Edge appliance. format: int32</li>
|
||
<li><strong>vm_version</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>) – NSX Edge appliance version.</li>
|
||
<li><strong>host_moid_of_active_vse</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>) – vCenter MOID of the active NSX Edge appliance’s host.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.Application">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">Application</code><span class="sig-paren">(</span><em>application_id=None</em>, <em>service=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.Application" 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>Application for firewall rule</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>application_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> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of string. Id of service or serviceGroup groupingObject. Can
|
||
define multiple.</li>
|
||
<li><strong>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.Nsxfirewallservice" title="com.vmware.vmc.model_client.Nsxfirewallservice"><code class="xref py py-class docutils literal notranslate"><span class="pre">Nsxfirewallservice</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of protocol and ports. Can define multiple.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.AwsAgent">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">AwsAgent</code><span class="sig-paren">(</span><em>instance_id=None</em>, <em>key_pair=None</em>, <em>addresses=None</em>, <em>reserved_ip=None</em>, <em>healthy=None</em>, <em>custom_properties=None</em>, <em>last_health_status_change=None</em>, <em>cert_enabled=None</em>, <em>internal_ip=None</em>, <em>hostname_verifier_enabled=None</em>, <em>network_netmask=None</em>, <em>network_gateway=None</em>, <em>provider='AWS'</em>, <em>is_master=None</em>, <em>network_cidr=None</em>, <em>id=None</em>, <em>agent_url=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.AwsAgent" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>instance_id</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>) – </li>
|
||
<li><strong>key_pair</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.AwsKeyPair" title="com.vmware.vmc.model_client.AwsKeyPair"><code class="xref py py-class docutils literal notranslate"><span class="pre">AwsKeyPair</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>addresses</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>) – </li>
|
||
<li><strong>reserved_ip</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>) – </li>
|
||
<li><strong>healthy</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>) – </li>
|
||
<li><strong>custom_properties</strong> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>last_health_status_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>) – </li>
|
||
<li><strong>cert_enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Boolean flag to indicate if the agent is using CA signed
|
||
certificate</li>
|
||
<li><strong>internal_ip</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>) – </li>
|
||
<li><strong>hostname_verifier_enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Boolean flag to indicate if the agent is using FQDN in the
|
||
certificate</li>
|
||
<li><strong>network_netmask</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>) – </li>
|
||
<li><strong>network_gateway</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </li>
|
||
<li><strong>is_master</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>) – Boolean flag to indicate if the agent is the master</li>
|
||
<li><strong>network_cidr</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>) – </li>
|
||
<li><strong>id</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>) – </li>
|
||
<li><strong>agent_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>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.AwsCloudProvider">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">AwsCloudProvider</code><span class="sig-paren">(</span><em>regions=None</em>, <em>provider='AWS'</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.AwsCloudProvider" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>regions</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>) – </li>
|
||
<li><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the Cloud Provider</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.AwsCompatibleSubnets">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">AwsCompatibleSubnets</code><span class="sig-paren">(</span><em>customer_available_zones=None</em>, <em>vpc_map=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.AwsCompatibleSubnets" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>customer_available_zones</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>) – </li>
|
||
<li><strong>vpc_map</strong> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vmc.model_client.VpcInfoSubnets" title="com.vmware.vmc.model_client.VpcInfoSubnets"><code class="xref py py-class docutils literal notranslate"><span class="pre">VpcInfoSubnets</span></code></a>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.AwsCustomerConnectedAccount">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">AwsCustomerConnectedAccount</code><span class="sig-paren">(</span><em>updated=None</em>, <em>user_id=None</em>, <em>updated_by_user_id=None</em>, <em>created=None</em>, <em>version=None</em>, <em>updated_by_user_name=None</em>, <em>user_name=None</em>, <em>id=None</em>, <em>policy_payer_arn=None</em>, <em>account_number=None</em>, <em>policy_external_id=None</em>, <em>region_to_az_to_shadow_mapping=None</em>, <em>org_id=None</em>, <em>cf_stack_name=None</em>, <em>policy_service_arn=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.AwsCustomerConnectedAccount" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>updated</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – </li>
|
||
<li><strong>user_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User id that last updated this record</li>
|
||
<li><strong>updated_by_user_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User id that last updated this record</li>
|
||
<li><strong>created</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – </li>
|
||
<li><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Version of this entity format: int32</li>
|
||
<li><strong>updated_by_user_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>) – User name that last updated this record</li>
|
||
<li><strong>user_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User name that last updated this record</li>
|
||
<li><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Unique ID for this entity</li>
|
||
<li><strong>policy_payer_arn</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>) – </li>
|
||
<li><strong>account_number</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>) – </li>
|
||
<li><strong>policy_external_id</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>) – </li>
|
||
<li><strong>region_to_az_to_shadow_mapping</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Provides a map of regions to availability zones from the shadow
|
||
account’s perspective</li>
|
||
<li><strong>org_id</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>) – </li>
|
||
<li><strong>cf_stack_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>) – </li>
|
||
<li><strong>policy_service_arn</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>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.AwsEsxHost">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">AwsEsxHost</code><span class="sig-paren">(</span><em>internal_public_ip_pool=None</em>, <em>name=None</em>, <em>availability_zone=None</em>, <em>esx_id=None</em>, <em>hostname=None</em>, <em>provider='AWS'</em>, <em>mac_address=None</em>, <em>custom_properties=None</em>, <em>esx_state=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.AwsEsxHost" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>internal_public_ip_pool</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.SddcPublicIp" title="com.vmware.vmc.model_client.SddcPublicIp"><code class="xref py py-class docutils literal notranslate"><span class="pre">SddcPublicIp</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><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>) – </li>
|
||
<li><strong>availability_zone</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>) – Availability zone where the host is provisioned.</li>
|
||
<li><strong>esx_id</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>) – </li>
|
||
<li><strong>hostname</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </li>
|
||
<li><strong>mac_address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>custom_properties</strong> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>esx_state</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>) – <p>Possible values are:</p>
|
||
<ul>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.EsxHost.ESX_STATE_DEPLOYING" title="com.vmware.vmc.model_client.EsxHost.ESX_STATE_DEPLOYING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">EsxHost.ESX_STATE_DEPLOYING</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.EsxHost.ESX_STATE_PROVISIONED" title="com.vmware.vmc.model_client.EsxHost.ESX_STATE_PROVISIONED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">EsxHost.ESX_STATE_PROVISIONED</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.EsxHost.ESX_STATE_READY" title="com.vmware.vmc.model_client.EsxHost.ESX_STATE_READY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">EsxHost.ESX_STATE_READY</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.EsxHost.ESX_STATE_DELETING" title="com.vmware.vmc.model_client.EsxHost.ESX_STATE_DELETING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">EsxHost.ESX_STATE_DELETING</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.EsxHost.ESX_STATE_DELETED" title="com.vmware.vmc.model_client.EsxHost.ESX_STATE_DELETED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">EsxHost.ESX_STATE_DELETED</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.EsxHost.ESX_STATE_FAILED" title="com.vmware.vmc.model_client.EsxHost.ESX_STATE_FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">EsxHost.ESX_STATE_FAILED</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.AwsKeyPair">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">AwsKeyPair</code><span class="sig-paren">(</span><em>key_name=None</em>, <em>key_fingerprint=None</em>, <em>key_material=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.AwsKeyPair" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>key_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>) – </li>
|
||
<li><strong>key_fingerprint</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>) – </li>
|
||
<li><strong>key_material</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>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.AwsKmsInfo">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">AwsKmsInfo</code><span class="sig-paren">(</span><em>amazon_resource_name=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.AwsKmsInfo" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>amazon_resource_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The ARN associated with the customer master key for this cluster.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.AwsSddcConfig">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">AwsSddcConfig</code><span class="sig-paren">(</span><em>region=None</em>, <em>storage_capacity=None</em>, <em>name=None</em>, <em>account_link_sddc_config=None</em>, <em>vpc_cidr=None</em>, <em>num_hosts=None</em>, <em>sddc_type=None</em>, <em>vxlan_subnet=None</em>, <em>account_link_config=None</em>, <em>provider='AWS'</em>, <em>skip_creating_vxlan=None</em>, <em>sso_domain=None</em>, <em>sddc_template_id=None</em>, <em>deployment_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.AwsSddcConfig" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>region</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </li>
|
||
<li><strong>storage_capacity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The storage capacity value to be requested for the sddc primary
|
||
cluster, in GiBs. If provided, instead of using the direct-attached
|
||
storage, a capacity value amount of seperable storage will be used.
|
||
format: int64</li>
|
||
<li><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </li>
|
||
<li><strong>account_link_sddc_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.AccountLinkSddcConfig" title="com.vmware.vmc.model_client.AccountLinkSddcConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">AccountLinkSddcConfig</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – A list of the SDDC linking configurations to use.</li>
|
||
<li><strong>vpc_cidr</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>) – AWS VPC IP range. Only prefix of 16 or 20 is currently supported.</li>
|
||
<li><strong>num_hosts</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – </li>
|
||
<li><strong>sddc_type</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>) – Denotes the sddc type , if the value is null or empty, the type is
|
||
considered as default.</li>
|
||
<li><strong>vxlan_subnet</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>) – VXLAN IP subnet in CIDR for compute gateway</li>
|
||
<li><strong>account_link_config</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.AccountLinkConfig" title="com.vmware.vmc.model_client.AccountLinkConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">AccountLinkConfig</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The account linking configuration, we will keep this one and remove
|
||
accountLinkSddcConfig finally.</li>
|
||
<li><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>Possible values are:</p>
|
||
<ul>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.SddcConfig.PROVIDER_AWS" title="com.vmware.vmc.model_client.SddcConfig.PROVIDER_AWS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SddcConfig.PROVIDER_AWS</span></code></a></li>
|
||
</ul>
|
||
<p>Determines what additional properties are available based on cloud
|
||
provider.</p>
|
||
</li>
|
||
<li><strong>skip_creating_vxlan</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>) – skip creating vxlan for compute gateway for SDDC provisioning</li>
|
||
<li><strong>sso_domain</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 SSO domain name to use for vSphere users. If not specified,
|
||
vmc.local will be used.</li>
|
||
<li><strong>sddc_template_id</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>) – If provided, configuration from the template will applied to the
|
||
provisioned SDDC. format: UUID</li>
|
||
<li><strong>deployment_type</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>) – <p>Possible values are:</p>
|
||
<ul>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.SddcConfig.DEPLOYMENT_TYPE_SINGLEAZ" title="com.vmware.vmc.model_client.SddcConfig.DEPLOYMENT_TYPE_SINGLEAZ"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SddcConfig.DEPLOYMENT_TYPE_SINGLEAZ</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.SddcConfig.DEPLOYMENT_TYPE_MULTIAZ" title="com.vmware.vmc.model_client.SddcConfig.DEPLOYMENT_TYPE_MULTIAZ"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SddcConfig.DEPLOYMENT_TYPE_MULTIAZ</span></code></a></li>
|
||
</ul>
|
||
<p>Denotes if request is for a SingleAZ or a MultiAZ SDDC. Default is
|
||
SingleAZ.</p>
|
||
</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.AwsSddcConnection">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">AwsSddcConnection</code><span class="sig-paren">(</span><em>updated=None</em>, <em>user_id=None</em>, <em>updated_by_user_id=None</em>, <em>created=None</em>, <em>version=None</em>, <em>updated_by_user_name=None</em>, <em>user_name=None</em>, <em>id=None</em>, <em>cidr_block_subnet=None</em>, <em>connected_account_id=None</em>, <em>eni_group=None</em>, <em>subnet_id=None</em>, <em>org_id=None</em>, <em>sddc_id=None</em>, <em>cidr_block_vpc=None</em>, <em>subnet_availability_zone=None</em>, <em>vpc_id=None</em>, <em>is_cgw_present=None</em>, <em>customer_eni_infos=None</em>, <em>default_route_table=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.AwsSddcConnection" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>updated</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – </li>
|
||
<li><strong>user_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User id that last updated this record</li>
|
||
<li><strong>updated_by_user_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User id that last updated this record</li>
|
||
<li><strong>created</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – </li>
|
||
<li><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Version of this entity format: int32</li>
|
||
<li><strong>updated_by_user_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>) – User name that last updated this record</li>
|
||
<li><strong>user_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User name that last updated this record</li>
|
||
<li><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Unique ID for this entity</li>
|
||
<li><strong>cidr_block_subnet</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>) – </li>
|
||
<li><strong>connected_account_id</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>) – </li>
|
||
<li><strong>eni_group</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>) – </li>
|
||
<li><strong>subnet_id</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>) – </li>
|
||
<li><strong>org_id</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>) – </li>
|
||
<li><strong>sddc_id</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>) – </li>
|
||
<li><strong>cidr_block_vpc</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>) – </li>
|
||
<li><strong>subnet_availability_zone</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>) – </li>
|
||
<li><strong>vpc_id</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>) – </li>
|
||
<li><strong>is_cgw_present</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>) – </li>
|
||
<li><strong>customer_eni_infos</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>) – </li>
|
||
<li><strong>default_route_table</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>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.AwsSddcResourceConfig">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">AwsSddcResourceConfig</code><span class="sig-paren">(</span><em>backup_restore_bucket=None</em>, <em>public_ip_pool=None</em>, <em>vpc_info=None</em>, <em>kms_vpc_endpoint=None</em>, <em>max_num_public_ip=None</em>, <em>account_link_sddc_config=None</em>, <em>region=None</em>, <em>vsan_encryption_config=None</em>, <em>vpc_info_peered_agent=None</em>, <em>mgmt_appliance_network_name=None</em>, <em>nsxt=None</em>, <em>mgw_id=None</em>, <em>nsx_mgr_url=None</em>, <em>psc_management_ip=None</em>, <em>psc_url=None</em>, <em>cgws=None</em>, <em>availability_zones=None</em>, <em>management_ds=None</em>, <em>nsx_api_public_endpoint_url=None</em>, <em>custom_properties=None</em>, <em>cloud_password=None</em>, <em>provider='AWS'</em>, <em>clusters=None</em>, <em>vc_management_ip=None</em>, <em>sddc_networks=None</em>, <em>cloud_username=None</em>, <em>esx_hosts=None</em>, <em>nsx_mgr_management_ip=None</em>, <em>vc_instance_id=None</em>, <em>esx_cluster_id=None</em>, <em>vc_public_ip=None</em>, <em>skip_creating_vxlan=None</em>, <em>vc_url=None</em>, <em>sddc_manifest=None</em>, <em>vxlan_subnet=None</em>, <em>cloud_user_group=None</em>, <em>management_rp=None</em>, <em>witness_availability_zone=None</em>, <em>esx_host_subnet=None</em>, <em>sso_domain=None</em>, <em>deployment_type=None</em>, <em>dns_with_management_vm_private_ip=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.AwsSddcResourceConfig" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>backup_restore_bucket</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>) – </li>
|
||
<li><strong>public_ip_pool</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.SddcPublicIp" title="com.vmware.vmc.model_client.SddcPublicIp"><code class="xref py py-class docutils literal notranslate"><span class="pre">SddcPublicIp</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vpc_info</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.VpcInfo" title="com.vmware.vmc.model_client.VpcInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">VpcInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>kms_vpc_endpoint</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.KmsVpcEndpoint" title="com.vmware.vmc.model_client.KmsVpcEndpoint"><code class="xref py py-class docutils literal notranslate"><span class="pre">KmsVpcEndpoint</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>max_num_public_ip</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 public IP that user can allocate.</li>
|
||
<li><strong>account_link_sddc_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.SddcLinkConfig" title="com.vmware.vmc.model_client.SddcLinkConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">SddcLinkConfig</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>region</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>) – </li>
|
||
<li><strong>vsan_encryption_config</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.VsanEncryptionConfig" title="com.vmware.vmc.model_client.VsanEncryptionConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">VsanEncryptionConfig</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vpc_info_peered_agent</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.VpcInfo" title="com.vmware.vmc.model_client.VpcInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">VpcInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>mgmt_appliance_network_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>) – Name for management appliance network.</li>
|
||
<li><strong>nsxt</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>) – if true, NSX-T UI is enabled.</li>
|
||
<li><strong>mgw_id</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>) – Management Gateway Id</li>
|
||
<li><strong>nsx_mgr_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>) – URL of the NSX Manager</li>
|
||
<li><strong>psc_management_ip</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>) – PSC internal management IP</li>
|
||
<li><strong>psc_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>) – URL of the PSC server</li>
|
||
<li><strong>cgws</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>) – </li>
|
||
<li><strong>availability_zones</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>) – Availability zones over which esx hosts are provisioned. MultiAZ
|
||
SDDCs will have hosts provisioned over two availability zones while
|
||
SingleAZ SDDCs will provision over one.</li>
|
||
<li><strong>management_ds</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 ManagedObjectReference of the management Datastore</li>
|
||
<li><strong>nsx_api_public_endpoint_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>) – nsx api entire base url</li>
|
||
<li><strong>custom_properties</strong> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>cloud_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 vCenter SDDC administrator</li>
|
||
<li><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>Possible values are:</p>
|
||
<ul>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.SddcResourceConfig.PROVIDER_AWS" title="com.vmware.vmc.model_client.SddcResourceConfig.PROVIDER_AWS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SddcResourceConfig.PROVIDER_AWS</span></code></a></li>
|
||
</ul>
|
||
<blockquote>
|
||
<div>Discriminator for additional properties</div></blockquote>
|
||
</li>
|
||
<li><strong>clusters</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">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of clusters in the SDDC.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must contain all the attributes defined in
|
||
<a class="reference internal" href="#com.vmware.vmc.model_client.Cluster" title="com.vmware.vmc.model_client.Cluster"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster</span></code></a>. When methods return a value of this class as a
|
||
return value, the attribute will contain all the attributes defined
|
||
in <a class="reference internal" href="#com.vmware.vmc.model_client.Cluster" title="com.vmware.vmc.model_client.Cluster"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster</span></code></a>.</li>
|
||
<li><strong>vc_management_ip</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>) – vCenter internal management IP</li>
|
||
<li><strong>sddc_networks</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>) – </li>
|
||
<li><strong>cloud_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 vCenter SDDC administrator</li>
|
||
<li><strong>esx_hosts</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.AwsEsxHost" title="com.vmware.vmc.model_client.AwsEsxHost"><code class="xref py py-class docutils literal notranslate"><span class="pre">AwsEsxHost</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>nsx_mgr_management_ip</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>) – NSX Manager internal management IP</li>
|
||
<li><strong>vc_instance_id</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>) – unique id of the vCenter server</li>
|
||
<li><strong>esx_cluster_id</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>) – Cluster Id to add ESX workflow</li>
|
||
<li><strong>vc_public_ip</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>) – vCenter public IP</li>
|
||
<li><strong>skip_creating_vxlan</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>) – skip creating vxlan for compute gateway for SDDC provisioning</li>
|
||
<li><strong>vc_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>) – URL of the vCenter server</li>
|
||
<li><strong>sddc_manifest</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.SddcManifest" title="com.vmware.vmc.model_client.SddcManifest"><code class="xref py py-class docutils literal notranslate"><span class="pre">SddcManifest</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vxlan_subnet</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>) – VXLAN IP subnet</li>
|
||
<li><strong>cloud_user_group</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>) – Group name for vCenter SDDC administrator</li>
|
||
<li><strong>management_rp</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>) – </li>
|
||
<li><strong>witness_availability_zone</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>) – Availability zone where the witness node is provisioned for a
|
||
MultiAZ SDDC. This is null for a SingleAZ SDDC.</li>
|
||
<li><strong>esx_host_subnet</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>) – ESX host subnet</li>
|
||
<li><strong>sso_domain</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 SSO domain name to use for vSphere users</li>
|
||
<li><strong>deployment_type</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>) – <p>Possible values are:</p>
|
||
<ul>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.SddcResourceConfig.DEPLOYMENT_TYPE_SINGLE_AZ" title="com.vmware.vmc.model_client.SddcResourceConfig.DEPLOYMENT_TYPE_SINGLE_AZ"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SddcResourceConfig.DEPLOYMENT_TYPE_SINGLE_AZ</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.SddcResourceConfig.DEPLOYMENT_TYPE_MULTI_AZ" title="com.vmware.vmc.model_client.SddcResourceConfig.DEPLOYMENT_TYPE_MULTI_AZ"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SddcResourceConfig.DEPLOYMENT_TYPE_MULTI_AZ</span></code></a></li>
|
||
</ul>
|
||
<blockquote>
|
||
<div>Denotes if this is a SingleAZ SDDC or a MultiAZ SDDC.</div></blockquote>
|
||
</li>
|
||
<li><strong>dns_with_management_vm_private_ip</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>) – if true, use the private IP addresses to register DNS records for
|
||
the management VMs</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.AwsSubnet">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">AwsSubnet</code><span class="sig-paren">(</span><em>connected_account_id=None</em>, <em>region_name=None</em>, <em>availability_zone=None</em>, <em>subnet_id=None</em>, <em>subnet_cidr_block=None</em>, <em>is_compatible=None</em>, <em>vpc_id=None</em>, <em>vpc_cidr_block=None</em>, <em>name=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.AwsSubnet" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>connected_account_id</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 connected account ID this subnet is accessible through. This is
|
||
an internal ID formatted as a UUID specific to Skyscraper.</li>
|
||
<li><strong>region_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 region this subnet is in, usually in the form of country code,
|
||
general location, and a number (ex. us-west-2).</li>
|
||
<li><strong>availability_zone</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 availability zone this subnet is in, which should be the region
|
||
name plus one extra letter (ex. us-west-2a).</li>
|
||
<li><strong>subnet_id</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 subnet ID in AWS, provided in the form ‘subnet-######’.</li>
|
||
<li><strong>subnet_cidr_block</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 CIDR block of the subnet, in the form of ‘#.#.#.#/#’.</li>
|
||
<li><strong>is_compatible</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag indicating whether this subnet is compatible. If true, this is
|
||
a valid choice for the customer to deploy a SDDC in.</li>
|
||
<li><strong>vpc_id</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 VPC ID the subnet resides in within AWS. Tends to be
|
||
‘vpc-#######’.</li>
|
||
<li><strong>vpc_cidr_block</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 CIDR block of the VPC, in the form of ‘#.#.#.#/#’.</li>
|
||
<li><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>) – Optional field (may not be provided by AWS), indicates the found
|
||
name tag for the subnet.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.CaCertificates">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">CaCertificates</code><span class="sig-paren">(</span><em>ca_certificate=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.CaCertificates" 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>CA certificate list. Optional.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>ca_certificate</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>) – </td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.CbmStatistic">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">CbmStatistic</code><span class="sig-paren">(</span><em>vnic=None</em>, <em>timestamp=None</em>, <em>out=None</em>, <em>in_=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.CbmStatistic" 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>Statistics data for each vnic.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>vnic</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>) – Vnic index. format: int32</li>
|
||
<li><strong>timestamp</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>) – Timestamp value. format: int64</li>
|
||
<li><strong>out</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Tx rate (Kilobits per second - kbps) format: double</li>
|
||
<li><strong>in</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Rx rate (Kilobits per second - kbps) format: double</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.CbmStatistics">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">CbmStatistics</code><span class="sig-paren">(</span><em>data_dto=None</em>, <em>meta_dto=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.CbmStatistics" 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>NSX Edge Interface Statistics.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>data_dto</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.CbmStatsData" title="com.vmware.vmc.model_client.CbmStatsData"><code class="xref py py-class docutils literal notranslate"><span class="pre">CbmStatsData</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Statistics data.</li>
|
||
<li><strong>meta_dto</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.MetaDashboardStats" title="com.vmware.vmc.model_client.MetaDashboardStats"><code class="xref py py-class docutils literal notranslate"><span class="pre">MetaDashboardStats</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Start time, end time and interval details.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.CbmStatsData">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">CbmStatsData</code><span class="sig-paren">(</span><em>vnic9=None</em>, <em>vnic8=None</em>, <em>vnic7=None</em>, <em>vnic6=None</em>, <em>vnic5=None</em>, <em>vnic4=None</em>, <em>vnic3=None</em>, <em>vnic2=None</em>, <em>vnic1=None</em>, <em>vnic0=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.CbmStatsData" 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>Statistics data.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>vnic9</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.CbmStatistic" title="com.vmware.vmc.model_client.CbmStatistic"><code class="xref py py-class docutils literal notranslate"><span class="pre">CbmStatistic</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic8</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.CbmStatistic" title="com.vmware.vmc.model_client.CbmStatistic"><code class="xref py py-class docutils literal notranslate"><span class="pre">CbmStatistic</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic7</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.CbmStatistic" title="com.vmware.vmc.model_client.CbmStatistic"><code class="xref py py-class docutils literal notranslate"><span class="pre">CbmStatistic</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic6</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.CbmStatistic" title="com.vmware.vmc.model_client.CbmStatistic"><code class="xref py py-class docutils literal notranslate"><span class="pre">CbmStatistic</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic5</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.CbmStatistic" title="com.vmware.vmc.model_client.CbmStatistic"><code class="xref py py-class docutils literal notranslate"><span class="pre">CbmStatistic</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic4</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.CbmStatistic" title="com.vmware.vmc.model_client.CbmStatistic"><code class="xref py py-class docutils literal notranslate"><span class="pre">CbmStatistic</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic3</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.CbmStatistic" title="com.vmware.vmc.model_client.CbmStatistic"><code class="xref py py-class docutils literal notranslate"><span class="pre">CbmStatistic</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic2</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.CbmStatistic" title="com.vmware.vmc.model_client.CbmStatistic"><code class="xref py py-class docutils literal notranslate"><span class="pre">CbmStatistic</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic1</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.CbmStatistic" title="com.vmware.vmc.model_client.CbmStatistic"><code class="xref py py-class docutils literal notranslate"><span class="pre">CbmStatistic</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic0</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.CbmStatistic" title="com.vmware.vmc.model_client.CbmStatistic"><code class="xref py py-class docutils literal notranslate"><span class="pre">CbmStatistic</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.CloudProvider">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">CloudProvider</code><span class="sig-paren">(</span><em>provider='CloudProvider'</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.CloudProvider" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the Cloud Provider</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.Cluster">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">Cluster</code><span class="sig-paren">(</span><em>esx_host_list=None</em>, <em>cluster_state=None</em>, <em>cluster_name=None</em>, <em>aws_kms_info=None</em>, <em>cluster_id='Cluster'</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.Cluster" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>esx_host_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.vmc.model_client.AwsEsxHost" title="com.vmware.vmc.model_client.AwsEsxHost"><code class="xref py py-class docutils literal notranslate"><span class="pre">AwsEsxHost</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>cluster_state</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>) – <p>Possible values are:</p>
|
||
<ul>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.Cluster.CLUSTER_STATE_DEPLOYING" title="com.vmware.vmc.model_client.Cluster.CLUSTER_STATE_DEPLOYING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.CLUSTER_STATE_DEPLOYING</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.Cluster.CLUSTER_STATE_ADDING_HOSTS" title="com.vmware.vmc.model_client.Cluster.CLUSTER_STATE_ADDING_HOSTS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.CLUSTER_STATE_ADDING_HOSTS</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.Cluster.CLUSTER_STATE_READY" title="com.vmware.vmc.model_client.Cluster.CLUSTER_STATE_READY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.CLUSTER_STATE_READY</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.Cluster.CLUSTER_STATE_FAILED" title="com.vmware.vmc.model_client.Cluster.CLUSTER_STATE_FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.CLUSTER_STATE_FAILED</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>cluster_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>) – </li>
|
||
<li><strong>aws_kms_info</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.AwsKmsInfo" title="com.vmware.vmc.model_client.AwsKmsInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">AwsKmsInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – AWS Key Management Service information associated with this cluster</li>
|
||
<li><strong>cluster_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.Cluster.CLUSTER_STATE_ADDING_HOSTS">
|
||
<code class="descname">CLUSTER_STATE_ADDING_HOSTS</code><em class="property"> = 'ADDING_HOSTS'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Cluster.CLUSTER_STATE_ADDING_HOSTS" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.Cluster.CLUSTER_STATE_DEPLOYING">
|
||
<code class="descname">CLUSTER_STATE_DEPLOYING</code><em class="property"> = 'DEPLOYING'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Cluster.CLUSTER_STATE_DEPLOYING" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.Cluster.CLUSTER_STATE_FAILED">
|
||
<code class="descname">CLUSTER_STATE_FAILED</code><em class="property"> = 'FAILED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Cluster.CLUSTER_STATE_FAILED" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.Cluster.CLUSTER_STATE_READY">
|
||
<code class="descname">CLUSTER_STATE_READY</code><em class="property"> = 'READY'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Cluster.CLUSTER_STATE_READY" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.ClusterConfig">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">ClusterConfig</code><span class="sig-paren">(</span><em>host_cpu_cores_count=None</em>, <em>storage_capacity=None</em>, <em>num_hosts=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.ClusterConfig" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>host_cpu_cores_count</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>) – Customize CPU cores on hosts in a cluster. Specify number of cores
|
||
to be enabled on hosts in a cluster. format: int32</li>
|
||
<li><strong>storage_capacity</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>) – For EBS-backed instances only, the requested storage capacity in
|
||
GiB. format: int64</li>
|
||
<li><strong>num_hosts</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.ComputeGatewayTemplate">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">ComputeGatewayTemplate</code><span class="sig-paren">(</span><em>public_ip=None</em>, <em>primary_dns=None</em>, <em>secondary_dns=None</em>, <em>firewall_rules=None</em>, <em>vpns=None</em>, <em>logical_networks=None</em>, <em>nat_rules=None</em>, <em>l2_vpn=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.ComputeGatewayTemplate" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>public_ip</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.SddcPublicIp" title="com.vmware.vmc.model_client.SddcPublicIp"><code class="xref py py-class docutils literal notranslate"><span class="pre">SddcPublicIp</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>primary_dns</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>) – </li>
|
||
<li><strong>secondary_dns</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>) – </li>
|
||
<li><strong>firewall_rules</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.FirewallRule" title="com.vmware.vmc.model_client.FirewallRule"><code class="xref py py-class docutils literal notranslate"><span class="pre">FirewallRule</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vpns</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.Vpn" title="com.vmware.vmc.model_client.Vpn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Vpn</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>logical_networks</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.LogicalNetwork" title="com.vmware.vmc.model_client.LogicalNetwork"><code class="xref py py-class docutils literal notranslate"><span class="pre">LogicalNetwork</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>nat_rules</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.NatRule" title="com.vmware.vmc.model_client.NatRule"><code class="xref py py-class docutils literal notranslate"><span class="pre">NatRule</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>l2_vpn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.ConnectivityAgentValidation">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">ConnectivityAgentValidation</code><span class="sig-paren">(</span><em>source=None</em>, <em>type=None</em>, <em>ports=None</em>, <em>path=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.ConnectivityAgentValidation" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>source</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>) – <p>Possible values are:</p>
|
||
<ul>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.ConnectivityAgentValidation.SOURCE_VCENTER" title="com.vmware.vmc.model_client.ConnectivityAgentValidation.SOURCE_VCENTER"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ConnectivityAgentValidation.SOURCE_VCENTER</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.ConnectivityAgentValidation.SOURCE_SRM" title="com.vmware.vmc.model_client.ConnectivityAgentValidation.SOURCE_SRM"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ConnectivityAgentValidation.SOURCE_SRM</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.ConnectivityAgentValidation.SOURCE_VR" title="com.vmware.vmc.model_client.ConnectivityAgentValidation.SOURCE_VR"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ConnectivityAgentValidation.SOURCE_VR</span></code></a></li>
|
||
</ul>
|
||
<blockquote>
|
||
<div>source appliance of connectivity test, i.e. VCENTER, SRM, VR.</div></blockquote>
|
||
</li>
|
||
<li><strong>type</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>) – <p>Possible values are:</p>
|
||
<ul>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.ConnectivityAgentValidation.TYPE_PING" title="com.vmware.vmc.model_client.ConnectivityAgentValidation.TYPE_PING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ConnectivityAgentValidation.TYPE_PING</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.ConnectivityAgentValidation.TYPE_TRACEROUTE" title="com.vmware.vmc.model_client.ConnectivityAgentValidation.TYPE_TRACEROUTE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ConnectivityAgentValidation.TYPE_TRACEROUTE</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.ConnectivityAgentValidation.TYPE_DNS" title="com.vmware.vmc.model_client.ConnectivityAgentValidation.TYPE_DNS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ConnectivityAgentValidation.TYPE_DNS</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.ConnectivityAgentValidation.TYPE_CONNECTIVITY" title="com.vmware.vmc.model_client.ConnectivityAgentValidation.TYPE_CONNECTIVITY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ConnectivityAgentValidation.TYPE_CONNECTIVITY</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.ConnectivityAgentValidation.TYPE_CURL" title="com.vmware.vmc.model_client.ConnectivityAgentValidation.TYPE_CURL"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ConnectivityAgentValidation.TYPE_CURL</span></code></a></li>
|
||
</ul>
|
||
<p>type of connectivity test, i.e. PING, TRACEROUTE, DNS,
|
||
CONNECTIVITY, CURL. For CONNECTIVITY and CURL tests only, please
|
||
specify the ports to be tested against.</p>
|
||
</li>
|
||
<li><strong>ports</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>) – TCP ports ONLY for CONNECTIVITY and CURL tests.</li>
|
||
<li><strong>path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – URL path ONLY for CURL tests.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.ConnectivityAgentValidation.SOURCE_SRM">
|
||
<code class="descname">SOURCE_SRM</code><em class="property"> = 'SRM'</em><a class="headerlink" href="#com.vmware.vmc.model_client.ConnectivityAgentValidation.SOURCE_SRM" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.ConnectivityAgentValidation.SOURCE_VCENTER">
|
||
<code class="descname">SOURCE_VCENTER</code><em class="property"> = 'VCENTER'</em><a class="headerlink" href="#com.vmware.vmc.model_client.ConnectivityAgentValidation.SOURCE_VCENTER" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.ConnectivityAgentValidation.SOURCE_VR">
|
||
<code class="descname">SOURCE_VR</code><em class="property"> = 'VR'</em><a class="headerlink" href="#com.vmware.vmc.model_client.ConnectivityAgentValidation.SOURCE_VR" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.ConnectivityAgentValidation.TYPE_CONNECTIVITY">
|
||
<code class="descname">TYPE_CONNECTIVITY</code><em class="property"> = 'CONNECTIVITY'</em><a class="headerlink" href="#com.vmware.vmc.model_client.ConnectivityAgentValidation.TYPE_CONNECTIVITY" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.ConnectivityAgentValidation.TYPE_CURL">
|
||
<code class="descname">TYPE_CURL</code><em class="property"> = 'CURL'</em><a class="headerlink" href="#com.vmware.vmc.model_client.ConnectivityAgentValidation.TYPE_CURL" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.ConnectivityAgentValidation.TYPE_DNS">
|
||
<code class="descname">TYPE_DNS</code><em class="property"> = 'DNS'</em><a class="headerlink" href="#com.vmware.vmc.model_client.ConnectivityAgentValidation.TYPE_DNS" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.ConnectivityAgentValidation.TYPE_PING">
|
||
<code class="descname">TYPE_PING</code><em class="property"> = 'PING'</em><a class="headerlink" href="#com.vmware.vmc.model_client.ConnectivityAgentValidation.TYPE_PING" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.ConnectivityAgentValidation.TYPE_TRACEROUTE">
|
||
<code class="descname">TYPE_TRACEROUTE</code><em class="property"> = 'TRACEROUTE'</em><a class="headerlink" href="#com.vmware.vmc.model_client.ConnectivityAgentValidation.TYPE_TRACEROUTE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.ConnectivityValidationGroup">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">ConnectivityValidationGroup</code><span class="sig-paren">(</span><em>id=None</em>, <em>name=None</em>, <em>sub_groups=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.ConnectivityValidationGroup" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>id</strong> (<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>) – <p>Possible values are:</p>
|
||
<ul>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.ConnectivityValidationGroup.ID_HLM" title="com.vmware.vmc.model_client.ConnectivityValidationGroup.ID_HLM"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ConnectivityValidationGroup.ID_HLM</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.ConnectivityValidationGroup.ID_DRAAS" title="com.vmware.vmc.model_client.ConnectivityValidationGroup.ID_DRAAS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ConnectivityValidationGroup.ID_DRAAS</span></code></a></li>
|
||
</ul>
|
||
<blockquote>
|
||
<div>test group id, currently, only HLM.</div></blockquote>
|
||
</li>
|
||
<li><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>) – Name of the test group.</li>
|
||
<li><strong>sub_groups</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.ConnectivityValidationSubGroup" title="com.vmware.vmc.model_client.ConnectivityValidationSubGroup"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConnectivityValidationSubGroup</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of sub groups.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.ConnectivityValidationGroup.ID_DRAAS">
|
||
<code class="descname">ID_DRAAS</code><em class="property"> = 'DRAAS'</em><a class="headerlink" href="#com.vmware.vmc.model_client.ConnectivityValidationGroup.ID_DRAAS" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.ConnectivityValidationGroup.ID_HLM">
|
||
<code class="descname">ID_HLM</code><em class="property"> = 'HLM'</em><a class="headerlink" href="#com.vmware.vmc.model_client.ConnectivityValidationGroup.ID_HLM" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.ConnectivityValidationGroups">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">ConnectivityValidationGroups</code><span class="sig-paren">(</span><em>groups=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.ConnectivityValidationGroups" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>groups</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.ConnectivityValidationGroup" title="com.vmware.vmc.model_client.ConnectivityValidationGroup"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConnectivityValidationGroup</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of groups.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.ConnectivityValidationInput">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">ConnectivityValidationInput</code><span class="sig-paren">(</span><em>id=None</em>, <em>value=None</em>, <em>label=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.ConnectivityValidationInput" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>id</strong> (<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>) – <p>Possible values are:</p>
|
||
<ul>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.ConnectivityValidationInput.ID_HOSTNAME" title="com.vmware.vmc.model_client.ConnectivityValidationInput.ID_HOSTNAME"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ConnectivityValidationInput.ID_HOSTNAME</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.ConnectivityValidationInput.ID_HOST_IP" title="com.vmware.vmc.model_client.ConnectivityValidationInput.ID_HOST_IP"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ConnectivityValidationInput.ID_HOST_IP</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.ConnectivityValidationInput.ID_HOSTNAME_OR_IP" title="com.vmware.vmc.model_client.ConnectivityValidationInput.ID_HOSTNAME_OR_IP"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ConnectivityValidationInput.ID_HOSTNAME_OR_IP</span></code></a></li>
|
||
</ul>
|
||
<p>input value type, i.e. HOSTNAME_OR_IP, HOST_IP, HOSTNAME. Accept
|
||
FQDN or IP address as input value when id = HOSTNAME_OR_IP, accept
|
||
FQDN ONLY when id = HOSTNAME, accept IP address ONLY when id =
|
||
HOST_IP.</p>
|
||
</li>
|
||
<li><strong>value</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 FQDN or IP address to run the test against, use #primary-dns
|
||
or #secondary-dns as the on-prem primary/secondary DNS server IP.</li>
|
||
<li><strong>label</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>) – (Optional, for UI display only) input value label.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.ConnectivityValidationInput.ID_HOSTNAME">
|
||
<code class="descname">ID_HOSTNAME</code><em class="property"> = 'HOSTNAME'</em><a class="headerlink" href="#com.vmware.vmc.model_client.ConnectivityValidationInput.ID_HOSTNAME" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.ConnectivityValidationInput.ID_HOSTNAME_OR_IP">
|
||
<code class="descname">ID_HOSTNAME_OR_IP</code><em class="property"> = 'HOSTNAME_OR_IP'</em><a class="headerlink" href="#com.vmware.vmc.model_client.ConnectivityValidationInput.ID_HOSTNAME_OR_IP" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.ConnectivityValidationInput.ID_HOST_IP">
|
||
<code class="descname">ID_HOST_IP</code><em class="property"> = 'HOST_IP'</em><a class="headerlink" href="#com.vmware.vmc.model_client.ConnectivityValidationInput.ID_HOST_IP" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.ConnectivityValidationSubGroup">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">ConnectivityValidationSubGroup</code><span class="sig-paren">(</span><em>inputs=None</em>, <em>tests=None</em>, <em>label=None</em>, <em>help=None</em>, <em>id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.ConnectivityValidationSubGroup" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>inputs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.ConnectivityValidationInput" title="com.vmware.vmc.model_client.ConnectivityValidationInput"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConnectivityValidationInput</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of user inputs for the sub group.</li>
|
||
<li><strong>tests</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.ConnectivityAgentValidation" title="com.vmware.vmc.model_client.ConnectivityAgentValidation"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConnectivityAgentValidation</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of connectivity tests.</li>
|
||
<li><strong>label</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Name of the sub-group.</li>
|
||
<li><strong>help</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>) – Help text.</li>
|
||
<li><strong>id</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>) – <p>Possible values are:</p>
|
||
<ul>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_PRIMARY_DNS" title="com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_PRIMARY_DNS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ConnectivityValidationSubGroup.ID_PRIMARY_DNS</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_SECONDARY_DNS" title="com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_SECONDARY_DNS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ConnectivityValidationSubGroup.ID_SECONDARY_DNS</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_ONPREM_VCENTER" title="com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_ONPREM_VCENTER"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ConnectivityValidationSubGroup.ID_ONPREM_VCENTER</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_ONPREM_PSC" title="com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_ONPREM_PSC"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ConnectivityValidationSubGroup.ID_ONPREM_PSC</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_ACTIVE_DIRECTORY" title="com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_ACTIVE_DIRECTORY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ConnectivityValidationSubGroup.ID_ACTIVE_DIRECTORY</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_ONPREM_ESX" title="com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_ONPREM_ESX"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ConnectivityValidationSubGroup.ID_ONPREM_ESX</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_DRAAS_ONPREM_VCENTER" title="com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_DRAAS_ONPREM_VCENTER"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ConnectivityValidationSubGroup.ID_DRAAS_ONPREM_VCENTER</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_DRAAS_ONPREM_PSC" title="com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_DRAAS_ONPREM_PSC"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ConnectivityValidationSubGroup.ID_DRAAS_ONPREM_PSC</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_DRAAS_ONPREM_SRM" title="com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_DRAAS_ONPREM_SRM"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ConnectivityValidationSubGroup.ID_DRAAS_ONPREM_SRM</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_DRAAS_ONPREM_VR" title="com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_DRAAS_ONPREM_VR"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ConnectivityValidationSubGroup.ID_DRAAS_ONPREM_VR</span></code></a></li>
|
||
</ul>
|
||
<p>subGroup id, i.e. PRIMARY_DNS, SECONDARY_DNS, ONPREM_VCENTER,
|
||
ONPREM_PSC, ACTIVE_DIRECTORY, ONPREM_ESX, DRAAS_ONPREM_VCENTER,
|
||
DRAAS_ONPREM_PSC, DRAAS_ONPREM_SRM and DRAAS_ONPREM_VR.</p>
|
||
</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_ACTIVE_DIRECTORY">
|
||
<code class="descname">ID_ACTIVE_DIRECTORY</code><em class="property"> = 'ACTIVE_DIRECTORY'</em><a class="headerlink" href="#com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_ACTIVE_DIRECTORY" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_DRAAS_ONPREM_PSC">
|
||
<code class="descname">ID_DRAAS_ONPREM_PSC</code><em class="property"> = 'DRAAS_ONPREM_PSC'</em><a class="headerlink" href="#com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_DRAAS_ONPREM_PSC" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_DRAAS_ONPREM_SRM">
|
||
<code class="descname">ID_DRAAS_ONPREM_SRM</code><em class="property"> = 'DRAAS_ONPREM_SRM'</em><a class="headerlink" href="#com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_DRAAS_ONPREM_SRM" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_DRAAS_ONPREM_VCENTER">
|
||
<code class="descname">ID_DRAAS_ONPREM_VCENTER</code><em class="property"> = 'DRAAS_ONPREM_VCENTER'</em><a class="headerlink" href="#com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_DRAAS_ONPREM_VCENTER" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_DRAAS_ONPREM_VR">
|
||
<code class="descname">ID_DRAAS_ONPREM_VR</code><em class="property"> = 'DRAAS_ONPREM_VR'</em><a class="headerlink" href="#com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_DRAAS_ONPREM_VR" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_ONPREM_ESX">
|
||
<code class="descname">ID_ONPREM_ESX</code><em class="property"> = 'ONPREM_ESX'</em><a class="headerlink" href="#com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_ONPREM_ESX" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_ONPREM_PSC">
|
||
<code class="descname">ID_ONPREM_PSC</code><em class="property"> = 'ONPREM_PSC'</em><a class="headerlink" href="#com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_ONPREM_PSC" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_ONPREM_VCENTER">
|
||
<code class="descname">ID_ONPREM_VCENTER</code><em class="property"> = 'ONPREM_VCENTER'</em><a class="headerlink" href="#com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_ONPREM_VCENTER" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_PRIMARY_DNS">
|
||
<code class="descname">ID_PRIMARY_DNS</code><em class="property"> = 'PRIMARY_DNS'</em><a class="headerlink" href="#com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_PRIMARY_DNS" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_SECONDARY_DNS">
|
||
<code class="descname">ID_SECONDARY_DNS</code><em class="property"> = 'SECONDARY_DNS'</em><a class="headerlink" href="#com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_SECONDARY_DNS" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.CrlCertificates">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">CrlCertificates</code><span class="sig-paren">(</span><em>crl_certificate=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.CrlCertificates" 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>CRL certificate list. Optional.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>crl_certificate</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>) – </td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.DashboardData">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">DashboardData</code><span class="sig-paren">(</span><em>firewall=None</em>, <em>sslvpn=None</em>, <em>interfaces=None</em>, <em>load_balancer=None</em>, <em>ipsec=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.DashboardData" 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>Dashboard Statistics data.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>firewall</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.FirewallDashboardStats" title="com.vmware.vmc.model_client.FirewallDashboardStats"><code class="xref py py-class docutils literal notranslate"><span class="pre">FirewallDashboardStats</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – NSX Edge Firewall Statistics data.</li>
|
||
<li><strong>sslvpn</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.SslvpnDashboardStats" title="com.vmware.vmc.model_client.SslvpnDashboardStats"><code class="xref py py-class docutils literal notranslate"><span class="pre">SslvpnDashboardStats</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – NSX Edge SSL VPN Statistics data.</li>
|
||
<li><strong>interfaces</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.InterfacesDashboardStats" title="com.vmware.vmc.model_client.InterfacesDashboardStats"><code class="xref py py-class docutils literal notranslate"><span class="pre">InterfacesDashboardStats</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – NSX Edge Interface Statistics data.</li>
|
||
<li><strong>load_balancer</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.LoadBalancerDashboardStats" title="com.vmware.vmc.model_client.LoadBalancerDashboardStats"><code class="xref py py-class docutils literal notranslate"><span class="pre">LoadBalancerDashboardStats</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – NSX Edge Load Balancer Statistics data.</li>
|
||
<li><strong>ipsec</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.IpsecDashboardStats" title="com.vmware.vmc.model_client.IpsecDashboardStats"><code class="xref py py-class docutils literal notranslate"><span class="pre">IpsecDashboardStats</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – NSX Edge Ipsec Statistics data.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.DashboardStat">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">DashboardStat</code><span class="sig-paren">(</span><em>timestamp=None</em>, <em>value=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.DashboardStat" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>timestamp</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>) – </li>
|
||
<li><strong>value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.DashboardStatistics">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">DashboardStatistics</code><span class="sig-paren">(</span><em>data_dto=None</em>, <em>meta_dto=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.DashboardStatistics" 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>Dashboard Statistics data.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>data_dto</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.DashboardData" title="com.vmware.vmc.model_client.DashboardData"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardData</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Dashboard Statistics data.</li>
|
||
<li><strong>meta_dto</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.MetaDashboardStats" title="com.vmware.vmc.model_client.MetaDashboardStats"><code class="xref py py-class docutils literal notranslate"><span class="pre">MetaDashboardStats</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Start time, end time and interval details.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.DataPageEdgeSummary">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">DataPageEdgeSummary</code><span class="sig-paren">(</span><em>paging_info=None</em>, <em>data=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.DataPageEdgeSummary" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>paging_info</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.PagingInfo" title="com.vmware.vmc.model_client.PagingInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">PagingInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>data</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.EdgeSummary" title="com.vmware.vmc.model_client.EdgeSummary"><code class="xref py py-class docutils literal notranslate"><span class="pre">EdgeSummary</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.DataPageSddcNetwork">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">DataPageSddcNetwork</code><span class="sig-paren">(</span><em>paging_info=None</em>, <em>data=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.DataPageSddcNetwork" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>paging_info</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.PagingInfo" title="com.vmware.vmc.model_client.PagingInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">PagingInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>data</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.SddcNetwork" title="com.vmware.vmc.model_client.SddcNetwork"><code class="xref py py-class docutils literal notranslate"><span class="pre">SddcNetwork</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.DataPermissions">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">DataPermissions</code><span class="sig-paren">(</span><em>save_permission=None</em>, <em>publish_permission=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.DataPermissions" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>save_permission</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>) – </li>
|
||
<li><strong>publish_permission</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>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.DhcpLeaseInfo">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">DhcpLeaseInfo</code><span class="sig-paren">(</span><em>host_lease_info_dtos=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.DhcpLeaseInfo" 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>DHCP lease information.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>host_lease_info_dtos</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.HostLeaseInfo" title="com.vmware.vmc.model_client.HostLeaseInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">HostLeaseInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of DHCP leases.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.DhcpLeases">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">DhcpLeases</code><span class="sig-paren">(</span><em>time_stamp=None</em>, <em>host_lease_infos_dto=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.DhcpLeases" 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>DHCP leases information</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>time_stamp</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The timestamp of the DHCP lease. format: int64</li>
|
||
<li><strong>host_lease_infos_dto</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.DhcpLeaseInfo" title="com.vmware.vmc.model_client.DhcpLeaseInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">DhcpLeaseInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – DHCP lease information.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.DnsConfig">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">DnsConfig</code><span class="sig-paren">(</span><em>feature_type=None</em>, <em>logging=None</em>, <em>enabled=None</em>, <em>dns_views=None</em>, <em>listeners=None</em>, <em>version=None</em>, <em>template=None</em>, <em>cache_size=None</em>, <em>dns_servers=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.DnsConfig" 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>DNS configuration</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>feature_type</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>) – </li>
|
||
<li><strong>logging</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.Logging" title="com.vmware.vmc.model_client.Logging"><code class="xref py py-class docutils literal notranslate"><span class="pre">Logging</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – DNS logging setting.</li>
|
||
<li><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Value is true if feature is enabled. Default value is true.
|
||
Optional.</li>
|
||
<li><strong>dns_views</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.DnsViews" title="com.vmware.vmc.model_client.DnsViews"><code class="xref py py-class docutils literal notranslate"><span class="pre">DnsViews</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of DNS views.</li>
|
||
<li><strong>listeners</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.DnsListeners" title="com.vmware.vmc.model_client.DnsListeners"><code class="xref py py-class docutils literal notranslate"><span class="pre">DnsListeners</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of DNS listeners.</li>
|
||
<li><strong>version</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>) – Version number tracking each configuration change. To avoid
|
||
problems with overwriting changes, always retrieve and modify the
|
||
latest configuration to include the current version number in your
|
||
request. If you provide a version number which is not current, the
|
||
request is rejected. If you omit the version number, the request is
|
||
accepted but may overwrite any current changes if your change is
|
||
not in sync with the latest change. format: int64</li>
|
||
<li><strong>template</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>) – </li>
|
||
<li><strong>cache_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The cache size of the DNS service. format: int64</li>
|
||
<li><strong>dns_servers</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.IpAddresses" title="com.vmware.vmc.model_client.IpAddresses"><code class="xref py py-class docutils literal notranslate"><span class="pre">IpAddresses</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.DnsForwarders">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">DnsForwarders</code><span class="sig-paren">(</span><em>ip_address=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.DnsForwarders" 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>DNS forwarders.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>ip_address</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>) – IP addresses of the DNS servers.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.DnsListeners">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">DnsListeners</code><span class="sig-paren">(</span><em>ip_address=None</em>, <em>vnic=None</em>, <em>type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.DnsListeners" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>ip_address</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 IP addresses.</li>
|
||
<li><strong>vnic</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>) – Vnic for DNS listener.</li>
|
||
<li><strong>type</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>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.DnsResponseStats">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">DnsResponseStats</code><span class="sig-paren">(</span><em>total=None</em>, <em>form_err=None</em>, <em>nx_domain=None</em>, <em>success=None</em>, <em>server_fail=None</em>, <em>nxrrset=None</em>, <em>others=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.DnsResponseStats" 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>DNS response statistics.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>total</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>) – </li>
|
||
<li><strong>form_err</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>) – </li>
|
||
<li><strong>nx_domain</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>) – </li>
|
||
<li><strong>success</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>) – </li>
|
||
<li><strong>server_fail</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>) – </li>
|
||
<li><strong>nxrrset</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>) – </li>
|
||
<li><strong>others</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>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.DnsStatusAndStats">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">DnsStatusAndStats</code><span class="sig-paren">(</span><em>time_stamp=None</em>, <em>requests=None</em>, <em>responses=None</em>, <em>cached_dbrr_set=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.DnsStatusAndStats" 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>DNS statistics.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>time_stamp</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>) – </li>
|
||
<li><strong>requests</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.Requests" title="com.vmware.vmc.model_client.Requests"><code class="xref py py-class docutils literal notranslate"><span class="pre">Requests</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>responses</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.DnsResponseStats" title="com.vmware.vmc.model_client.DnsResponseStats"><code class="xref py py-class docutils literal notranslate"><span class="pre">DnsResponseStats</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>cached_dbrr_set</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>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.DnsView">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">DnsView</code><span class="sig-paren">(</span><em>name=None</em>, <em>view_match=None</em>, <em>recursion=None</em>, <em>view_id=None</em>, <em>forwarders=None</em>, <em>enabled=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.DnsView" 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>DNS View</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the DNS view.</li>
|
||
<li><strong>view_match</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.DnsViewMatch" title="com.vmware.vmc.model_client.DnsViewMatch"><code class="xref py py-class docutils literal notranslate"><span class="pre">DnsViewMatch</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Rules that match the DNS query to this view. The rule can be
|
||
ipAddress, or ipSet. Defaults to ipAddress ‘any’ and ‘any’ vnic.</li>
|
||
<li><strong>recursion</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>) – Recursion enabled on DNS view.</li>
|
||
<li><strong>view_id</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>) – Identifier for the DNS view.</li>
|
||
<li><strong>forwarders</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.DnsForwarders" title="com.vmware.vmc.model_client.DnsForwarders"><code class="xref py py-class docutils literal notranslate"><span class="pre">DnsForwarders</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – DNS forwarders.</li>
|
||
<li><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – DNS view is enabled.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.DnsViewMatch">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">DnsViewMatch</code><span class="sig-paren">(</span><em>vnic=None</em>, <em>ip_set=None</em>, <em>ip_address=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.DnsViewMatch" 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>Dns view match</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>vnic</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>) – </li>
|
||
<li><strong>ip_set</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>) – </li>
|
||
<li><strong>ip_address</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>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.DnsViews">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">DnsViews</code><span class="sig-paren">(</span><em>dns_view=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.DnsViews" 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>DNS views.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>dns_view</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DnsView" title="com.vmware.vmc.model_client.DnsView"><code class="xref py py-class docutils literal notranslate"><span class="pre">DnsView</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of DNS views.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.EdgeJob">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">EdgeJob</code><span class="sig-paren">(</span><em>status=None</em>, <em>edge_id=None</em>, <em>module=None</em>, <em>job_id=None</em>, <em>error_code=None</em>, <em>result=None</em>, <em>start_time=None</em>, <em>message=None</em>, <em>end_time=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.EdgeJob" 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>Job status information for the configuration change carried out on NSX
|
||
Edge.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>status</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>) – Job status.</li>
|
||
<li><strong>edge_id</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>) – NSX Edge ID.</li>
|
||
<li><strong>module</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>) – Module information.</li>
|
||
<li><strong>job_id</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>) – Job ID.</li>
|
||
<li><strong>error_code</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>) – Error code identifying the failure of the configuration change.</li>
|
||
<li><strong>result</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.Result" title="com.vmware.vmc.model_client.Result"><code class="xref py py-class docutils literal notranslate"><span class="pre">Result</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Job result information.</li>
|
||
<li><strong>start_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Job start time. format: date-time</li>
|
||
<li><strong>message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Job message.</li>
|
||
<li><strong>end_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Job end time. format: date-time</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.EdgeStatus">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">EdgeStatus</code><span class="sig-paren">(</span><em>pre_rules_exists=None</em>, <em>feature_statuses=None</em>, <em>timestamp=None</em>, <em>publish_status=None</em>, <em>last_published_pre_rules_generation_number=None</em>, <em>version=None</em>, <em>edge_vm_status=None</em>, <em>active_vse_ha_index=None</em>, <em>system_status=None</em>, <em>ha_vnic_in_use=None</em>, <em>edge_status=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.EdgeStatus" 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>NSX Edge Appliance status.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>pre_rules_exists</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>) – Value is true if pre rules publish is enabled.</li>
|
||
<li><strong>feature_statuses</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.FeatureStatus" title="com.vmware.vmc.model_client.FeatureStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">FeatureStatus</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Individual feature status.</li>
|
||
<li><strong>timestamp</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>) – Timestamp value at which the NSX Edge healthcheck was done. format:
|
||
int64</li>
|
||
<li><strong>publish_status</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>) – Status of the latest configuration change for the NSX Edge. Values
|
||
are APPLIED or PERSISTED (not published to NSX Edge Appliance yet).</li>
|
||
<li><strong>last_published_pre_rules_generation_number</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>) – Value of the last published pre rules generation number. format:
|
||
int64</li>
|
||
<li><strong>version</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>) – Version number of the current configuration. format: int64</li>
|
||
<li><strong>edge_vm_status</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.EdgeVmStatus" title="com.vmware.vmc.model_client.EdgeVmStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">EdgeVmStatus</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Detailed status of each of the deployed NSX Edge appliances.</li>
|
||
<li><strong>active_vse_ha_index</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>) – Index of the active NSX Edge appliance. Values are 0 and 1. format:
|
||
int32</li>
|
||
<li><strong>system_status</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>) – System status of the active NSX Edge appliance.</li>
|
||
<li><strong>ha_vnic_in_use</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>) – Index of the vnic consumed for NSX Edge HA. format: int32</li>
|
||
<li><strong>edge_status</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>) – NSX Edge appliance health status identified by GREY (unknown
|
||
status), GREEN (health checks are successful), YELLOW (intermittent
|
||
health check failure), RED (none of the appliances are in serving
|
||
state). If health check fails for 5 consecutive times for all
|
||
appliance (2 for HA else 1) then status will turn from YELLOW to
|
||
RED.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.EdgeSummary">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">EdgeSummary</code><span class="sig-paren">(</span><em>feature_capabilities=None</em>, <em>edge_type=None</em>, <em>logical_router_scopes=None</em>, <em>recent_job_info=None</em>, <em>hypervisor_assist=None</em>, <em>edge_assist_id=None</em>, <em>edge_status=None</em>, <em>edge_assist_instance_name=None</em>, <em>object_id=None</em>, <em>node_id=None</em>, <em>id=None</em>, <em>datacenter_name=None</em>, <em>state=None</em>, <em>client_handle=None</em>, <em>scope=None</em>, <em>type=None</em>, <em>revision=None</em>, <em>vsm_uuid=None</em>, <em>description=None</em>, <em>extended_attributes=None</em>, <em>local_egress_enabled=None</em>, <em>universal_revision=None</em>, <em>allowed_actions=None</em>, <em>object_type_name=None</em>, <em>is_upgrade_available=None</em>, <em>is_universal=None</em>, <em>name=None</em>, <em>lrouter_uuid=None</em>, <em>appliances_summary=None</em>, <em>api_version=None</em>, <em>tenant_id=None</em>, <em>datacenter_moid=None</em>, <em>number_of_connected_vnics=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.EdgeSummary" 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>NSX Edge summary. Read only.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>feature_capabilities</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.FeatureCapabilities" title="com.vmware.vmc.model_client.FeatureCapabilities"><code class="xref py py-class docutils literal notranslate"><span class="pre">FeatureCapabilities</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of Features and their capability details based on Edge
|
||
appliance form factor.</li>
|
||
<li><strong>edge_type</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>) – NSX Edge type, whether ‘gatewayServices’ or ‘distributedRouter’.</li>
|
||
<li><strong>logical_router_scopes</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.LogicalRouterScopes" title="com.vmware.vmc.model_client.LogicalRouterScopes"><code class="xref py py-class docutils literal notranslate"><span class="pre">LogicalRouterScopes</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Backing type scope (DistributedVirtualSwitch - VLAN, TransportZone
|
||
-VXLAN) and its ID for the Distributed Logical Router.</li>
|
||
<li><strong>recent_job_info</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.EdgeJob" title="com.vmware.vmc.model_client.EdgeJob"><code class="xref py py-class docutils literal notranslate"><span class="pre">EdgeJob</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Job information for the most recent configuration change carried
|
||
out on the NSX Edge.</li>
|
||
<li><strong>hypervisor_assist</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>) – </li>
|
||
<li><strong>edge_assist_id</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>) – ID generated by NSX Manager for Distributed Logical Router only.
|
||
format: int64</li>
|
||
<li><strong>edge_status</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>) – NSX Edge appliance health status identified by GREY (unknown
|
||
status), GREEN (health checks are successful), YELLOW (intermittent
|
||
health check failure), RED (none of the appliances are in serving
|
||
state). If health check fails for 5 consecutive times for all
|
||
appliance (2 for HA else 1) then status will turn from YELLOW to
|
||
RED.</li>
|
||
<li><strong>edge_assist_instance_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>) – Name derived by NSX Manager only for Distributed Logical Router.</li>
|
||
<li><strong>object_id</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>) – </li>
|
||
<li><strong>node_id</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>) – </li>
|
||
<li><strong>id</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>) – NSX Edge ID.</li>
|
||
<li><strong>datacenter_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>) – Datacenter name where the NSX Edge is deployed.</li>
|
||
<li><strong>state</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>) – Deployment state of the NSX Edge appliance. Values are ‘deployed’
|
||
when VMs have been deployed, ‘undeployed’ when no VMs are deployed
|
||
and ‘active’ when Edge type is Distributed Logical Router and has
|
||
no appliance deployed but is serving data path.</li>
|
||
<li><strong>client_handle</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>) – </li>
|
||
<li><strong>scope</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.ScopeInfo" title="com.vmware.vmc.model_client.ScopeInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ScopeInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>type</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.ObjectType" title="com.vmware.vmc.model_client.ObjectType"><code class="xref py py-class docutils literal notranslate"><span class="pre">ObjectType</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>revision</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>) – </li>
|
||
<li><strong>vsm_uuid</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>) – </li>
|
||
<li><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>extended_attributes</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.ExtendedAttribute" title="com.vmware.vmc.model_client.ExtendedAttribute"><code class="xref py py-class docutils literal notranslate"><span class="pre">ExtendedAttribute</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>local_egress_enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Value is true if local egress is enabled for UDLR traffic.
|
||
Applicable only for Universal Distributed Logical Router.</li>
|
||
<li><strong>universal_revision</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>) – </li>
|
||
<li><strong>allowed_actions</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>) – </li>
|
||
<li><strong>object_type_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>) – </li>
|
||
<li><strong>is_upgrade_available</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>) – Value is true if NSX Edge upgrade is available.</li>
|
||
<li><strong>is_universal</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>) – </li>
|
||
<li><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>) – </li>
|
||
<li><strong>lrouter_uuid</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>) – Distributed Logical Router UUID provided by the NSX Controller.</li>
|
||
<li><strong>appliances_summary</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.AppliancesSummary" title="com.vmware.vmc.model_client.AppliancesSummary"><code class="xref py py-class docutils literal notranslate"><span class="pre">AppliancesSummary</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – NSX Edge appliance summary.</li>
|
||
<li><strong>api_version</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>) – REST API version applicable for the NSX Edge.</li>
|
||
<li><strong>tenant_id</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>) – Tenant ID for the NSX Edge.</li>
|
||
<li><strong>datacenter_moid</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>) – vCenter MOID of the datacenter where the NSX Edge is deployed.</li>
|
||
<li><strong>number_of_connected_vnics</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 connected vnics that are configured on the NSX Edge.
|
||
format: int32</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.EdgeVmStatus">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">EdgeVmStatus</code><span class="sig-paren">(</span><em>index=None</em>, <em>ha_state=None</em>, <em>name=None</em>, <em>id=None</em>, <em>edge_vm_status=None</em>, <em>pre_rules_generation_number=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.EdgeVmStatus" 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>Status of each of the deployed NSX Edge appliances.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>index</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>) – High Availability index of the appliance. Values are 0 and 1.
|
||
format: int32</li>
|
||
<li><strong>ha_state</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>) – High Availability state of the appliance. Values are active and
|
||
standby.</li>
|
||
<li><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>) – Name of the NSX Edge appliance.</li>
|
||
<li><strong>id</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>) – vCenter MOID of the NSX Edge appliance.</li>
|
||
<li><strong>edge_vm_status</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>) – NSX Edge appliance health status identified by GREY (unknown
|
||
status), GREEN (health checks are successful), YELLOW (intermittent
|
||
health check failure), RED (appliance not in serving state).</li>
|
||
<li><strong>pre_rules_generation_number</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>) – Value of the last published pre rules generation number. format:
|
||
int64</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.EdgeVnicAddressGroup">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">EdgeVnicAddressGroup</code><span class="sig-paren">(</span><em>subnet_prefix_length=None</em>, <em>secondary_addresses=None</em>, <em>primary_address=None</em>, <em>subnet_mask=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.EdgeVnicAddressGroup" 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>Address group configuration of the NSX Edge vnic. An interface can have one
|
||
primary and multiple secondary IP addresses.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>subnet_prefix_length</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>) – Subnet prefix length of the primary IP address.</li>
|
||
<li><strong>secondary_addresses</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.SecondaryAddresses" title="com.vmware.vmc.model_client.SecondaryAddresses"><code class="xref py py-class docutils literal notranslate"><span class="pre">SecondaryAddresses</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Secondary IP addresses of the NSX Edge vnic address group.
|
||
Optional.</li>
|
||
<li><strong>primary_address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Primary IP address of the vnic interface. Required.</li>
|
||
<li><strong>subnet_mask</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>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.EdgeVnicAddressGroups">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">EdgeVnicAddressGroups</code><span class="sig-paren">(</span><em>address_groups=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.EdgeVnicAddressGroups" 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>NSX Edge vnic address group configuration details.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>address_groups</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.EdgeVnicAddressGroup" title="com.vmware.vmc.model_client.EdgeVnicAddressGroup"><code class="xref py py-class docutils literal notranslate"><span class="pre">EdgeVnicAddressGroup</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Address group configuration of the NSX Edge vnic. Vnic can be
|
||
configured to have more than one address group/subnets.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.ErrorResponse">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">ErrorResponse</code><span class="sig-paren">(</span><em>status=None</em>, <em>path=None</em>, <em>retryable=None</em>, <em>error_code=None</em>, <em>error_messages=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.ErrorResponse" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>status</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – HTTP status code</li>
|
||
<li><strong>path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Originating request URI</li>
|
||
<li><strong>retryable</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – If true, client should retry operation</li>
|
||
<li><strong>error_code</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – unique error code</li>
|
||
<li><strong>error_messages</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>) – localized error messages</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.EsxConfig">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">EsxConfig</code><span class="sig-paren">(</span><em>availability_zone=None</em>, <em>esxs=None</em>, <em>cluster_id=None</em>, <em>num_hosts=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.EsxConfig" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>availability_zone</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>) – Availability zone where the hosts should be provisioned. (Can be
|
||
specified only for privileged host operations).</li>
|
||
<li><strong>esxs</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>) – </li>
|
||
<li><strong>cluster_id</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>) – An optional cluster id if the esxs operation has to be on a
|
||
specific cluster.</li>
|
||
<li><strong>num_hosts</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.EsxHost">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">EsxHost</code><span class="sig-paren">(</span><em>name=None</em>, <em>availability_zone=None</em>, <em>esx_id=None</em>, <em>hostname=None</em>, <em>provider='EsxHost'</em>, <em>mac_address=None</em>, <em>custom_properties=None</em>, <em>esx_state=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.EsxHost" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>name</strong> (<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>) – </li>
|
||
<li><strong>availability_zone</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>) – Availability zone where the host is provisioned.</li>
|
||
<li><strong>esx_id</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>) – </li>
|
||
<li><strong>hostname</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </li>
|
||
<li><strong>mac_address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>custom_properties</strong> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>esx_state</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>) – <p>Possible values are:</p>
|
||
<ul>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.EsxHost.ESX_STATE_DEPLOYING" title="com.vmware.vmc.model_client.EsxHost.ESX_STATE_DEPLOYING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">EsxHost.ESX_STATE_DEPLOYING</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.EsxHost.ESX_STATE_PROVISIONED" title="com.vmware.vmc.model_client.EsxHost.ESX_STATE_PROVISIONED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">EsxHost.ESX_STATE_PROVISIONED</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.EsxHost.ESX_STATE_READY" title="com.vmware.vmc.model_client.EsxHost.ESX_STATE_READY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">EsxHost.ESX_STATE_READY</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.EsxHost.ESX_STATE_DELETING" title="com.vmware.vmc.model_client.EsxHost.ESX_STATE_DELETING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">EsxHost.ESX_STATE_DELETING</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.EsxHost.ESX_STATE_DELETED" title="com.vmware.vmc.model_client.EsxHost.ESX_STATE_DELETED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">EsxHost.ESX_STATE_DELETED</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.EsxHost.ESX_STATE_FAILED" title="com.vmware.vmc.model_client.EsxHost.ESX_STATE_FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">EsxHost.ESX_STATE_FAILED</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.EsxHost.ESX_STATE_DELETED">
|
||
<code class="descname">ESX_STATE_DELETED</code><em class="property"> = 'DELETED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.EsxHost.ESX_STATE_DELETED" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.EsxHost.ESX_STATE_DELETING">
|
||
<code class="descname">ESX_STATE_DELETING</code><em class="property"> = 'DELETING'</em><a class="headerlink" href="#com.vmware.vmc.model_client.EsxHost.ESX_STATE_DELETING" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.EsxHost.ESX_STATE_DEPLOYING">
|
||
<code class="descname">ESX_STATE_DEPLOYING</code><em class="property"> = 'DEPLOYING'</em><a class="headerlink" href="#com.vmware.vmc.model_client.EsxHost.ESX_STATE_DEPLOYING" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.EsxHost.ESX_STATE_FAILED">
|
||
<code class="descname">ESX_STATE_FAILED</code><em class="property"> = 'FAILED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.EsxHost.ESX_STATE_FAILED" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.EsxHost.ESX_STATE_PROVISIONED">
|
||
<code class="descname">ESX_STATE_PROVISIONED</code><em class="property"> = 'PROVISIONED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.EsxHost.ESX_STATE_PROVISIONED" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.EsxHost.ESX_STATE_READY">
|
||
<code class="descname">ESX_STATE_READY</code><em class="property"> = 'READY'</em><a class="headerlink" href="#com.vmware.vmc.model_client.EsxHost.ESX_STATE_READY" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.ExtendedAttribute">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">ExtendedAttribute</code><span class="sig-paren">(</span><em>name=None</em>, <em>value=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.ExtendedAttribute" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>name</strong> (<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>) – </li>
|
||
<li><strong>value</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>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.FeatureCapabilities">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">FeatureCapabilities</code><span class="sig-paren">(</span><em>timestamp=None</em>, <em>feature_capabilities=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.FeatureCapabilities" 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>List of features and their capability details based on NSX Edge appliance
|
||
form factor.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>timestamp</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>) – Time stamp value at which the feature capabilities were retrieved.
|
||
format: int64</li>
|
||
<li><strong>feature_capabilities</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.FeatureCapability" title="com.vmware.vmc.model_client.FeatureCapability"><code class="xref py py-class docutils literal notranslate"><span class="pre">FeatureCapability</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of feature capability information.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.FeatureCapability">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">FeatureCapability</code><span class="sig-paren">(</span><em>configuration_limits=None</em>, <em>is_supported=None</em>, <em>service=None</em>, <em>permission=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.FeatureCapability" 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>Feature capability information.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>configuration_limits</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.KeyValueAttributes" title="com.vmware.vmc.model_client.KeyValueAttributes"><code class="xref py py-class docutils literal notranslate"><span class="pre">KeyValueAttributes</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of key value pairs describing the feature configuration
|
||
limits.</li>
|
||
<li><strong>is_supported</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>) – Value is true if feature is supported on NSX Edge.</li>
|
||
<li><strong>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Name of the feature or service.</li>
|
||
<li><strong>permission</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.LicenceAclPermissions" title="com.vmware.vmc.model_client.LicenceAclPermissions"><code class="xref py py-class docutils literal notranslate"><span class="pre">LicenceAclPermissions</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Licence and access control information for the feature.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.FeatureStatus">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">FeatureStatus</code><span class="sig-paren">(</span><em>status=None</em>, <em>configured=None</em>, <em>server_status=None</em>, <em>publish_status=None</em>, <em>service=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.FeatureStatus" 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>Individual feature status.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>status</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>) – Status of the feature or service.</li>
|
||
<li><strong>configured</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>) – Value is true if feature is configured.</li>
|
||
<li><strong>server_status</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>) – Server status of the feature or service. Values are up and down.</li>
|
||
<li><strong>publish_status</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>) – Publish status of the feature, whether APPLIED or PERSISTED.</li>
|
||
<li><strong>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Name of the feature or service.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.FirewallConfig">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">FirewallConfig</code><span class="sig-paren">(</span><em>firewall_rules=None</em>, <em>feature_type=None</em>, <em>version=None</em>, <em>template=None</em>, <em>global_config=None</em>, <em>enabled=None</em>, <em>default_policy=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.FirewallConfig" 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>Firewall Configuration</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>firewall_rules</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.FirewallRules" title="com.vmware.vmc.model_client.FirewallRules"><code class="xref py py-class docutils literal notranslate"><span class="pre">FirewallRules</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Ordered list of firewall rules.</li>
|
||
<li><strong>feature_type</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>) – </li>
|
||
<li><strong>version</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>) – Version number tracking each configuration change. To avoid
|
||
problems with overwriting changes, always retrieve and modify the
|
||
latest configuration to include the current version number in your
|
||
request. If you provide a version number which is not current, the
|
||
request is rejected. If you omit the version number, the request is
|
||
accepted but may overwrite any current changes if your change is
|
||
not in sync with the latest change. format: int64</li>
|
||
<li><strong>template</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>) – </li>
|
||
<li><strong>global_config</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.FirewallGlobalConfig" title="com.vmware.vmc.model_client.FirewallGlobalConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">FirewallGlobalConfig</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Global configuration applicable to all rules.</li>
|
||
<li><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Value is true if feature is enabled. Default value is true.
|
||
Optional.</li>
|
||
<li><strong>default_policy</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.FirewallDefaultPolicy" title="com.vmware.vmc.model_client.FirewallDefaultPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">FirewallDefaultPolicy</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Default Policy.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.FirewallDashboardStats">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">FirewallDashboardStats</code><span class="sig-paren">(</span><em>connections=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.FirewallDashboardStats" 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>Dashboard Statistics data for Firewall.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>connections</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Number of NSX Edge firewall connections and rules.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.FirewallDefaultPolicy">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">FirewallDefaultPolicy</code><span class="sig-paren">(</span><em>action=None</em>, <em>logging_enabled=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.FirewallDefaultPolicy" 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>Firewall default policy. Default is deny.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>action</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>) – Action. Default is deny. Supported values accept, deny</li>
|
||
<li><strong>logging_enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Enable logging for the rule.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.FirewallGlobalConfig">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">FirewallGlobalConfig</code><span class="sig-paren">(</span><em>tcp_allow_out_of_window_packets=None</em>, <em>udp_timeout=None</em>, <em>ip_generic_timeout=None</em>, <em>tcp_pick_ongoing_connections=None</em>, <em>tcp_timeout_open=None</em>, <em>tcp_timeout_close=None</em>, <em>icmp6_timeout=None</em>, <em>drop_icmp_replays=None</em>, <em>log_icmp_errors=None</em>, <em>tcp_send_reset_for_closed_vse_ports=None</em>, <em>drop_invalid_traffic=None</em>, <em>enable_syn_flood_protection=None</em>, <em>icmp_timeout=None</em>, <em>tcp_timeout_established=None</em>, <em>log_invalid_traffic=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.FirewallGlobalConfig" 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>Global configuration applicable to all rules.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>tcp_allow_out_of_window_packets</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>) – Allow TCP out of window packets.</li>
|
||
<li><strong>udp_timeout</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>) – UDP timeout close. format: int32</li>
|
||
<li><strong>ip_generic_timeout</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>) – IP generic timeout. format: int32</li>
|
||
<li><strong>tcp_pick_ongoing_connections</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>) – Pick TCP ongoing connections.</li>
|
||
<li><strong>tcp_timeout_open</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>) – TCP timeout open. format: int32</li>
|
||
<li><strong>tcp_timeout_close</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>) – TCP timeout close. format: int32</li>
|
||
<li><strong>icmp6_timeout</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>) – ICMP6 timeout. format: int32</li>
|
||
<li><strong>drop_icmp_replays</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>) – Drop icmp replays.</li>
|
||
<li><strong>log_icmp_errors</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>) – Log icmp errors.</li>
|
||
<li><strong>tcp_send_reset_for_closed_vse_ports</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>) – Send TCP reset for closed NSX Edge ports.</li>
|
||
<li><strong>drop_invalid_traffic</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>) – Drop invalid traffic.</li>
|
||
<li><strong>enable_syn_flood_protection</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Protect against SYN flood attacks by detecting bogus TCP
|
||
connections and terminating them without consuming firewall state
|
||
tracking resources. Default : false</li>
|
||
<li><strong>icmp_timeout</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>) – ICMP timeout. format: int32</li>
|
||
<li><strong>tcp_timeout_established</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>) – TCP timeout established. format: int32</li>
|
||
<li><strong>log_invalid_traffic</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>) – Log invalid traffic.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.FirewallRule">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">FirewallRule</code><span class="sig-paren">(</span><em>rule_type=None</em>, <em>application_ids=None</em>, <em>name=None</em>, <em>rule_interface=None</em>, <em>destination=None</em>, <em>id=None</em>, <em>destination_scope=None</em>, <em>source=None</em>, <em>source_scope=None</em>, <em>services=None</em>, <em>action=None</em>, <em>revision=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.FirewallRule" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>rule_type</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>) – <p>Possible values are:</p>
|
||
<ul>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.FirewallRule.RULE_TYPE_USER" title="com.vmware.vmc.model_client.FirewallRule.RULE_TYPE_USER"><code class="xref py py-attr docutils literal notranslate"><span class="pre">FirewallRule.RULE_TYPE_USER</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.FirewallRule.RULE_TYPE_DEFAULT" title="com.vmware.vmc.model_client.FirewallRule.RULE_TYPE_DEFAULT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">FirewallRule.RULE_TYPE_DEFAULT</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>application_ids</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><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>) – </li>
|
||
<li><strong>rule_interface</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>) – Deprecated, left for backwards compatibility. Remove once UI stops
|
||
using it.</li>
|
||
<li><strong>destination</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>) – Optional. Possible formats are IP, IP1-IPn, CIDR or comma separated
|
||
list of those entries. If not specified, defaults to ‘any’.</li>
|
||
<li><strong>id</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>) – </li>
|
||
<li><strong>destination_scope</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.FirewallRuleScope" title="com.vmware.vmc.model_client.FirewallRuleScope"><code class="xref py py-class docutils literal notranslate"><span class="pre">FirewallRuleScope</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>source</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>) – Optional. Possible formats are IP, IP1-IPn, CIDR or comma separated
|
||
list of those entries. If not specified, defaults to ‘any’.</li>
|
||
<li><strong>source_scope</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.FirewallRuleScope" title="com.vmware.vmc.model_client.FirewallRuleScope"><code class="xref py py-class docutils literal notranslate"><span class="pre">FirewallRuleScope</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>services</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.FirewallService" title="com.vmware.vmc.model_client.FirewallService"><code class="xref py py-class docutils literal notranslate"><span class="pre">FirewallService</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – list of protocols and ports for this firewall rule</li>
|
||
<li><strong>action</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>) – <p>Possible values are:</p>
|
||
<ul>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.FirewallRule.ACTION_ALLOW" title="com.vmware.vmc.model_client.FirewallRule.ACTION_ALLOW"><code class="xref py py-attr docutils literal notranslate"><span class="pre">FirewallRule.ACTION_ALLOW</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.FirewallRule.ACTION_DENY" title="com.vmware.vmc.model_client.FirewallRule.ACTION_DENY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">FirewallRule.ACTION_DENY</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>revision</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>) – current revision of the list of firewall rules, used to protect
|
||
against concurrent modification (first writer wins) format: int32
|
||
This attribute may be present in responses from the server, but if
|
||
it is present in a request to server it will be ignored.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.FirewallRule.ACTION_ALLOW">
|
||
<code class="descname">ACTION_ALLOW</code><em class="property"> = 'ALLOW'</em><a class="headerlink" href="#com.vmware.vmc.model_client.FirewallRule.ACTION_ALLOW" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.FirewallRule.ACTION_DENY">
|
||
<code class="descname">ACTION_DENY</code><em class="property"> = 'DENY'</em><a class="headerlink" href="#com.vmware.vmc.model_client.FirewallRule.ACTION_DENY" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.FirewallRule.RULE_TYPE_DEFAULT">
|
||
<code class="descname">RULE_TYPE_DEFAULT</code><em class="property"> = 'DEFAULT'</em><a class="headerlink" href="#com.vmware.vmc.model_client.FirewallRule.RULE_TYPE_DEFAULT" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.FirewallRule.RULE_TYPE_USER">
|
||
<code class="descname">RULE_TYPE_USER</code><em class="property"> = 'USER'</em><a class="headerlink" href="#com.vmware.vmc.model_client.FirewallRule.RULE_TYPE_USER" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.FirewallRuleScope">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">FirewallRuleScope</code><span class="sig-paren">(</span><em>grouping_object_ids=None</em>, <em>vnic_group_ids=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.FirewallRuleScope" 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>Optional for FirewallRule. If not specified, defaults to ‘any’.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>grouping_object_ids</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic_group_ids</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Possible values are:</p>
|
||
<ul>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VSE" title="com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VSE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">FirewallRuleScope.VNIC_GROUP_IDS_VSE</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_INTERNAL" title="com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_INTERNAL"><code class="xref py py-attr docutils literal notranslate"><span class="pre">FirewallRuleScope.VNIC_GROUP_IDS_INTERNAL</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_EXTERNAL" title="com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_EXTERNAL"><code class="xref py py-attr docutils literal notranslate"><span class="pre">FirewallRuleScope.VNIC_GROUP_IDS_EXTERNAL</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_0" title="com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_0"><code class="xref py py-attr docutils literal notranslate"><span class="pre">FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_0</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_1" title="com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_1"><code class="xref py py-attr docutils literal notranslate"><span class="pre">FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_1</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_2" title="com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_2"><code class="xref py py-attr docutils literal notranslate"><span class="pre">FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_2</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_3" title="com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_3"><code class="xref py py-attr docutils literal notranslate"><span class="pre">FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_3</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_4" title="com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_4"><code class="xref py py-attr docutils literal notranslate"><span class="pre">FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_4</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_5" title="com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_5"><code class="xref py py-attr docutils literal notranslate"><span class="pre">FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_5</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_6" title="com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_6"><code class="xref py py-attr docutils literal notranslate"><span class="pre">FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_6</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_7" title="com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_7"><code class="xref py py-attr docutils literal notranslate"><span class="pre">FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_7</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_8" title="com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_8"><code class="xref py py-attr docutils literal notranslate"><span class="pre">FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_8</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_9" title="com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_9"><code class="xref py py-attr docutils literal notranslate"><span class="pre">FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_9</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_EXTERNAL">
|
||
<code class="descname">VNIC_GROUP_IDS_EXTERNAL</code><em class="property"> = 'external'</em><a class="headerlink" href="#com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_EXTERNAL" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_INTERNAL">
|
||
<code class="descname">VNIC_GROUP_IDS_INTERNAL</code><em class="property"> = 'internal'</em><a class="headerlink" href="#com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_INTERNAL" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_0">
|
||
<code class="descname">VNIC_GROUP_IDS_VNIC_INDEX_0</code><em class="property"> = 'vnic-index-0'</em><a class="headerlink" href="#com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_0" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_1">
|
||
<code class="descname">VNIC_GROUP_IDS_VNIC_INDEX_1</code><em class="property"> = 'vnic-index-1'</em><a class="headerlink" href="#com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_1" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_2">
|
||
<code class="descname">VNIC_GROUP_IDS_VNIC_INDEX_2</code><em class="property"> = 'vnic-index-2'</em><a class="headerlink" href="#com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_2" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_3">
|
||
<code class="descname">VNIC_GROUP_IDS_VNIC_INDEX_3</code><em class="property"> = 'vnic-index-3'</em><a class="headerlink" href="#com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_3" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_4">
|
||
<code class="descname">VNIC_GROUP_IDS_VNIC_INDEX_4</code><em class="property"> = 'vnic-index-4'</em><a class="headerlink" href="#com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_4" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_5">
|
||
<code class="descname">VNIC_GROUP_IDS_VNIC_INDEX_5</code><em class="property"> = 'vnic-index-5'</em><a class="headerlink" href="#com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_5" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_6">
|
||
<code class="descname">VNIC_GROUP_IDS_VNIC_INDEX_6</code><em class="property"> = 'vnic-index-6'</em><a class="headerlink" href="#com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_6" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_7">
|
||
<code class="descname">VNIC_GROUP_IDS_VNIC_INDEX_7</code><em class="property"> = 'vnic-index-7'</em><a class="headerlink" href="#com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_7" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_8">
|
||
<code class="descname">VNIC_GROUP_IDS_VNIC_INDEX_8</code><em class="property"> = 'vnic-index-8'</em><a class="headerlink" href="#com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_8" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_9">
|
||
<code class="descname">VNIC_GROUP_IDS_VNIC_INDEX_9</code><em class="property"> = 'vnic-index-9'</em><a class="headerlink" href="#com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_9" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VSE">
|
||
<code class="descname">VNIC_GROUP_IDS_VSE</code><em class="property"> = 'vse'</em><a class="headerlink" href="#com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VSE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.FirewallRuleStats">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">FirewallRuleStats</code><span class="sig-paren">(</span><em>timestamp=None</em>, <em>connection_count=None</em>, <em>byte_count=None</em>, <em>packet_count=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.FirewallRuleStats" 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>Statistics for firewall rule</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>timestamp</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>) – Timestamp of statistics collection. format: int64</li>
|
||
<li><strong>connection_count</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>) – Connection count. format: int64</li>
|
||
<li><strong>byte_count</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>) – Byte count. format: int64</li>
|
||
<li><strong>packet_count</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>) – Packet count. format: int64</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.FirewallRules">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">FirewallRules</code><span class="sig-paren">(</span><em>firewall_rules=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.FirewallRules" 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>Ordered list of firewall rules.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>firewall_rules</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.Nsxfirewallrule" title="com.vmware.vmc.model_client.Nsxfirewallrule"><code class="xref py py-class docutils literal notranslate"><span class="pre">Nsxfirewallrule</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Ordered list of firewall rules.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.FirewallService">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">FirewallService</code><span class="sig-paren">(</span><em>protocol=None</em>, <em>ports=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.FirewallService" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>protocol</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>) – protocol name, such as ‘tcp’, ‘udp’ etc.</li>
|
||
<li><strong>ports</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>) – a list of port numbers and port ranges, such as {80, 91-95, 99}. If
|
||
not specified, defaults to ‘any’.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.GatewayTemplate">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">GatewayTemplate</code><span class="sig-paren">(</span><em>public_ip=None</em>, <em>primary_dns=None</em>, <em>secondary_dns=None</em>, <em>firewall_rules=None</em>, <em>vpns=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.GatewayTemplate" 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>Describes common properties for MGW and CGW configuration templates</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>public_ip</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.SddcPublicIp" title="com.vmware.vmc.model_client.SddcPublicIp"><code class="xref py py-class docutils literal notranslate"><span class="pre">SddcPublicIp</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>primary_dns</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>) – </li>
|
||
<li><strong>secondary_dns</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>) – </li>
|
||
<li><strong>firewall_rules</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.FirewallRule" title="com.vmware.vmc.model_client.FirewallRule"><code class="xref py py-class docutils literal notranslate"><span class="pre">FirewallRule</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vpns</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.Vpn" title="com.vmware.vmc.model_client.Vpn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Vpn</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.GlcmBundle">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">GlcmBundle</code><span class="sig-paren">(</span><em>s3_bucket=None</em>, <em>id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.GlcmBundle" 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 GlcmBundle used for deploying the sddc</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>s3_bucket</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 glcmbundle’s s3 bucket</li>
|
||
<li><strong>id</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 glcmbundle’s id</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.HostLeaseInfo">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">HostLeaseInfo</code><span class="sig-paren">(</span><em>mac_address=None</em>, <em>ends=None</em>, <em>abandoned=None</em>, <em>cltt=None</em>, <em>client_hostname=None</em>, <em>starts=None</em>, <em>binding_state=None</em>, <em>hardware_type=None</em>, <em>tsfp=None</em>, <em>uid=None</em>, <em>next_binding_state=None</em>, <em>ip_address=None</em>, <em>tstp=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.HostLeaseInfo" 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>DHCP lease information.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>mac_address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – MAC address of the client.</li>
|
||
<li><strong>ends</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>) – End time of the lease.</li>
|
||
<li><strong>abandoned</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 stamp of when IP address was marked as abandoned.</li>
|
||
<li><strong>cltt</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>) – Client Last Transaction Time of the lease info.</li>
|
||
<li><strong>client_hostname</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Name of the client.</li>
|
||
<li><strong>starts</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>) – Start time of the lease.</li>
|
||
<li><strong>binding_state</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>) – Lease’s binding state.</li>
|
||
<li><strong>hardware_type</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 hardware type on which the lease will be used.</li>
|
||
<li><strong>tsfp</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 Sent From Partner of the lease info.</li>
|
||
<li><strong>uid</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>) – Uid to identify the DHCP lease.</li>
|
||
<li><strong>next_binding_state</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>) – Indicates what state the lease will move to when the current state
|
||
expires.</li>
|
||
<li><strong>ip_address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – IP address of the client.</li>
|
||
<li><strong>tstp</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 Sent To Partner of the lease info.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.InteractionPermissions">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">InteractionPermissions</code><span class="sig-paren">(</span><em>manage_permission=None</em>, <em>view_permission=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.InteractionPermissions" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>manage_permission</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>) – </li>
|
||
<li><strong>view_permission</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>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.InterfacesDashboardStats">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">InterfacesDashboardStats</code><span class="sig-paren">(</span><em>vnic7_in_pkt=None</em>, <em>vnic0_in_byte=None</em>, <em>vnic8_out_pkt=None</em>, <em>vnic5_in_byte=None</em>, <em>vnic2_in_pkt=None</em>, <em>vnic3_in_pkt=None</em>, <em>vnic6_out_byte=None</em>, <em>vnic3_in_byte=None</em>, <em>vnic8_in_pkt=None</em>, <em>vnic1_in_byte=None</em>, <em>vnic1_out_pkt=None</em>, <em>vnic5_out_byte=None</em>, <em>vnic0_out_pkt=None</em>, <em>vnic0_out_byte=None</em>, <em>vnic6_out_pkt=None</em>, <em>vnic3_out_byte=None</em>, <em>vnic7_in_byte=None</em>, <em>vnic1_out_byte=None</em>, <em>vnic9_out_pkt=None</em>, <em>vnic9_in_pkt=None</em>, <em>vnic4_in_byte=None</em>, <em>vnic5_out_pkt=None</em>, <em>vnic2_out_pkt=None</em>, <em>vnic2_in_byte=None</em>, <em>vnic5_in_pkt=None</em>, <em>vnic7_out_pkt=None</em>, <em>vnic3_out_pkt=None</em>, <em>vnic4_out_pkt=None</em>, <em>vnic4_out_byte=None</em>, <em>vnic1_in_pkt=None</em>, <em>vnic2_out_byte=None</em>, <em>vnic6_in_byte=None</em>, <em>vnic0_in_pkt=None</em>, <em>vnic9_in_byte=None</em>, <em>vnic7_out_byte=None</em>, <em>vnic4_in_pkt=None</em>, <em>vnic9_out_byte=None</em>, <em>vnic8_out_byte=None</em>, <em>vnic8_in_byte=None</em>, <em>vnic6_in_pkt=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.InterfacesDashboardStats" 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>Dashboard Statistics data for Interfaces.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>vnic7_in_pkt</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic0_in_byte</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic8_out_pkt</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic5_in_byte</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic2_in_pkt</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic3_in_pkt</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic6_out_byte</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic3_in_byte</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic8_in_pkt</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic1_in_byte</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic1_out_pkt</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic5_out_byte</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic0_out_pkt</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic0_out_byte</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic6_out_pkt</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic3_out_byte</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic7_in_byte</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic1_out_byte</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic9_out_pkt</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic9_in_pkt</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic4_in_byte</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic5_out_pkt</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic2_out_pkt</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic2_in_byte</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic5_in_pkt</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic7_out_pkt</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic3_out_pkt</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic4_out_pkt</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic4_out_byte</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic1_in_pkt</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic2_out_byte</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic6_in_byte</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic0_in_pkt</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic9_in_byte</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic7_out_byte</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic4_in_pkt</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic9_out_byte</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic8_out_byte</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic8_in_byte</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vnic6_in_pkt</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.IpAddresses">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">IpAddresses</code><span class="sig-paren">(</span><em>ip_address=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.IpAddresses" 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>IP address</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>ip_address</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 IP addresses.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.Ipsec">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">Ipsec</code><span class="sig-paren">(</span><em>feature_type=None</em>, <em>logging=None</em>, <em>global_=None</em>, <em>enabled=None</em>, <em>sites=None</em>, <em>disable_event=None</em>, <em>version=None</em>, <em>template=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.Ipsec" 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>NSX Edge IPsec configuration details.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>feature_type</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>) – </li>
|
||
<li><strong>logging</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.Logging" title="com.vmware.vmc.model_client.Logging"><code class="xref py py-class docutils literal notranslate"><span class="pre">Logging</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Configure logging for the feature on NSX Edge appliance. Logging is
|
||
disabled by default. Optional.</li>
|
||
<li><strong>global</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.IpsecGlobalConfig" title="com.vmware.vmc.model_client.IpsecGlobalConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">IpsecGlobalConfig</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – IPsec Global configuration details.</li>
|
||
<li><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Value is true if feature is enabled. Default value is true.
|
||
Optional.</li>
|
||
<li><strong>sites</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.IpsecSites" title="com.vmware.vmc.model_client.IpsecSites"><code class="xref py py-class docutils literal notranslate"><span class="pre">IpsecSites</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – IPsec Site configuration details.</li>
|
||
<li><strong>disable_event</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/disable event generation on NSX Edge appliance for IPsec.</li>
|
||
<li><strong>version</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>) – Version number tracking each configuration change. To avoid
|
||
problems with overwriting changes, always retrieve and modify the
|
||
latest configuration to include the current version number in your
|
||
request. If you provide a version number which is not current, the
|
||
request is rejected. If you omit the version number, the request is
|
||
accepted but may overwrite any current changes if your change is
|
||
not in sync with the latest change. format: int64</li>
|
||
<li><strong>template</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>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.IpsecDashboardStats">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">IpsecDashboardStats</code><span class="sig-paren">(</span><em>ipsec_bytes_out=None</em>, <em>ipsec_bytes_in=None</em>, <em>ipsec_tunnels=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.IpsecDashboardStats" 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>Dashboard Statistics data for Ipsec.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>ipsec_bytes_out</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Tx transmitted bytes.</li>
|
||
<li><strong>ipsec_bytes_in</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Rx received bytes.</li>
|
||
<li><strong>ipsec_tunnels</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Number of Ipsec tunnels.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.IpsecGlobalConfig">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">IpsecGlobalConfig</code><span class="sig-paren">(</span><em>psk=None</em>, <em>ca_certificates=None</em>, <em>service_certificate=None</em>, <em>crl_certificates=None</em>, <em>extension=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.IpsecGlobalConfig" 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>IPsec Global configuration details.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>psk</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>) – IPsec Global Pre Shared Key. Maximum characters is 128. Required
|
||
when peerIp is configured as ‘any’ in NSX Edge IPsec Site
|
||
configuration.</li>
|
||
<li><strong>ca_certificates</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.CaCertificates" title="com.vmware.vmc.model_client.CaCertificates"><code class="xref py py-class docutils literal notranslate"><span class="pre">CaCertificates</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – CA certificate list. Optional.</li>
|
||
<li><strong>service_certificate</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>) – Certificate name or identifier. Required when x.509 is selected as
|
||
the authentication mode.</li>
|
||
<li><strong>crl_certificates</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.CrlCertificates" title="com.vmware.vmc.model_client.CrlCertificates"><code class="xref py py-class docutils literal notranslate"><span class="pre">CrlCertificates</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – CRL certificate list. Optional.</li>
|
||
<li><strong>extension</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>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.IpsecSite">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">IpsecSite</code><span class="sig-paren">(</span><em>psk=None</em>, <em>local_id=None</em>, <em>enable_pfs=None</em>, <em>authentication_mode=None</em>, <em>peer_subnets=None</em>, <em>dh_group=None</em>, <em>site_id=None</em>, <em>description=None</em>, <em>peer_ip=None</em>, <em>name=None</em>, <em>certificate=None</em>, <em>local_ip=None</em>, <em>encryption_algorithm=None</em>, <em>enabled=None</em>, <em>mtu=None</em>, <em>extension=None</em>, <em>peer_id=None</em>, <em>local_subnets=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.IpsecSite" 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>NSX Edge IPsec Site configuration details.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>psk</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>) – Pre Shared Key for the IPsec Site. Required if Site peerIp is not
|
||
‘any’. Global PSK is used when Authentication mode is PSK and Site
|
||
peerIp is ‘any’.</li>
|
||
<li><strong>local_id</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>) – Local ID of the IPsec Site. Defaults to the local IP.</li>
|
||
<li><strong>enable_pfs</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/disable Perfect Forward Secrecy. Default is true.</li>
|
||
<li><strong>authentication_mode</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>) – Authentication mode for the IPsec Site. Valid values are psk and
|
||
x.509, with psk as default.</li>
|
||
<li><strong>peer_subnets</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.Subnets" title="com.vmware.vmc.model_client.Subnets"><code class="xref py py-class docutils literal notranslate"><span class="pre">Subnets</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Peer subnets for which IPsec VPN is configured.</li>
|
||
<li><strong>dh_group</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>) – Diffie-Hellman algorithm group. Defaults to DH14 for FIPS enabled
|
||
NSX Edge. DH2 and DH5 are not supported when FIPS is enabled on NSX
|
||
Edge. Valid values are DH2, DH5, DH14, DH15, DH16.</li>
|
||
<li><strong>site_id</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>) – ID of the IPsec Site configuration provided by NSX Manager.</li>
|
||
<li><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Description of the IPsec Site.</li>
|
||
<li><strong>peer_ip</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>) – IP (IPv4) address or FQDN of the Peer. Can also be specified as
|
||
‘any’. Required.</li>
|
||
<li><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>) – Name of the IPsec Site.</li>
|
||
<li><strong>certificate</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>) – </li>
|
||
<li><strong>local_ip</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>) – Local IP of the IPsec Site. Should be one of the IP addresses
|
||
configured on the uplink interfaces of the NSX Edge. Required.</li>
|
||
<li><strong>encryption_algorithm</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>) – IPsec encryption algorithm with default as aes256. Valid values are
|
||
‘aes’, ‘aes256’, ‘3des’, ‘aes-gcm’.</li>
|
||
<li><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Enable/disable IPsec Site.</li>
|
||
<li><strong>mtu</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>) – MTU for the IPsec site. Defaults to the mtu of the NSX Edge vnic
|
||
specified by the localIp. Optional. format: int32</li>
|
||
<li><strong>extension</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>) – </li>
|
||
<li><strong>peer_id</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>) – Peer ID. Should be unique for all IPsec Site’s configured for an
|
||
NSX Edge.</li>
|
||
<li><strong>local_subnets</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.Subnets" title="com.vmware.vmc.model_client.Subnets"><code class="xref py py-class docutils literal notranslate"><span class="pre">Subnets</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Local subnets for which IPsec VPN is configured.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.IpsecSiteIKEStatus">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">IpsecSiteIKEStatus</code><span class="sig-paren">(</span><em>channel_status=None</em>, <em>channel_state=None</em>, <em>peer_ip_address=None</em>, <em>local_ip_address=None</em>, <em>peer_subnets=None</em>, <em>peer_id=None</em>, <em>last_informational_message=None</em>, <em>local_subnets=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.IpsecSiteIKEStatus" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>channel_status</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>) – </li>
|
||
<li><strong>channel_state</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>) – </li>
|
||
<li><strong>peer_ip_address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>local_ip_address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>peer_subnets</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>) – </li>
|
||
<li><strong>peer_id</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>) – </li>
|
||
<li><strong>last_informational_message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>local_subnets</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>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.IpsecSiteStats">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">IpsecSiteStats</code><span class="sig-paren">(</span><em>rx_bytes_on_site=None</em>, <em>tunnel_stats=None</em>, <em>ike_status=None</em>, <em>site_status=None</em>, <em>tx_bytes_from_site=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.IpsecSiteStats" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>rx_bytes_on_site</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>) – </li>
|
||
<li><strong>tunnel_stats</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.IpsecTunnelStats" title="com.vmware.vmc.model_client.IpsecTunnelStats"><code class="xref py py-class docutils literal notranslate"><span class="pre">IpsecTunnelStats</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>ike_status</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.IpsecSiteIKEStatus" title="com.vmware.vmc.model_client.IpsecSiteIKEStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">IpsecSiteIKEStatus</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>site_status</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>) – </li>
|
||
<li><strong>tx_bytes_from_site</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>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.IpsecSites">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">IpsecSites</code><span class="sig-paren">(</span><em>sites=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.IpsecSites" 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>List of IPsec sites for NSX Edge.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>sites</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.IpsecSite" title="com.vmware.vmc.model_client.IpsecSite"><code class="xref py py-class docutils literal notranslate"><span class="pre">IpsecSite</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.IpsecStatusAndStats">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">IpsecStatusAndStats</code><span class="sig-paren">(</span><em>time_stamp=None</em>, <em>server_status=None</em>, <em>site_statistics=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.IpsecStatusAndStats" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>time_stamp</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>) – </li>
|
||
<li><strong>server_status</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>) – </li>
|
||
<li><strong>site_statistics</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.IpsecSiteStats" title="com.vmware.vmc.model_client.IpsecSiteStats"><code class="xref py py-class docutils literal notranslate"><span class="pre">IpsecSiteStats</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.IpsecTunnelStats">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">IpsecTunnelStats</code><span class="sig-paren">(</span><em>tunnel_status=None</em>, <em>peer_spi=None</em>, <em>rx_bytes_on_local_subnet=None</em>, <em>established_date=None</em>, <em>peer_subnet=None</em>, <em>authentication_algorithm=None</em>, <em>tunnel_state=None</em>, <em>tx_bytes_from_local_subnet=None</em>, <em>last_informational_message=None</em>, <em>local_spi=None</em>, <em>encryption_algorithm=None</em>, <em>local_subnet=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.IpsecTunnelStats" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>tunnel_status</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>) – </li>
|
||
<li><strong>peer_spi</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>) – </li>
|
||
<li><strong>rx_bytes_on_local_subnet</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>) – </li>
|
||
<li><strong>established_date</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>) – </li>
|
||
<li><strong>peer_subnet</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>) – </li>
|
||
<li><strong>authentication_algorithm</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>) – </li>
|
||
<li><strong>tunnel_state</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>) – </li>
|
||
<li><strong>tx_bytes_from_local_subnet</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>) – </li>
|
||
<li><strong>last_informational_message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>local_spi</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>) – </li>
|
||
<li><strong>encryption_algorithm</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>) – </li>
|
||
<li><strong>local_subnet</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>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.KeyValueAttributes">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">KeyValueAttributes</code><span class="sig-paren">(</span><em>value=None</em>, <em>key=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.KeyValueAttributes" 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>Key value pair describing the feature configuration limit.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>value</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>) – Value corresponding to the key of the configuration limit
|
||
parameter.</li>
|
||
<li><strong>key</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>) – Key name of the configuration limit parameter.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.KmsVpcEndpoint">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">KmsVpcEndpoint</code><span class="sig-paren">(</span><em>vpc_endpoint_id=None</em>, <em>network_interface_ids=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.KmsVpcEndpoint" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>vpc_endpoint_id</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 identifier of the VPC endpoint created to AWS Key Management
|
||
Service</li>
|
||
<li><strong>network_interface_ids</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.L2Extension">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">L2Extension</code><span class="sig-paren">(</span><em>tunnel_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.L2Extension" 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>Layer 2 extension.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>tunnel_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Identifier for layer 2 extension tunnel. Valid range: 1-4093.
|
||
format: int32</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.L2Vpn">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">L2Vpn</code><span class="sig-paren">(</span><em>enabled=None</em>, <em>sites=None</em>, <em>listener_ip=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.L2Vpn" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Enable (true) or disable (false) L2 VPN.</li>
|
||
<li><strong>sites</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.Site" title="com.vmware.vmc.model_client.Site"><code class="xref py py-class docutils literal notranslate"><span class="pre">Site</span></code></a>) – Array of L2 vpn site config.</li>
|
||
<li><strong>listener_ip</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>) – Public uplink ip address. IP of external interface on which L2VPN
|
||
service listens to.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.L2vpnStats">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">L2vpnStats</code><span class="sig-paren">(</span><em>tunnel_status=None</em>, <em>established_date=None</em>, <em>name=None</em>, <em>dropped_rx_packets=None</em>, <em>encryption_algorithm=None</em>, <em>failure_message=None</em>, <em>tx_bytes_from_local_subnet=None</em>, <em>rx_bytes_on_local_subnet=None</em>, <em>dropped_tx_packets=None</em>, <em>last_updated_time=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.L2vpnStats" 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>L2 VPN status and statistics of a single L2 VPN site.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>tunnel_status</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>) – Status of the tunnel (UP/DOWN).</li>
|
||
<li><strong>established_date</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>) – Tunnel established date. format: int64</li>
|
||
<li><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>) – User defined name of the site.</li>
|
||
<li><strong>dropped_rx_packets</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 received packets dropped.</li>
|
||
<li><strong>encryption_algorithm</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>) – Cipher used in encryption.</li>
|
||
<li><strong>failure_message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Reason for the tunnel down.</li>
|
||
<li><strong>tx_bytes_from_local_subnet</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 bytes transferred from local subnet.</li>
|
||
<li><strong>rx_bytes_on_local_subnet</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 bytes received on the local subnet.</li>
|
||
<li><strong>dropped_tx_packets</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 transferred packets dropped.</li>
|
||
<li><strong>last_updated_time</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>) – Time stamp of the statistics collection. format: int64</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.L2vpnStatusAndStats">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">L2vpnStatusAndStats</code><span class="sig-paren">(</span><em>time_stamp=None</em>, <em>server_status=None</em>, <em>site_stats=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.L2vpnStatusAndStats" 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>L2 VPN status and statistics.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>time_stamp</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>) – Time stamp of statistics collection. format: int64</li>
|
||
<li><strong>server_status</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>) – </li>
|
||
<li><strong>site_stats</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.L2vpnStats" title="com.vmware.vmc.model_client.L2vpnStats"><code class="xref py py-class docutils literal notranslate"><span class="pre">L2vpnStats</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of statistics for each Site.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.LicenceAclPermissions">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">LicenceAclPermissions</code><span class="sig-paren">(</span><em>data_permission=None</em>, <em>is_licensed=None</em>, <em>access_permission=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.LicenceAclPermissions" 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>Licence and access control information for the feature.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>data_permission</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.DataPermissions" title="com.vmware.vmc.model_client.DataPermissions"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataPermissions</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data access control information for the feature.</li>
|
||
<li><strong>is_licensed</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>) – Value is true if feature is licenced.</li>
|
||
<li><strong>access_permission</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.InteractionPermissions" title="com.vmware.vmc.model_client.InteractionPermissions"><code class="xref py py-class docutils literal notranslate"><span class="pre">InteractionPermissions</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Access control information for the feature.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.LoadBalancerDashboardStats">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">LoadBalancerDashboardStats</code><span class="sig-paren">(</span><em>lb_bps_in=None</em>, <em>lb_http_reqs=None</em>, <em>lb_bps_out=None</em>, <em>lb_sessions=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.LoadBalancerDashboardStats" 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>Dashboard Statistics data for Load Balancer.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>lb_bps_in</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Number of bytes in.</li>
|
||
<li><strong>lb_http_reqs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Number of HTTP requests received by Load Balancer.</li>
|
||
<li><strong>lb_bps_out</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Number of bytes out.</li>
|
||
<li><strong>lb_sessions</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Number of Load Balancer sessions.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.Logging">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">Logging</code><span class="sig-paren">(</span><em>log_level=None</em>, <em>enable=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.Logging" 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>logging.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>log_level</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>) – Log level. Valid values: emergency, alert, critical, error,
|
||
warning, notice, info, debug.</li>
|
||
<li><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>) – Logging enabled.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.LogicalNetwork">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">LogicalNetwork</code><span class="sig-paren">(</span><em>subnet_cidr=None</em>, <em>name=None</em>, <em>gateway_ip=None</em>, <em>dhcp_enabled=None</em>, <em>dhcp_ip_range=None</em>, <em>tunnel_id=None</em>, <em>id=None</em>, <em>network_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.LogicalNetwork" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>subnet_cidr</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 subnet cidr</li>
|
||
<li><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>) – name of the network</li>
|
||
<li><strong>gateway_ip</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>) – gateway ip of the logical network</li>
|
||
<li><strong>dhcp_enabled</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>) – if ‘true’ - enabled; if ‘false’ - disabled</li>
|
||
<li><strong>dhcp_ip_range</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>) – ip range within the subnet mask, range delimiter is ‘-‘ (example
|
||
10.118.10.130-10.118.10.140)</li>
|
||
<li><strong>tunnel_id</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>) – tunnel id of extended network format: int32</li>
|
||
<li><strong>id</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>) – </li>
|
||
<li><strong>network_type</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>) – <p>Possible values are:</p>
|
||
<ul>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.LogicalNetwork.NETWORK_TYPE_HOSTED" title="com.vmware.vmc.model_client.LogicalNetwork.NETWORK_TYPE_HOSTED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">LogicalNetwork.NETWORK_TYPE_HOSTED</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.LogicalNetwork.NETWORK_TYPE_ROUTED" title="com.vmware.vmc.model_client.LogicalNetwork.NETWORK_TYPE_ROUTED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">LogicalNetwork.NETWORK_TYPE_ROUTED</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.LogicalNetwork.NETWORK_TYPE_EXTENDED" title="com.vmware.vmc.model_client.LogicalNetwork.NETWORK_TYPE_EXTENDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">LogicalNetwork.NETWORK_TYPE_EXTENDED</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.LogicalNetwork.NETWORK_TYPE_EXTENDED">
|
||
<code class="descname">NETWORK_TYPE_EXTENDED</code><em class="property"> = 'EXTENDED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.LogicalNetwork.NETWORK_TYPE_EXTENDED" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.LogicalNetwork.NETWORK_TYPE_HOSTED">
|
||
<code class="descname">NETWORK_TYPE_HOSTED</code><em class="property"> = 'HOSTED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.LogicalNetwork.NETWORK_TYPE_HOSTED" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.LogicalNetwork.NETWORK_TYPE_ROUTED">
|
||
<code class="descname">NETWORK_TYPE_ROUTED</code><em class="property"> = 'ROUTED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.LogicalNetwork.NETWORK_TYPE_ROUTED" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.LogicalRouterScope">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">LogicalRouterScope</code><span class="sig-paren">(</span><em>type=None</em>, <em>id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.LogicalRouterScope" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>type</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>) – </li>
|
||
<li><strong>id</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>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.LogicalRouterScopes">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">LogicalRouterScopes</code><span class="sig-paren">(</span><em>logical_router_scope=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.LogicalRouterScopes" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>logical_router_scope</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.LogicalRouterScope" title="com.vmware.vmc.model_client.LogicalRouterScope"><code class="xref py py-class docutils literal notranslate"><span class="pre">LogicalRouterScope</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.MacAddress">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">MacAddress</code><span class="sig-paren">(</span><em>edge_vm_ha_index=None</em>, <em>value=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.MacAddress" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>edge_vm_ha_index</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>) – </li>
|
||
<li><strong>value</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>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.MaintenanceWindow">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">MaintenanceWindow</code><span class="sig-paren">(</span><em>day_of_week=None</em>, <em>hour_of_day=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.MaintenanceWindow" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>day_of_week</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>) – <p>Possible values are:</p>
|
||
<ul>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.MaintenanceWindow.DAY_OF_WEEK_SUNDAY" title="com.vmware.vmc.model_client.MaintenanceWindow.DAY_OF_WEEK_SUNDAY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">MaintenanceWindow.DAY_OF_WEEK_SUNDAY</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.MaintenanceWindow.DAY_OF_WEEK_MONDAY" title="com.vmware.vmc.model_client.MaintenanceWindow.DAY_OF_WEEK_MONDAY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">MaintenanceWindow.DAY_OF_WEEK_MONDAY</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.MaintenanceWindow.DAY_OF_WEEK_TUESDAY" title="com.vmware.vmc.model_client.MaintenanceWindow.DAY_OF_WEEK_TUESDAY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">MaintenanceWindow.DAY_OF_WEEK_TUESDAY</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.MaintenanceWindow.DAY_OF_WEEK_WEDNESDAY" title="com.vmware.vmc.model_client.MaintenanceWindow.DAY_OF_WEEK_WEDNESDAY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">MaintenanceWindow.DAY_OF_WEEK_WEDNESDAY</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.MaintenanceWindow.DAY_OF_WEEK_THURSDAY" title="com.vmware.vmc.model_client.MaintenanceWindow.DAY_OF_WEEK_THURSDAY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">MaintenanceWindow.DAY_OF_WEEK_THURSDAY</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.MaintenanceWindow.DAY_OF_WEEK_FRIDAY" title="com.vmware.vmc.model_client.MaintenanceWindow.DAY_OF_WEEK_FRIDAY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">MaintenanceWindow.DAY_OF_WEEK_FRIDAY</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.MaintenanceWindow.DAY_OF_WEEK_SATURDAY" title="com.vmware.vmc.model_client.MaintenanceWindow.DAY_OF_WEEK_SATURDAY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">MaintenanceWindow.DAY_OF_WEEK_SATURDAY</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>hour_of_day</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>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.MaintenanceWindow.DAY_OF_WEEK_FRIDAY">
|
||
<code class="descname">DAY_OF_WEEK_FRIDAY</code><em class="property"> = 'FRIDAY'</em><a class="headerlink" href="#com.vmware.vmc.model_client.MaintenanceWindow.DAY_OF_WEEK_FRIDAY" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.MaintenanceWindow.DAY_OF_WEEK_MONDAY">
|
||
<code class="descname">DAY_OF_WEEK_MONDAY</code><em class="property"> = 'MONDAY'</em><a class="headerlink" href="#com.vmware.vmc.model_client.MaintenanceWindow.DAY_OF_WEEK_MONDAY" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.MaintenanceWindow.DAY_OF_WEEK_SATURDAY">
|
||
<code class="descname">DAY_OF_WEEK_SATURDAY</code><em class="property"> = 'SATURDAY'</em><a class="headerlink" href="#com.vmware.vmc.model_client.MaintenanceWindow.DAY_OF_WEEK_SATURDAY" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.MaintenanceWindow.DAY_OF_WEEK_SUNDAY">
|
||
<code class="descname">DAY_OF_WEEK_SUNDAY</code><em class="property"> = 'SUNDAY'</em><a class="headerlink" href="#com.vmware.vmc.model_client.MaintenanceWindow.DAY_OF_WEEK_SUNDAY" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.MaintenanceWindow.DAY_OF_WEEK_THURSDAY">
|
||
<code class="descname">DAY_OF_WEEK_THURSDAY</code><em class="property"> = 'THURSDAY'</em><a class="headerlink" href="#com.vmware.vmc.model_client.MaintenanceWindow.DAY_OF_WEEK_THURSDAY" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.MaintenanceWindow.DAY_OF_WEEK_TUESDAY">
|
||
<code class="descname">DAY_OF_WEEK_TUESDAY</code><em class="property"> = 'TUESDAY'</em><a class="headerlink" href="#com.vmware.vmc.model_client.MaintenanceWindow.DAY_OF_WEEK_TUESDAY" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.MaintenanceWindow.DAY_OF_WEEK_WEDNESDAY">
|
||
<code class="descname">DAY_OF_WEEK_WEDNESDAY</code><em class="property"> = 'WEDNESDAY'</em><a class="headerlink" href="#com.vmware.vmc.model_client.MaintenanceWindow.DAY_OF_WEEK_WEDNESDAY" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.MaintenanceWindowEntry">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">MaintenanceWindowEntry</code><span class="sig-paren">(</span><em>in_maintenance_window=None</em>, <em>reservation_schedule=None</em>, <em>reservation_id=None</em>, <em>in_maintenance_mode=None</em>, <em>sddc_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.MaintenanceWindowEntry" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>in_maintenance_window</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>) – true if the SDDC is in the defined Mainentance Window</li>
|
||
<li><strong>reservation_schedule</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.ReservationSchedule" title="com.vmware.vmc.model_client.ReservationSchedule"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReservationSchedule</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>reservation_id</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>) – ID for reservation format: uuid</li>
|
||
<li><strong>in_maintenance_mode</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>) – true if the SDDC is currently undergoing maintenance</li>
|
||
<li><strong>sddc_id</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>) – SDDC ID for this reservation format: uuid</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.MaintenanceWindowGet">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">MaintenanceWindowGet</code><span class="sig-paren">(</span><em>day_of_week=None</em>, <em>hour_of_day=None</em>, <em>duration_min=None</em>, <em>version=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.MaintenanceWindowGet" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>day_of_week</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>) – <p>Possible values are:</p>
|
||
<ul>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.MaintenanceWindowGet.DAY_OF_WEEK_SUNDAY" title="com.vmware.vmc.model_client.MaintenanceWindowGet.DAY_OF_WEEK_SUNDAY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">MaintenanceWindowGet.DAY_OF_WEEK_SUNDAY</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.MaintenanceWindowGet.DAY_OF_WEEK_MONDAY" title="com.vmware.vmc.model_client.MaintenanceWindowGet.DAY_OF_WEEK_MONDAY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">MaintenanceWindowGet.DAY_OF_WEEK_MONDAY</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.MaintenanceWindowGet.DAY_OF_WEEK_TUESDAY" title="com.vmware.vmc.model_client.MaintenanceWindowGet.DAY_OF_WEEK_TUESDAY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">MaintenanceWindowGet.DAY_OF_WEEK_TUESDAY</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.MaintenanceWindowGet.DAY_OF_WEEK_WEDNESDAY" title="com.vmware.vmc.model_client.MaintenanceWindowGet.DAY_OF_WEEK_WEDNESDAY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">MaintenanceWindowGet.DAY_OF_WEEK_WEDNESDAY</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.MaintenanceWindowGet.DAY_OF_WEEK_THURSDAY" title="com.vmware.vmc.model_client.MaintenanceWindowGet.DAY_OF_WEEK_THURSDAY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">MaintenanceWindowGet.DAY_OF_WEEK_THURSDAY</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.MaintenanceWindowGet.DAY_OF_WEEK_FRIDAY" title="com.vmware.vmc.model_client.MaintenanceWindowGet.DAY_OF_WEEK_FRIDAY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">MaintenanceWindowGet.DAY_OF_WEEK_FRIDAY</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.MaintenanceWindowGet.DAY_OF_WEEK_SATURDAY" title="com.vmware.vmc.model_client.MaintenanceWindowGet.DAY_OF_WEEK_SATURDAY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">MaintenanceWindowGet.DAY_OF_WEEK_SATURDAY</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>hour_of_day</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>) – </li>
|
||
<li><strong>duration_min</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>) – </li>
|
||
<li><strong>version</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>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.MaintenanceWindowGet.DAY_OF_WEEK_FRIDAY">
|
||
<code class="descname">DAY_OF_WEEK_FRIDAY</code><em class="property"> = 'FRIDAY'</em><a class="headerlink" href="#com.vmware.vmc.model_client.MaintenanceWindowGet.DAY_OF_WEEK_FRIDAY" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.MaintenanceWindowGet.DAY_OF_WEEK_MONDAY">
|
||
<code class="descname">DAY_OF_WEEK_MONDAY</code><em class="property"> = 'MONDAY'</em><a class="headerlink" href="#com.vmware.vmc.model_client.MaintenanceWindowGet.DAY_OF_WEEK_MONDAY" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.MaintenanceWindowGet.DAY_OF_WEEK_SATURDAY">
|
||
<code class="descname">DAY_OF_WEEK_SATURDAY</code><em class="property"> = 'SATURDAY'</em><a class="headerlink" href="#com.vmware.vmc.model_client.MaintenanceWindowGet.DAY_OF_WEEK_SATURDAY" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.MaintenanceWindowGet.DAY_OF_WEEK_SUNDAY">
|
||
<code class="descname">DAY_OF_WEEK_SUNDAY</code><em class="property"> = 'SUNDAY'</em><a class="headerlink" href="#com.vmware.vmc.model_client.MaintenanceWindowGet.DAY_OF_WEEK_SUNDAY" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.MaintenanceWindowGet.DAY_OF_WEEK_THURSDAY">
|
||
<code class="descname">DAY_OF_WEEK_THURSDAY</code><em class="property"> = 'THURSDAY'</em><a class="headerlink" href="#com.vmware.vmc.model_client.MaintenanceWindowGet.DAY_OF_WEEK_THURSDAY" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.MaintenanceWindowGet.DAY_OF_WEEK_TUESDAY">
|
||
<code class="descname">DAY_OF_WEEK_TUESDAY</code><em class="property"> = 'TUESDAY'</em><a class="headerlink" href="#com.vmware.vmc.model_client.MaintenanceWindowGet.DAY_OF_WEEK_TUESDAY" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.MaintenanceWindowGet.DAY_OF_WEEK_WEDNESDAY">
|
||
<code class="descname">DAY_OF_WEEK_WEDNESDAY</code><em class="property"> = 'WEDNESDAY'</em><a class="headerlink" href="#com.vmware.vmc.model_client.MaintenanceWindowGet.DAY_OF_WEEK_WEDNESDAY" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.ManagementGatewayTemplate">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">ManagementGatewayTemplate</code><span class="sig-paren">(</span><em>public_ip=None</em>, <em>primary_dns=None</em>, <em>secondary_dns=None</em>, <em>firewall_rules=None</em>, <em>vpns=None</em>, <em>subnet_cidr=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.ManagementGatewayTemplate" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>public_ip</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.SddcPublicIp" title="com.vmware.vmc.model_client.SddcPublicIp"><code class="xref py py-class docutils literal notranslate"><span class="pre">SddcPublicIp</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>primary_dns</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>) – </li>
|
||
<li><strong>secondary_dns</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>) – </li>
|
||
<li><strong>firewall_rules</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.FirewallRule" title="com.vmware.vmc.model_client.FirewallRule"><code class="xref py py-class docutils literal notranslate"><span class="pre">FirewallRule</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vpns</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.Vpn" title="com.vmware.vmc.model_client.Vpn"><code class="xref py py-class docutils literal notranslate"><span class="pre">Vpn</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>subnet_cidr</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>) – mgw network subnet cidr</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.MapZonesRequest">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">MapZonesRequest</code><span class="sig-paren">(</span><em>connected_account_id=None</em>, <em>org_id=None</em>, <em>petronas_regions_to_map=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.MapZonesRequest" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>connected_account_id</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 connected account ID to remap. This is a standard UUID.</li>
|
||
<li><strong>org_id</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 org ID to remap in. This is a standard UUID.</li>
|
||
<li><strong>petronas_regions_to_map</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>) – A list of Petronas regions to map.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.MetaDashboardStats">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">MetaDashboardStats</code><span class="sig-paren">(</span><em>vnics=None</em>, <em>end_time=None</em>, <em>start_time=None</em>, <em>interval=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.MetaDashboardStats" 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>Start time, end time and interval details.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>vnics</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.Vnic" title="com.vmware.vmc.model_client.Vnic"><code class="xref py py-class docutils literal notranslate"><span class="pre">Vnic</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Statistics data is collected for these vNICs.</li>
|
||
<li><strong>end_time</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>) – End time in seconds. format: int64</li>
|
||
<li><strong>start_time</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>) – Start time in seconds. format: int64</li>
|
||
<li><strong>interval</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>) – Time interval in seconds. format: int32</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.Metadata">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">Metadata</code><span class="sig-paren">(</span><em>timestamp=None</em>, <em>cycle_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.Metadata" 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>metadata of the sddc manifest</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>timestamp</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 timestamp for the bundle</li>
|
||
<li><strong>cycle_id</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 cycle id</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.Nat">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">Nat</code><span class="sig-paren">(</span><em>rules=None</em>, <em>feature_type=None</em>, <em>version=None</em>, <em>enabled=None</em>, <em>template=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.Nat" 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>NAT configuration</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>rules</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.NatRules" title="com.vmware.vmc.model_client.NatRules"><code class="xref py py-class docutils literal notranslate"><span class="pre">NatRules</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Ordered list of NAT rules.</li>
|
||
<li><strong>feature_type</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>) – </li>
|
||
<li><strong>version</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>) – Version number tracking each configuration change. To avoid
|
||
problems with overwriting changes, always retrieve and modify the
|
||
latest configuration to include the current version number in your
|
||
request. If you provide a version number which is not current, the
|
||
request is rejected. If you omit the version number, the request is
|
||
accepted but may overwrite any current changes if your change is
|
||
not in sync with the latest change. format: int64</li>
|
||
<li><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Value is true if feature is enabled. Default value is true.
|
||
Optional.</li>
|
||
<li><strong>template</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>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.NatRule">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">NatRule</code><span class="sig-paren">(</span><em>rule_type=None</em>, <em>protocol=None</em>, <em>name=None</em>, <em>internal_ports=None</em>, <em>public_ports=None</em>, <em>public_ip=None</em>, <em>internal_ip=None</em>, <em>action=None</em>, <em>id=None</em>, <em>revision=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.NatRule" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>rule_type</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>) – </li>
|
||
<li><strong>protocol</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>) – </li>
|
||
<li><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>) – </li>
|
||
<li><strong>internal_ports</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>) – </li>
|
||
<li><strong>public_ports</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>) – </li>
|
||
<li><strong>public_ip</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>) – </li>
|
||
<li><strong>internal_ip</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>) – </li>
|
||
<li><strong>action</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>) – <p>Possible values are:</p>
|
||
<ul>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.NatRule.ACTION_DNAT" title="com.vmware.vmc.model_client.NatRule.ACTION_DNAT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">NatRule.ACTION_DNAT</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.NatRule.ACTION_SNAT" title="com.vmware.vmc.model_client.NatRule.ACTION_SNAT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">NatRule.ACTION_SNAT</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>id</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>) – </li>
|
||
<li><strong>revision</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>) – current revision of the list of nat rules, used to protect against
|
||
concurrent modification (first writer wins) format: int32
|
||
This attribute may be present in responses from the server, but if
|
||
it is present in a request to server it will be ignored.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.NatRule.ACTION_DNAT">
|
||
<code class="descname">ACTION_DNAT</code><em class="property"> = 'dnat'</em><a class="headerlink" href="#com.vmware.vmc.model_client.NatRule.ACTION_DNAT" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.NatRule.ACTION_SNAT">
|
||
<code class="descname">ACTION_SNAT</code><em class="property"> = 'snat'</em><a class="headerlink" href="#com.vmware.vmc.model_client.NatRule.ACTION_SNAT" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.NatRules">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">NatRules</code><span class="sig-paren">(</span><em>nat_rules_dtos=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.NatRules" 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>Ordered list of NAT rules.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>nat_rules_dtos</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.Nsxnatrule" title="com.vmware.vmc.model_client.Nsxnatrule"><code class="xref py py-class docutils literal notranslate"><span class="pre">Nsxnatrule</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Ordered list of NAT rules.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.NetworkTemplate">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">NetworkTemplate</code><span class="sig-paren">(</span><em>management_gateway_templates=None</em>, <em>compute_gateway_templates=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.NetworkTemplate" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>management_gateway_templates</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.ManagementGatewayTemplate" title="com.vmware.vmc.model_client.ManagementGatewayTemplate"><code class="xref py py-class docutils literal notranslate"><span class="pre">ManagementGatewayTemplate</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>compute_gateway_templates</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.ComputeGatewayTemplate" title="com.vmware.vmc.model_client.ComputeGatewayTemplate"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComputeGatewayTemplate</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.Nsxfirewallrule">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">Nsxfirewallrule</code><span class="sig-paren">(</span><em>rule_type=None</em>, <em>description=None</em>, <em>rule_id=None</em>, <em>match_translated=None</em>, <em>invalid_application=None</em>, <em>direction=None</em>, <em>statistics=None</em>, <em>name=None</em>, <em>invalid_source=None</em>, <em>logging_enabled=None</em>, <em>destination=None</em>, <em>enabled=None</em>, <em>application=None</em>, <em>source=None</em>, <em>action=None</em>, <em>invalid_destination=None</em>, <em>rule_tag=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.Nsxfirewallrule" 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>Firewall Rule</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>rule_type</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>) – Identifies the type of the rule. internal_high or user.</li>
|
||
<li><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Description for the rule</li>
|
||
<li><strong>rule_id</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>) – Identifier for the rule. format: int64</li>
|
||
<li><strong>match_translated</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>) – Defines the order of NAT and Firewall pipeline. When false,
|
||
firewall happens before NAT. Default : false</li>
|
||
<li><strong>invalid_application</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>) – </li>
|
||
<li><strong>direction</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>) – Direction. Possible values in or out. Default is ‘any’.</li>
|
||
<li><strong>statistics</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.FirewallRuleStats" title="com.vmware.vmc.model_client.FirewallRuleStats"><code class="xref py py-class docutils literal notranslate"><span class="pre">FirewallRuleStats</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Statistics for the rule</li>
|
||
<li><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>) – Name for the rule.</li>
|
||
<li><strong>invalid_source</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>) – </li>
|
||
<li><strong>logging_enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Enable logging for the rule.</li>
|
||
<li><strong>destination</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.AddressFWSourceDestination" title="com.vmware.vmc.model_client.AddressFWSourceDestination"><code class="xref py py-class docutils literal notranslate"><span class="pre">AddressFWSourceDestination</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of destinations. Default is any.</li>
|
||
<li><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Enable rule.</li>
|
||
<li><strong>application</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.Application" title="com.vmware.vmc.model_client.Application"><code class="xref py py-class docutils literal notranslate"><span class="pre">Application</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of applications. Default is any.</li>
|
||
<li><strong>source</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.AddressFWSourceDestination" title="com.vmware.vmc.model_client.AddressFWSourceDestination"><code class="xref py py-class docutils literal notranslate"><span class="pre">AddressFWSourceDestination</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of sources. Default is any.</li>
|
||
<li><strong>action</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>) – Action. Values : accept, deny</li>
|
||
<li><strong>invalid_destination</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>) – </li>
|
||
<li><strong>rule_tag</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>) – Rule tag. Used to specify user-defined ruleId. If not specified NSX
|
||
Manager will generate ruleId. format: int64</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.Nsxfirewallservice">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">Nsxfirewallservice</code><span class="sig-paren">(</span><em>source_port=None</em>, <em>protocol=None</em>, <em>port=None</em>, <em>icmp_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.Nsxfirewallservice" 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>Application (service) for firewall rule.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>source_port</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 source ports.</li>
|
||
<li><strong>protocol</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>) – Protocol.</li>
|
||
<li><strong>port</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 destination ports.</li>
|
||
<li><strong>icmp_type</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>) – IcmpType. Only supported when protocol is icmp. Default is ‘any’.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.Nsxl2vpn">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">Nsxl2vpn</code><span class="sig-paren">(</span><em>listener_ips=None</em>, <em>enabled=None</em>, <em>sites=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.Nsxl2vpn" 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>L2 VPN server configuration.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>listener_ips</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>) – Listener IP addresses.</li>
|
||
<li><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Enabled state of L2 VPN service.</li>
|
||
<li><strong>sites</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.Sites" title="com.vmware.vmc.model_client.Sites"><code class="xref py py-class docutils literal notranslate"><span class="pre">Sites</span></code></a>) – List of L2 VPN sites.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.Nsxnatrule">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">Nsxnatrule</code><span class="sig-paren">(</span><em>vnic=None</em>, <em>rule_type=None</em>, <em>protocol=None</em>, <em>description=None</em>, <em>rule_id=None</em>, <em>snat_match_destination_port=None</em>, <em>original_address=None</em>, <em>dnat_match_source_address=None</em>, <em>dnat_match_source_port=None</em>, <em>snat_match_destination_address=None</em>, <em>original_port=None</em>, <em>logging_enabled=None</em>, <em>translated_address=None</em>, <em>enabled=None</em>, <em>icmp_type=None</em>, <em>translated_port=None</em>, <em>action=None</em>, <em>rule_tag=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.Nsxnatrule" 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>NAT rule</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>vnic</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Interface on which the NAT rule is applied.</li>
|
||
<li><strong>rule_type</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>) – Identifies the type of the rule. internal_high or user.</li>
|
||
<li><strong>protocol</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>) – Protocol. Default is ‘any’</li>
|
||
<li><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Description for the rule.</li>
|
||
<li><strong>rule_id</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>) – Identifier for the rule. format: int64</li>
|
||
<li><strong>snat_match_destination_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>) – Apply SNAT rule only if traffic has this destination port. Default
|
||
is ‘any’.</li>
|
||
<li><strong>original_address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Original address or address range. This is the original source
|
||
address for SNAT rules and the original destination address for
|
||
DNAT rules.</li>
|
||
<li><strong>dnat_match_source_address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Apply DNAT rule only if traffic has this source address. Default is
|
||
‘any’.</li>
|
||
<li><strong>dnat_match_source_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>) – Apply DNAT rule only if traffic has this source port. Default is
|
||
‘any’.</li>
|
||
<li><strong>snat_match_destination_address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Apply SNAT rule only if traffic has this destination address.
|
||
Default is ‘any’.</li>
|
||
<li><strong>original_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>) – Original port. This is the original source port for SNAT rules, and
|
||
the original destination port for DNAT rules.</li>
|
||
<li><strong>logging_enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Enable logging for the rule.</li>
|
||
<li><strong>translated_address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Translated address or address range.</li>
|
||
<li><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Enable rule.</li>
|
||
<li><strong>icmp_type</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>) – ICMP type. Only supported when protocol is icmp. Default is ‘any’.</li>
|
||
<li><strong>translated_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>) – Translated port. Supported in DNAT rules only.</li>
|
||
<li><strong>action</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>) – Action for the rule. SNAT or DNAT.</li>
|
||
<li><strong>rule_tag</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>) – Rule tag. Used to specify user-defined ruleId. If not specified NSX
|
||
Manager will generate ruleId. format: int64</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.Nsxsite">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">Nsxsite</code><span class="sig-paren">(</span><em>secure_traffic=None</em>, <em>site_id=None</em>, <em>name=None</em>, <em>password=None</em>, <em>user_id=None</em>, <em>description=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.Nsxsite" 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>L2 VPN site.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>secure_traffic</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>) – Secure L2VPN traffic.</li>
|
||
<li><strong>site_id</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>) – Identifier for L2 VPN site.</li>
|
||
<li><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>) – Name of L2 VPN site. Length: 1-255 characters.</li>
|
||
<li><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 L2 VPN user. Passwords must contain the following:
|
||
12-63 characters, a mix of upper case letters, lower case letters,
|
||
numbers, and at least one special character. Password must not
|
||
contain the username as a substring. Do not repeat a character 3 or
|
||
more times.</li>
|
||
<li><strong>user_id</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>) – L2 VPN user ID. Valid user names: 1-63 characters, letters and
|
||
numbers only. No white space or special characters.</li>
|
||
<li><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Description of L2 VPN site.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.ObjectType">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">ObjectType</code><span class="sig-paren">(</span><em>name=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.ObjectType" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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>) – </td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.OfferInstancesHolder">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">OfferInstancesHolder</code><span class="sig-paren">(</span><em>on_demand=None</em>, <em>offers=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.OfferInstancesHolder" 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>Holder for the offer instances.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>on_demand</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.OnDemandOfferInstance" title="com.vmware.vmc.model_client.OnDemandOfferInstance"><code class="xref py py-class docutils literal notranslate"><span class="pre">OnDemandOfferInstance</span></code></a>) – </li>
|
||
<li><strong>offers</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.TermOfferInstance" title="com.vmware.vmc.model_client.TermOfferInstance"><code class="xref py py-class docutils literal notranslate"><span class="pre">TermOfferInstance</span></code></a>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.OfferType">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">OfferType</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.OfferType" 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>
|
||
<div class="admonition note">
|
||
<p class="first admonition-title">Note</p>
|
||
<p class="last">This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <a class="reference internal" href="#com.vmware.vmc.model_client.OfferType" title="com.vmware.vmc.model_client.OfferType"><code class="xref py py-class docutils literal notranslate"><span class="pre">OfferType</span></code></a> instance.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.OfferType.ON_DEMAND">
|
||
<code class="descname">ON_DEMAND</code><em class="property"> = OfferType(string='ON_DEMAND')</em><a class="headerlink" href="#com.vmware.vmc.model_client.OfferType.ON_DEMAND" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.OfferType.TERM">
|
||
<code class="descname">TERM</code><em class="property"> = OfferType(string='TERM')</em><a class="headerlink" href="#com.vmware.vmc.model_client.OfferType.TERM" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.OnDemandOfferInstance">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">OnDemandOfferInstance</code><span class="sig-paren">(</span><em>product_type=None</em>, <em>name=None</em>, <em>currency=None</em>, <em>region=None</em>, <em>unit_price=None</em>, <em>monthly_cost=None</em>, <em>version=None</em>, <em>description=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.OnDemandOfferInstance" 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>Holder for the on-demand offer instance.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>product_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </li>
|
||
<li><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </li>
|
||
<li><strong>currency</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </li>
|
||
<li><strong>region</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </li>
|
||
<li><strong>unit_price</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </li>
|
||
<li><strong>monthly_cost</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </li>
|
||
<li><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </li>
|
||
<li><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.OrgProperties">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">OrgProperties</code><span class="sig-paren">(</span><em>values=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.OrgProperties" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>values</strong> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – A map of string properties to values.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.Organization">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">Organization</code><span class="sig-paren">(</span><em>updated=None</em>, <em>user_id=None</em>, <em>updated_by_user_id=None</em>, <em>created=None</em>, <em>version=None</em>, <em>updated_by_user_name=None</em>, <em>user_name=None</em>, <em>id=None</em>, <em>org_type=None</em>, <em>properties=None</em>, <em>project_state=None</em>, <em>name=None</em>, <em>display_name=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.Organization" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>updated</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – </li>
|
||
<li><strong>user_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User id that last updated this record</li>
|
||
<li><strong>updated_by_user_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User id that last updated this record</li>
|
||
<li><strong>created</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – </li>
|
||
<li><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Version of this entity format: int32</li>
|
||
<li><strong>updated_by_user_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>) – User name that last updated this record</li>
|
||
<li><strong>user_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User name that last updated this record</li>
|
||
<li><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Unique ID for this entity</li>
|
||
<li><strong>org_type</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>) – ORG_TYPE to be associated with the org</li>
|
||
<li><strong>properties</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.OrgProperties" title="com.vmware.vmc.model_client.OrgProperties"><code class="xref py py-class docutils literal notranslate"><span class="pre">OrgProperties</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>project_state</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>) – <p>Possible values are:</p>
|
||
<ul>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.Organization.PROJECT_STATE_CREATED" title="com.vmware.vmc.model_client.Organization.PROJECT_STATE_CREATED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Organization.PROJECT_STATE_CREATED</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.Organization.PROJECT_STATE_DELETED" title="com.vmware.vmc.model_client.Organization.PROJECT_STATE_DELETED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Organization.PROJECT_STATE_DELETED</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li><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>) – </li>
|
||
<li><strong>display_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>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.Organization.PROJECT_STATE_CREATED">
|
||
<code class="descname">PROJECT_STATE_CREATED</code><em class="property"> = 'CREATED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Organization.PROJECT_STATE_CREATED" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.Organization.PROJECT_STATE_DELETED">
|
||
<code class="descname">PROJECT_STATE_DELETED</code><em class="property"> = 'DELETED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Organization.PROJECT_STATE_DELETED" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.PagedEdgeList">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">PagedEdgeList</code><span class="sig-paren">(</span><em>edge_page=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.PagedEdgeList" 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>NSX Edges listed by pages.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>edge_page</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.DataPageEdgeSummary" title="com.vmware.vmc.model_client.DataPageEdgeSummary"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataPageEdgeSummary</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Page details with matched records.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.PagingInfo">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">PagingInfo</code><span class="sig-paren">(</span><em>sort_order_ascending=None</em>, <em>total_count=None</em>, <em>start_index=None</em>, <em>sort_by=None</em>, <em>page_size=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.PagingInfo" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>sort_order_ascending</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>) – </li>
|
||
<li><strong>total_count</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>) – </li>
|
||
<li><strong>start_index</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>) – </li>
|
||
<li><strong>sort_by</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>) – </li>
|
||
<li><strong>page_size</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>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.PopAmiInfo">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">PopAmiInfo</code><span class="sig-paren">(</span><em>region=None</em>, <em>id=None</em>, <em>name=None</em>, <em>type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.PopAmiInfo" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>region</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 region of the esx ami</li>
|
||
<li><strong>id</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 ami id for the esx</li>
|
||
<li><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>) – the name of the esx ami</li>
|
||
<li><strong>type</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>) – <p>Possible values are:</p>
|
||
<ul>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.PopAmiInfo.TYPE_CENTOS" title="com.vmware.vmc.model_client.PopAmiInfo.TYPE_CENTOS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">PopAmiInfo.TYPE_CENTOS</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.PopAmiInfo.TYPE_POP" title="com.vmware.vmc.model_client.PopAmiInfo.TYPE_POP"><code class="xref py py-attr docutils literal notranslate"><span class="pre">PopAmiInfo.TYPE_POP</span></code></a></li>
|
||
</ul>
|
||
<blockquote>
|
||
<div>PoP AMI type. CENTOS: a Centos AMI; POP: a PoP AMI.</div></blockquote>
|
||
</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.PopAmiInfo.TYPE_CENTOS">
|
||
<code class="descname">TYPE_CENTOS</code><em class="property"> = 'CENTOS'</em><a class="headerlink" href="#com.vmware.vmc.model_client.PopAmiInfo.TYPE_CENTOS" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.PopAmiInfo.TYPE_POP">
|
||
<code class="descname">TYPE_POP</code><em class="property"> = 'POP'</em><a class="headerlink" href="#com.vmware.vmc.model_client.PopAmiInfo.TYPE_POP" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.PopInfo">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">PopInfo</code><span class="sig-paren">(</span><em>ami_infos=None</em>, <em>created_at=None</em>, <em>id=None</em>, <em>service_infos=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.PopInfo" 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>Present a SDDC PoP information.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>ami_infos</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vmc.model_client.PopAmiInfo" title="com.vmware.vmc.model_client.PopAmiInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">PopAmiInfo</span></code></a>) – A map of [region name of PoP / PoP-AMI]:[PopAmiInfo].</li>
|
||
<li><strong>created_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>) – The PopInfo (or PoP AMI) created time. Using ISO 8601 date-time
|
||
pattern. format: date-time</li>
|
||
<li><strong>id</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>) – UUID of the PopInfo format: UUID</li>
|
||
<li><strong>service_infos</strong> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vmc.model_client.PopServiceInfo" title="com.vmware.vmc.model_client.PopServiceInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">PopServiceInfo</span></code></a>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – A map of [service type]:[PopServiceInfo]</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.PopServiceInfo">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">PopServiceInfo</code><span class="sig-paren">(</span><em>cln=None</em>, <em>version=None</em>, <em>build=None</em>, <em>service=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.PopServiceInfo" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>cln</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 service change set number.</li>
|
||
<li><strong>version</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 service API version.</li>
|
||
<li><strong>build</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 service build number.</li>
|
||
<li><strong>service</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>) – <p>Possible values are:</p>
|
||
<ul>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_OS" title="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_OS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">PopServiceInfo.SERVICE_OS</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_AGENT" title="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_AGENT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">PopServiceInfo.SERVICE_AGENT</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_GLCM" title="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_GLCM"><code class="xref py py-attr docutils literal notranslate"><span class="pre">PopServiceInfo.SERVICE_GLCM</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_S3_ADAPTER" title="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_S3_ADAPTER"><code class="xref py py-attr docutils literal notranslate"><span class="pre">PopServiceInfo.SERVICE_S3_ADAPTER</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_JRE" title="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_JRE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">PopServiceInfo.SERVICE_JRE</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_DOCKER" title="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_DOCKER"><code class="xref py py-attr docutils literal notranslate"><span class="pre">PopServiceInfo.SERVICE_DOCKER</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_AIDE" title="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_AIDE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">PopServiceInfo.SERVICE_AIDE</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_RTS" title="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_RTS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">PopServiceInfo.SERVICE_RTS</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_FM_MANAGEMENT" title="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_FM_MANAGEMENT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">PopServiceInfo.SERVICE_FM_MANAGEMENT</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_FM_LOG_COLLECTOR" title="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_FM_LOG_COLLECTOR"><code class="xref py py-attr docutils literal notranslate"><span class="pre">PopServiceInfo.SERVICE_FM_LOG_COLLECTOR</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_FM_METRICS_COLLECTOR" title="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_FM_METRICS_COLLECTOR"><code class="xref py py-attr docutils literal notranslate"><span class="pre">PopServiceInfo.SERVICE_FM_METRICS_COLLECTOR</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_BRE" title="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_BRE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">PopServiceInfo.SERVICE_BRE</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_BRF" title="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_BRF"><code class="xref py py-attr docutils literal notranslate"><span class="pre">PopServiceInfo.SERVICE_BRF</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_REVERSE_PROXY" title="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_REVERSE_PROXY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">PopServiceInfo.SERVICE_REVERSE_PROXY</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_FORWARD_PROXY" title="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_FORWARD_PROXY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">PopServiceInfo.SERVICE_FORWARD_PROXY</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_DNS" title="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_DNS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">PopServiceInfo.SERVICE_DNS</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_NTP" title="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_NTP"><code class="xref py py-attr docutils literal notranslate"><span class="pre">PopServiceInfo.SERVICE_NTP</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_LOGZ_LOG_COLLECTOR" title="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_LOGZ_LOG_COLLECTOR"><code class="xref py py-attr docutils literal notranslate"><span class="pre">PopServiceInfo.SERVICE_LOGZ_LOG_COLLECTOR</span></code></a></li>
|
||
</ul>
|
||
<blockquote>
|
||
<div>An enum of PoP related services (including os platform and JRE).</div></blockquote>
|
||
</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_AGENT">
|
||
<code class="descname">SERVICE_AGENT</code><em class="property"> = 'AGENT'</em><a class="headerlink" href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_AGENT" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_AIDE">
|
||
<code class="descname">SERVICE_AIDE</code><em class="property"> = 'AIDE'</em><a class="headerlink" href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_AIDE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_BRE">
|
||
<code class="descname">SERVICE_BRE</code><em class="property"> = 'BRE'</em><a class="headerlink" href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_BRE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_BRF">
|
||
<code class="descname">SERVICE_BRF</code><em class="property"> = 'BRF'</em><a class="headerlink" href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_BRF" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_DNS">
|
||
<code class="descname">SERVICE_DNS</code><em class="property"> = 'DNS'</em><a class="headerlink" href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_DNS" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_DOCKER">
|
||
<code class="descname">SERVICE_DOCKER</code><em class="property"> = 'DOCKER'</em><a class="headerlink" href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_DOCKER" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_FM_LOG_COLLECTOR">
|
||
<code class="descname">SERVICE_FM_LOG_COLLECTOR</code><em class="property"> = 'FM_LOG_COLLECTOR'</em><a class="headerlink" href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_FM_LOG_COLLECTOR" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_FM_MANAGEMENT">
|
||
<code class="descname">SERVICE_FM_MANAGEMENT</code><em class="property"> = 'FM_MANAGEMENT'</em><a class="headerlink" href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_FM_MANAGEMENT" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_FM_METRICS_COLLECTOR">
|
||
<code class="descname">SERVICE_FM_METRICS_COLLECTOR</code><em class="property"> = 'FM_METRICS_COLLECTOR'</em><a class="headerlink" href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_FM_METRICS_COLLECTOR" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_FORWARD_PROXY">
|
||
<code class="descname">SERVICE_FORWARD_PROXY</code><em class="property"> = 'FORWARD_PROXY'</em><a class="headerlink" href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_FORWARD_PROXY" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_GLCM">
|
||
<code class="descname">SERVICE_GLCM</code><em class="property"> = 'GLCM'</em><a class="headerlink" href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_GLCM" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_JRE">
|
||
<code class="descname">SERVICE_JRE</code><em class="property"> = 'JRE'</em><a class="headerlink" href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_JRE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_LOGZ_LOG_COLLECTOR">
|
||
<code class="descname">SERVICE_LOGZ_LOG_COLLECTOR</code><em class="property"> = 'LOGZ_LOG_COLLECTOR'</em><a class="headerlink" href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_LOGZ_LOG_COLLECTOR" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_NTP">
|
||
<code class="descname">SERVICE_NTP</code><em class="property"> = 'NTP'</em><a class="headerlink" href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_NTP" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_OS">
|
||
<code class="descname">SERVICE_OS</code><em class="property"> = 'OS'</em><a class="headerlink" href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_OS" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_REVERSE_PROXY">
|
||
<code class="descname">SERVICE_REVERSE_PROXY</code><em class="property"> = 'REVERSE_PROXY'</em><a class="headerlink" href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_REVERSE_PROXY" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_RTS">
|
||
<code class="descname">SERVICE_RTS</code><em class="property"> = 'RTS'</em><a class="headerlink" href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_RTS" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_S3_ADAPTER">
|
||
<code class="descname">SERVICE_S3_ADAPTER</code><em class="property"> = 'S3_ADAPTER'</em><a class="headerlink" href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_S3_ADAPTER" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.Requests">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">Requests</code><span class="sig-paren">(</span><em>total=None</em>, <em>queries=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.Requests" 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>DNS request statistics.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>total</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>) – </li>
|
||
<li><strong>queries</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>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.Reservation">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">Reservation</code><span class="sig-paren">(</span><em>duration=None</em>, <em>rid=None</em>, <em>create_time=None</em>, <em>start_time=None</em>, <em>metadata=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.Reservation" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>duration</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>) – Duration - required for reservation in maintenance window format:
|
||
int64</li>
|
||
<li><strong>rid</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>) – Reservation ID format: uuid</li>
|
||
<li><strong>create_time</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>) – Optional</li>
|
||
<li><strong>start_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Start time of a reservation format: date-time</li>
|
||
<li><strong>metadata</strong> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Optional</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.ReservationInMw">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">ReservationInMw</code><span class="sig-paren">(</span><em>rid=None</em>, <em>week_of=None</em>, <em>create_time=None</em>, <em>metadata=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.ReservationInMw" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>rid</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>) – Reservation ID format: uuid</li>
|
||
<li><strong>week_of</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>) – SUNDAY of the week that maintenance is scheduled, ISO format date</li>
|
||
<li><strong>create_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Optional format: date-time</li>
|
||
<li><strong>metadata</strong> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Optional</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.ReservationSchedule">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">ReservationSchedule</code><span class="sig-paren">(</span><em>day_of_week=None</em>, <em>hour_of_day=None</em>, <em>duration_min=None</em>, <em>version=None</em>, <em>reservations=None</em>, <em>reservations_mw=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.ReservationSchedule" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>day_of_week</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>) – <p>Possible values are:</p>
|
||
<ul>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.ReservationSchedule.DAY_OF_WEEK_SUNDAY" title="com.vmware.vmc.model_client.ReservationSchedule.DAY_OF_WEEK_SUNDAY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ReservationSchedule.DAY_OF_WEEK_SUNDAY</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.ReservationSchedule.DAY_OF_WEEK_MONDAY" title="com.vmware.vmc.model_client.ReservationSchedule.DAY_OF_WEEK_MONDAY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ReservationSchedule.DAY_OF_WEEK_MONDAY</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.ReservationSchedule.DAY_OF_WEEK_TUESDAY" title="com.vmware.vmc.model_client.ReservationSchedule.DAY_OF_WEEK_TUESDAY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ReservationSchedule.DAY_OF_WEEK_TUESDAY</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.ReservationSchedule.DAY_OF_WEEK_WEDNESDAY" title="com.vmware.vmc.model_client.ReservationSchedule.DAY_OF_WEEK_WEDNESDAY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ReservationSchedule.DAY_OF_WEEK_WEDNESDAY</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.ReservationSchedule.DAY_OF_WEEK_THURSDAY" title="com.vmware.vmc.model_client.ReservationSchedule.DAY_OF_WEEK_THURSDAY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ReservationSchedule.DAY_OF_WEEK_THURSDAY</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.ReservationSchedule.DAY_OF_WEEK_FRIDAY" title="com.vmware.vmc.model_client.ReservationSchedule.DAY_OF_WEEK_FRIDAY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ReservationSchedule.DAY_OF_WEEK_FRIDAY</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.ReservationSchedule.DAY_OF_WEEK_SATURDAY" title="com.vmware.vmc.model_client.ReservationSchedule.DAY_OF_WEEK_SATURDAY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ReservationSchedule.DAY_OF_WEEK_SATURDAY</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>hour_of_day</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>) – </li>
|
||
<li><strong>duration_min</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>) – </li>
|
||
<li><strong>version</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>) – </li>
|
||
<li><strong>reservations</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.Reservation" title="com.vmware.vmc.model_client.Reservation"><code class="xref py py-class docutils literal notranslate"><span class="pre">Reservation</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>reservations_mw</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.ReservationInMw" title="com.vmware.vmc.model_client.ReservationInMw"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReservationInMw</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.ReservationSchedule.DAY_OF_WEEK_FRIDAY">
|
||
<code class="descname">DAY_OF_WEEK_FRIDAY</code><em class="property"> = 'FRIDAY'</em><a class="headerlink" href="#com.vmware.vmc.model_client.ReservationSchedule.DAY_OF_WEEK_FRIDAY" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.ReservationSchedule.DAY_OF_WEEK_MONDAY">
|
||
<code class="descname">DAY_OF_WEEK_MONDAY</code><em class="property"> = 'MONDAY'</em><a class="headerlink" href="#com.vmware.vmc.model_client.ReservationSchedule.DAY_OF_WEEK_MONDAY" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.ReservationSchedule.DAY_OF_WEEK_SATURDAY">
|
||
<code class="descname">DAY_OF_WEEK_SATURDAY</code><em class="property"> = 'SATURDAY'</em><a class="headerlink" href="#com.vmware.vmc.model_client.ReservationSchedule.DAY_OF_WEEK_SATURDAY" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.ReservationSchedule.DAY_OF_WEEK_SUNDAY">
|
||
<code class="descname">DAY_OF_WEEK_SUNDAY</code><em class="property"> = 'SUNDAY'</em><a class="headerlink" href="#com.vmware.vmc.model_client.ReservationSchedule.DAY_OF_WEEK_SUNDAY" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.ReservationSchedule.DAY_OF_WEEK_THURSDAY">
|
||
<code class="descname">DAY_OF_WEEK_THURSDAY</code><em class="property"> = 'THURSDAY'</em><a class="headerlink" href="#com.vmware.vmc.model_client.ReservationSchedule.DAY_OF_WEEK_THURSDAY" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.ReservationSchedule.DAY_OF_WEEK_TUESDAY">
|
||
<code class="descname">DAY_OF_WEEK_TUESDAY</code><em class="property"> = 'TUESDAY'</em><a class="headerlink" href="#com.vmware.vmc.model_client.ReservationSchedule.DAY_OF_WEEK_TUESDAY" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.ReservationSchedule.DAY_OF_WEEK_WEDNESDAY">
|
||
<code class="descname">DAY_OF_WEEK_WEDNESDAY</code><em class="property"> = 'WEDNESDAY'</em><a class="headerlink" href="#com.vmware.vmc.model_client.ReservationSchedule.DAY_OF_WEEK_WEDNESDAY" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.ReservationWindow">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">ReservationWindow</code><span class="sig-paren">(</span><em>reservation_state=None</em>, <em>emergency=None</em>, <em>maintenance_properties=None</em>, <em>reserve_id=None</em>, <em>start_hour=None</em>, <em>sddc_id=None</em>, <em>manifest_id=None</em>, <em>duration_hours=None</em>, <em>start_date=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.ReservationWindow" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>reservation_state</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>) – <p>Possible values are:</p>
|
||
<ul>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.ReservationWindow.RESERVATION_STATE_SCHEDULED" title="com.vmware.vmc.model_client.ReservationWindow.RESERVATION_STATE_SCHEDULED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ReservationWindow.RESERVATION_STATE_SCHEDULED</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.ReservationWindow.RESERVATION_STATE_RUNNING" title="com.vmware.vmc.model_client.ReservationWindow.RESERVATION_STATE_RUNNING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ReservationWindow.RESERVATION_STATE_RUNNING</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.ReservationWindow.RESERVATION_STATE_CANCELED" title="com.vmware.vmc.model_client.ReservationWindow.RESERVATION_STATE_CANCELED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ReservationWindow.RESERVATION_STATE_CANCELED</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.ReservationWindow.RESERVATION_STATE_COMPLETED" title="com.vmware.vmc.model_client.ReservationWindow.RESERVATION_STATE_COMPLETED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ReservationWindow.RESERVATION_STATE_COMPLETED</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>emergency</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>) – </li>
|
||
<li><strong>maintenance_properties</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.ReservationWindowMaintenanceProperties" title="com.vmware.vmc.model_client.ReservationWindowMaintenanceProperties"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReservationWindowMaintenanceProperties</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>reserve_id</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>) – </li>
|
||
<li><strong>start_hour</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>) – </li>
|
||
<li><strong>sddc_id</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>) – </li>
|
||
<li><strong>manifest_id</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>) – </li>
|
||
<li><strong>duration_hours</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>) – </li>
|
||
<li><strong>start_date</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>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.ReservationWindow.RESERVATION_STATE_CANCELED">
|
||
<code class="descname">RESERVATION_STATE_CANCELED</code><em class="property"> = 'CANCELED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.ReservationWindow.RESERVATION_STATE_CANCELED" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.ReservationWindow.RESERVATION_STATE_COMPLETED">
|
||
<code class="descname">RESERVATION_STATE_COMPLETED</code><em class="property"> = 'COMPLETED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.ReservationWindow.RESERVATION_STATE_COMPLETED" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.ReservationWindow.RESERVATION_STATE_RUNNING">
|
||
<code class="descname">RESERVATION_STATE_RUNNING</code><em class="property"> = 'RUNNING'</em><a class="headerlink" href="#com.vmware.vmc.model_client.ReservationWindow.RESERVATION_STATE_RUNNING" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.ReservationWindow.RESERVATION_STATE_SCHEDULED">
|
||
<code class="descname">RESERVATION_STATE_SCHEDULED</code><em class="property"> = 'SCHEDULED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.ReservationWindow.RESERVATION_STATE_SCHEDULED" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.ReservationWindowMaintenanceProperties">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">ReservationWindowMaintenanceProperties</code><span class="sig-paren">(</span><em>status=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.ReservationWindowMaintenanceProperties" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>status</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>) – Status of upgrade, if any</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.Result">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">Result</code><span class="sig-paren">(</span><em>value=None</em>, <em>key=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.Result" 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>Job result information for the configuration change carried out on NSX
|
||
Edge.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>value</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>) – Job Result value associated with key ID.</li>
|
||
<li><strong>key</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>) – Job Result key ID.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.ScopeInfo">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">ScopeInfo</code><span class="sig-paren">(</span><em>object_type_name=None</em>, <em>id=None</em>, <em>name=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.ScopeInfo" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>object_type_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>) – </li>
|
||
<li><strong>id</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>) – </li>
|
||
<li><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>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.Sddc">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">Sddc</code><span class="sig-paren">(</span><em>updated=None</em>, <em>user_id=None</em>, <em>updated_by_user_id=None</em>, <em>created=None</em>, <em>version=None</em>, <em>updated_by_user_name=None</em>, <em>user_name=None</em>, <em>id=None</em>, <em>name=None</em>, <em>sddc_state=None</em>, <em>expiration_date=None</em>, <em>org_id=None</em>, <em>sddc_type=None</em>, <em>provider=None</em>, <em>account_link_state=None</em>, <em>sddc_access_state=None</em>, <em>resource_config=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.Sddc" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>updated</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – </li>
|
||
<li><strong>user_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User id that last updated this record</li>
|
||
<li><strong>updated_by_user_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User id that last updated this record</li>
|
||
<li><strong>created</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – </li>
|
||
<li><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Version of this entity format: int32</li>
|
||
<li><strong>updated_by_user_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>) – User name that last updated this record</li>
|
||
<li><strong>user_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User name that last updated this record</li>
|
||
<li><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Unique ID for this entity</li>
|
||
<li><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>) – name for SDDC</li>
|
||
<li><strong>sddc_state</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>) – <p>Possible values are:</p>
|
||
<ul>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.Sddc.SDDC_STATE_DEPLOYING" title="com.vmware.vmc.model_client.Sddc.SDDC_STATE_DEPLOYING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Sddc.SDDC_STATE_DEPLOYING</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.Sddc.SDDC_STATE_READY" title="com.vmware.vmc.model_client.Sddc.SDDC_STATE_READY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Sddc.SDDC_STATE_READY</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.Sddc.SDDC_STATE_DELETING" title="com.vmware.vmc.model_client.Sddc.SDDC_STATE_DELETING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Sddc.SDDC_STATE_DELETING</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.Sddc.SDDC_STATE_DELETION_FAILED" title="com.vmware.vmc.model_client.Sddc.SDDC_STATE_DELETION_FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Sddc.SDDC_STATE_DELETION_FAILED</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.Sddc.SDDC_STATE_DELETED" title="com.vmware.vmc.model_client.Sddc.SDDC_STATE_DELETED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Sddc.SDDC_STATE_DELETED</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.Sddc.SDDC_STATE_FAILED" title="com.vmware.vmc.model_client.Sddc.SDDC_STATE_FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Sddc.SDDC_STATE_FAILED</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>expiration_date</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>) – Expiration date of a sddc in UTC (will be set if its applicable)
|
||
format: date-time</li>
|
||
<li><strong>org_id</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>) – </li>
|
||
<li><strong>sddc_type</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>) – Type of the sddc</li>
|
||
<li><strong>provider</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>) – <p>Possible values are:</p>
|
||
<ul>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.Sddc.PROVIDER_AWS" title="com.vmware.vmc.model_client.Sddc.PROVIDER_AWS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Sddc.PROVIDER_AWS</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>account_link_state</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>) – <p>Possible values are:</p>
|
||
<ul>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.Sddc.ACCOUNT_LINK_STATE_DELAYED" title="com.vmware.vmc.model_client.Sddc.ACCOUNT_LINK_STATE_DELAYED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Sddc.ACCOUNT_LINK_STATE_DELAYED</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.Sddc.ACCOUNT_LINK_STATE_LINKED" title="com.vmware.vmc.model_client.Sddc.ACCOUNT_LINK_STATE_LINKED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Sddc.ACCOUNT_LINK_STATE_LINKED</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.Sddc.ACCOUNT_LINK_STATE_UNLINKED" title="com.vmware.vmc.model_client.Sddc.ACCOUNT_LINK_STATE_UNLINKED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Sddc.ACCOUNT_LINK_STATE_UNLINKED</span></code></a></li>
|
||
</ul>
|
||
<blockquote>
|
||
<div>Account linking state of the sddc</div></blockquote>
|
||
</li>
|
||
<li><strong>sddc_access_state</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>) – Describes the access state of sddc, valid state is DISABLED or
|
||
ENABLED</li>
|
||
<li><strong>resource_config</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.AwsSddcResourceConfig" title="com.vmware.vmc.model_client.AwsSddcResourceConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">AwsSddcResourceConfig</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.Sddc.ACCOUNT_LINK_STATE_DELAYED">
|
||
<code class="descname">ACCOUNT_LINK_STATE_DELAYED</code><em class="property"> = 'DELAYED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Sddc.ACCOUNT_LINK_STATE_DELAYED" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.Sddc.ACCOUNT_LINK_STATE_LINKED">
|
||
<code class="descname">ACCOUNT_LINK_STATE_LINKED</code><em class="property"> = 'LINKED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Sddc.ACCOUNT_LINK_STATE_LINKED" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.Sddc.ACCOUNT_LINK_STATE_UNLINKED">
|
||
<code class="descname">ACCOUNT_LINK_STATE_UNLINKED</code><em class="property"> = 'UNLINKED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Sddc.ACCOUNT_LINK_STATE_UNLINKED" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.Sddc.PROVIDER_AWS">
|
||
<code class="descname">PROVIDER_AWS</code><em class="property"> = 'AWS'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Sddc.PROVIDER_AWS" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.Sddc.SDDC_STATE_DELETED">
|
||
<code class="descname">SDDC_STATE_DELETED</code><em class="property"> = 'DELETED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Sddc.SDDC_STATE_DELETED" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.Sddc.SDDC_STATE_DELETING">
|
||
<code class="descname">SDDC_STATE_DELETING</code><em class="property"> = 'DELETING'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Sddc.SDDC_STATE_DELETING" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.Sddc.SDDC_STATE_DELETION_FAILED">
|
||
<code class="descname">SDDC_STATE_DELETION_FAILED</code><em class="property"> = 'DELETION_FAILED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Sddc.SDDC_STATE_DELETION_FAILED" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.Sddc.SDDC_STATE_DEPLOYING">
|
||
<code class="descname">SDDC_STATE_DEPLOYING</code><em class="property"> = 'DEPLOYING'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Sddc.SDDC_STATE_DEPLOYING" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.Sddc.SDDC_STATE_FAILED">
|
||
<code class="descname">SDDC_STATE_FAILED</code><em class="property"> = 'FAILED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Sddc.SDDC_STATE_FAILED" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.Sddc.SDDC_STATE_READY">
|
||
<code class="descname">SDDC_STATE_READY</code><em class="property"> = 'READY'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Sddc.SDDC_STATE_READY" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.SddcAllocatePublicIpSpec">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">SddcAllocatePublicIpSpec</code><span class="sig-paren">(</span><em>count=None</em>, <em>private_ips=None</em>, <em>names=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.SddcAllocatePublicIpSpec" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – </li>
|
||
<li><strong>private_ips</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 workload VM private IPs to be assigned the public IP just
|
||
allocated.</li>
|
||
<li><strong>names</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of names for the workload VM public IP assignment.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.SddcConfig">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">SddcConfig</code><span class="sig-paren">(</span><em>storage_capacity=None</em>, <em>name=None</em>, <em>account_link_sddc_config=None</em>, <em>vpc_cidr=None</em>, <em>num_hosts=None</em>, <em>sddc_type=None</em>, <em>vxlan_subnet=None</em>, <em>account_link_config=None</em>, <em>provider='SddcConfig'</em>, <em>skip_creating_vxlan=None</em>, <em>sso_domain=None</em>, <em>sddc_template_id=None</em>, <em>deployment_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.SddcConfig" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>storage_capacity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The storage capacity value to be requested for the sddc primary
|
||
cluster, in GiBs. If provided, instead of using the direct-attached
|
||
storage, a capacity value amount of seperable storage will be used.
|
||
format: int64</li>
|
||
<li><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </li>
|
||
<li><strong>account_link_sddc_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.AccountLinkSddcConfig" title="com.vmware.vmc.model_client.AccountLinkSddcConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">AccountLinkSddcConfig</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – A list of the SDDC linking configurations to use.</li>
|
||
<li><strong>vpc_cidr</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>) – AWS VPC IP range. Only prefix of 16 or 20 is currently supported.</li>
|
||
<li><strong>num_hosts</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – </li>
|
||
<li><strong>sddc_type</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>) – Denotes the sddc type , if the value is null or empty, the type is
|
||
considered as default.</li>
|
||
<li><strong>vxlan_subnet</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>) – VXLAN IP subnet in CIDR for compute gateway</li>
|
||
<li><strong>account_link_config</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.AccountLinkConfig" title="com.vmware.vmc.model_client.AccountLinkConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">AccountLinkConfig</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The account linking configuration, we will keep this one and remove
|
||
accountLinkSddcConfig finally.</li>
|
||
<li><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>Possible values are:</p>
|
||
<ul>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.SddcConfig.PROVIDER_AWS" title="com.vmware.vmc.model_client.SddcConfig.PROVIDER_AWS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SddcConfig.PROVIDER_AWS</span></code></a></li>
|
||
</ul>
|
||
<p>Determines what additional properties are available based on cloud
|
||
provider.</p>
|
||
</li>
|
||
<li><strong>skip_creating_vxlan</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>) – skip creating vxlan for compute gateway for SDDC provisioning</li>
|
||
<li><strong>sso_domain</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 SSO domain name to use for vSphere users. If not specified,
|
||
vmc.local will be used.</li>
|
||
<li><strong>sddc_template_id</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>) – If provided, configuration from the template will applied to the
|
||
provisioned SDDC. format: UUID</li>
|
||
<li><strong>deployment_type</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>) – <p>Possible values are:</p>
|
||
<ul>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.SddcConfig.DEPLOYMENT_TYPE_SINGLEAZ" title="com.vmware.vmc.model_client.SddcConfig.DEPLOYMENT_TYPE_SINGLEAZ"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SddcConfig.DEPLOYMENT_TYPE_SINGLEAZ</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.SddcConfig.DEPLOYMENT_TYPE_MULTIAZ" title="com.vmware.vmc.model_client.SddcConfig.DEPLOYMENT_TYPE_MULTIAZ"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SddcConfig.DEPLOYMENT_TYPE_MULTIAZ</span></code></a></li>
|
||
</ul>
|
||
<p>Denotes if request is for a SingleAZ or a MultiAZ SDDC. Default is
|
||
SingleAZ.</p>
|
||
</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.SddcConfig.DEPLOYMENT_TYPE_MULTIAZ">
|
||
<code class="descname">DEPLOYMENT_TYPE_MULTIAZ</code><em class="property"> = 'MultiAZ'</em><a class="headerlink" href="#com.vmware.vmc.model_client.SddcConfig.DEPLOYMENT_TYPE_MULTIAZ" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.SddcConfig.DEPLOYMENT_TYPE_SINGLEAZ">
|
||
<code class="descname">DEPLOYMENT_TYPE_SINGLEAZ</code><em class="property"> = 'SingleAZ'</em><a class="headerlink" href="#com.vmware.vmc.model_client.SddcConfig.DEPLOYMENT_TYPE_SINGLEAZ" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.SddcConfig.PROVIDER_AWS">
|
||
<code class="descname">PROVIDER_AWS</code><em class="property"> = 'AWS'</em><a class="headerlink" href="#com.vmware.vmc.model_client.SddcConfig.PROVIDER_AWS" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.SddcId">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">SddcId</code><span class="sig-paren">(</span><em>sddc_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.SddcId" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>sddc_id</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>) – Sddc ID</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.SddcLinkConfig">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">SddcLinkConfig</code><span class="sig-paren">(</span><em>customer_subnet_ids=None</em>, <em>connected_account_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.SddcLinkConfig" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>customer_subnet_ids</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>connected_account_id</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>) – Determines which connected customer account to link to</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.SddcManifest">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">SddcManifest</code><span class="sig-paren">(</span><em>vmc_version=None</em>, <em>glcm_bundle=None</em>, <em>pop_info=None</em>, <em>vmc_internal_version=None</em>, <em>esx_ami=None</em>, <em>esx_nsxt_ami=None</em>, <em>metadata=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.SddcManifest" 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>Describes software components of the installed SDDC</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>vmc_version</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 vmcVersion of the sddc for display</li>
|
||
<li><strong>glcm_bundle</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.GlcmBundle" title="com.vmware.vmc.model_client.GlcmBundle"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlcmBundle</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>pop_info</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.PopInfo" title="com.vmware.vmc.model_client.PopInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">PopInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vmc_internal_version</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 vmcInternalVersion of the sddc for internal use</li>
|
||
<li><strong>esx_ami</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.AmiInfo" title="com.vmware.vmc.model_client.AmiInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">AmiInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>esx_nsxt_ami</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.AmiInfo" title="com.vmware.vmc.model_client.AmiInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">AmiInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>metadata</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.Metadata" title="com.vmware.vmc.model_client.Metadata"><code class="xref py py-class docutils literal notranslate"><span class="pre">Metadata</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.SddcNetwork">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">SddcNetwork</code><span class="sig-paren">(</span><em>subnets=None</em>, <em>cgw_name=None</em>, <em>name=None</em>, <em>l2_extension=None</em>, <em>cgw_id=None</em>, <em>dhcp_configs=None</em>, <em>id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.SddcNetwork" 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>Logical network.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>subnets</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.SddcNetworkAddressGroups" title="com.vmware.vmc.model_client.SddcNetworkAddressGroups"><code class="xref py py-class docutils literal notranslate"><span class="pre">SddcNetworkAddressGroups</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Network address groups for routed logical networks.</li>
|
||
<li><strong>cgw_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>) – Name of the compute gateway to which the logical network is
|
||
attached.</li>
|
||
<li><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of logical network. Length needs to be between 1-35
|
||
characters.</li>
|
||
<li><strong>l2_extension</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.L2Extension" title="com.vmware.vmc.model_client.L2Extension"><code class="xref py py-class docutils literal notranslate"><span class="pre">L2Extension</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Layer 2 extension for extended logical networks.</li>
|
||
<li><strong>cgw_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – ID of the compute gateway edge to which the logical network is
|
||
attached.</li>
|
||
<li><strong>dhcp_configs</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.SddcNetworkDhcpConfig" title="com.vmware.vmc.model_client.SddcNetworkDhcpConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">SddcNetworkDhcpConfig</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – DHCP configuration for routed logical networks.</li>
|
||
<li><strong>id</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>) – ID of logical network.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.SddcNetworkAddressGroup">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">SddcNetworkAddressGroup</code><span class="sig-paren">(</span><em>prefix_length=None</em>, <em>primary_address=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.SddcNetworkAddressGroup" 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>Logical Network address group.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>prefix_length</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>) – Prefix length of logical network.</li>
|
||
<li><strong>primary_address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Primary address for logical network.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.SddcNetworkAddressGroups">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">SddcNetworkAddressGroups</code><span class="sig-paren">(</span><em>address_groups=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.SddcNetworkAddressGroups" 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>Logical network address groups.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>address_groups</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.SddcNetworkAddressGroup" title="com.vmware.vmc.model_client.SddcNetworkAddressGroup"><code class="xref py py-class docutils literal notranslate"><span class="pre">SddcNetworkAddressGroup</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of logical network address groups.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.SddcNetworkDhcpConfig">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">SddcNetworkDhcpConfig</code><span class="sig-paren">(</span><em>ip_pools=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.SddcNetworkDhcpConfig" 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>DHCP configuration for the logical network.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>ip_pools</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.SddcNetworkDhcpIpPool" title="com.vmware.vmc.model_client.SddcNetworkDhcpIpPool"><code class="xref py py-class docutils literal notranslate"><span class="pre">SddcNetworkDhcpIpPool</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of IP pools in DHCP configuration.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.SddcNetworkDhcpIpPool">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">SddcNetworkDhcpIpPool</code><span class="sig-paren">(</span><em>ip_range=None</em>, <em>domain_name=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.SddcNetworkDhcpIpPool" 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>DHCP IP pool for logical network.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>ip_range</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>) – IP range for DHCP IP pool.</li>
|
||
<li><strong>domain_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>) – DNS domain name.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.SddcPublicIp">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">SddcPublicIp</code><span class="sig-paren">(</span><em>public_ip=None</em>, <em>name=None</em>, <em>allocation_id=None</em>, <em>dnat_rule_id=None</em>, <em>associated_private_ip=None</em>, <em>snat_rule_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.SddcPublicIp" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>public_ip</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </li>
|
||
<li><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>) – </li>
|
||
<li><strong>allocation_id</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>) – </li>
|
||
<li><strong>dnat_rule_id</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>) – </li>
|
||
<li><strong>associated_private_ip</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>) – </li>
|
||
<li><strong>snat_rule_id</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>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.SddcResourceConfig">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">SddcResourceConfig</code><span class="sig-paren">(</span><em>mgmt_appliance_network_name=None</em>, <em>nsxt=None</em>, <em>mgw_id=None</em>, <em>nsx_mgr_url=None</em>, <em>psc_management_ip=None</em>, <em>psc_url=None</em>, <em>cgws=None</em>, <em>availability_zones=None</em>, <em>management_ds=None</em>, <em>nsx_api_public_endpoint_url=None</em>, <em>custom_properties=None</em>, <em>cloud_password=None</em>, <em>provider='SddcResourceConfig'</em>, <em>clusters=None</em>, <em>vc_management_ip=None</em>, <em>sddc_networks=None</em>, <em>cloud_username=None</em>, <em>esx_hosts=None</em>, <em>nsx_mgr_management_ip=None</em>, <em>vc_instance_id=None</em>, <em>esx_cluster_id=None</em>, <em>vc_public_ip=None</em>, <em>skip_creating_vxlan=None</em>, <em>vc_url=None</em>, <em>sddc_manifest=None</em>, <em>vxlan_subnet=None</em>, <em>cloud_user_group=None</em>, <em>management_rp=None</em>, <em>witness_availability_zone=None</em>, <em>esx_host_subnet=None</em>, <em>sso_domain=None</em>, <em>deployment_type=None</em>, <em>dns_with_management_vm_private_ip=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.SddcResourceConfig" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>mgmt_appliance_network_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>) – Name for management appliance network.</li>
|
||
<li><strong>nsxt</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>) – if true, NSX-T UI is enabled.</li>
|
||
<li><strong>mgw_id</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>) – Management Gateway Id</li>
|
||
<li><strong>nsx_mgr_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>) – URL of the NSX Manager</li>
|
||
<li><strong>psc_management_ip</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>) – PSC internal management IP</li>
|
||
<li><strong>psc_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>) – URL of the PSC server</li>
|
||
<li><strong>cgws</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>) – </li>
|
||
<li><strong>availability_zones</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>) – Availability zones over which esx hosts are provisioned. MultiAZ
|
||
SDDCs will have hosts provisioned over two availability zones while
|
||
SingleAZ SDDCs will provision over one.</li>
|
||
<li><strong>management_ds</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 ManagedObjectReference of the management Datastore</li>
|
||
<li><strong>nsx_api_public_endpoint_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>) – nsx api entire base url</li>
|
||
<li><strong>custom_properties</strong> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>cloud_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 vCenter SDDC administrator</li>
|
||
<li><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>Possible values are:</p>
|
||
<ul>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.SddcResourceConfig.PROVIDER_AWS" title="com.vmware.vmc.model_client.SddcResourceConfig.PROVIDER_AWS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SddcResourceConfig.PROVIDER_AWS</span></code></a></li>
|
||
</ul>
|
||
<blockquote>
|
||
<div>Discriminator for additional properties</div></blockquote>
|
||
</li>
|
||
<li><strong>clusters</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">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of clusters in the SDDC.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must contain all the attributes defined in
|
||
<a class="reference internal" href="#com.vmware.vmc.model_client.Cluster" title="com.vmware.vmc.model_client.Cluster"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster</span></code></a>. When methods return a value of this class as a
|
||
return value, the attribute will contain all the attributes defined
|
||
in <a class="reference internal" href="#com.vmware.vmc.model_client.Cluster" title="com.vmware.vmc.model_client.Cluster"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster</span></code></a>.</li>
|
||
<li><strong>vc_management_ip</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>) – vCenter internal management IP</li>
|
||
<li><strong>sddc_networks</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>) – </li>
|
||
<li><strong>cloud_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 vCenter SDDC administrator</li>
|
||
<li><strong>esx_hosts</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.AwsEsxHost" title="com.vmware.vmc.model_client.AwsEsxHost"><code class="xref py py-class docutils literal notranslate"><span class="pre">AwsEsxHost</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>nsx_mgr_management_ip</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>) – NSX Manager internal management IP</li>
|
||
<li><strong>vc_instance_id</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>) – unique id of the vCenter server</li>
|
||
<li><strong>esx_cluster_id</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>) – Cluster Id to add ESX workflow</li>
|
||
<li><strong>vc_public_ip</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>) – vCenter public IP</li>
|
||
<li><strong>skip_creating_vxlan</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>) – skip creating vxlan for compute gateway for SDDC provisioning</li>
|
||
<li><strong>vc_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>) – URL of the vCenter server</li>
|
||
<li><strong>sddc_manifest</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.SddcManifest" title="com.vmware.vmc.model_client.SddcManifest"><code class="xref py py-class docutils literal notranslate"><span class="pre">SddcManifest</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>vxlan_subnet</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>) – VXLAN IP subnet</li>
|
||
<li><strong>cloud_user_group</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>) – Group name for vCenter SDDC administrator</li>
|
||
<li><strong>management_rp</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>) – </li>
|
||
<li><strong>witness_availability_zone</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>) – Availability zone where the witness node is provisioned for a
|
||
MultiAZ SDDC. This is null for a SingleAZ SDDC.</li>
|
||
<li><strong>esx_host_subnet</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>) – ESX host subnet</li>
|
||
<li><strong>sso_domain</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 SSO domain name to use for vSphere users</li>
|
||
<li><strong>deployment_type</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>) – <p>Possible values are:</p>
|
||
<ul>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.SddcResourceConfig.DEPLOYMENT_TYPE_SINGLE_AZ" title="com.vmware.vmc.model_client.SddcResourceConfig.DEPLOYMENT_TYPE_SINGLE_AZ"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SddcResourceConfig.DEPLOYMENT_TYPE_SINGLE_AZ</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.SddcResourceConfig.DEPLOYMENT_TYPE_MULTI_AZ" title="com.vmware.vmc.model_client.SddcResourceConfig.DEPLOYMENT_TYPE_MULTI_AZ"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SddcResourceConfig.DEPLOYMENT_TYPE_MULTI_AZ</span></code></a></li>
|
||
</ul>
|
||
<blockquote>
|
||
<div>Denotes if this is a SingleAZ SDDC or a MultiAZ SDDC.</div></blockquote>
|
||
</li>
|
||
<li><strong>dns_with_management_vm_private_ip</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>) – if true, use the private IP addresses to register DNS records for
|
||
the management VMs</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.SddcResourceConfig.DEPLOYMENT_TYPE_MULTI_AZ">
|
||
<code class="descname">DEPLOYMENT_TYPE_MULTI_AZ</code><em class="property"> = 'MULTI_AZ'</em><a class="headerlink" href="#com.vmware.vmc.model_client.SddcResourceConfig.DEPLOYMENT_TYPE_MULTI_AZ" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.SddcResourceConfig.DEPLOYMENT_TYPE_SINGLE_AZ">
|
||
<code class="descname">DEPLOYMENT_TYPE_SINGLE_AZ</code><em class="property"> = 'SINGLE_AZ'</em><a class="headerlink" href="#com.vmware.vmc.model_client.SddcResourceConfig.DEPLOYMENT_TYPE_SINGLE_AZ" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.SddcResourceConfig.PROVIDER_AWS">
|
||
<code class="descname">PROVIDER_AWS</code><em class="property"> = 'AWS'</em><a class="headerlink" href="#com.vmware.vmc.model_client.SddcResourceConfig.PROVIDER_AWS" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.SddcStateRequest">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">SddcStateRequest</code><span class="sig-paren">(</span><em>sddcs=None</em>, <em>states=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.SddcStateRequest" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>sddcs</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>) – </li>
|
||
<li><strong>states</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>) – <p>Possible values are:</p>
|
||
<ul>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.SddcStateRequest.STATES_SCHEDULED" title="com.vmware.vmc.model_client.SddcStateRequest.STATES_SCHEDULED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SddcStateRequest.STATES_SCHEDULED</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.SddcStateRequest.STATES_RUNNING" title="com.vmware.vmc.model_client.SddcStateRequest.STATES_RUNNING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SddcStateRequest.STATES_RUNNING</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.SddcStateRequest.STATES_CANCELED" title="com.vmware.vmc.model_client.SddcStateRequest.STATES_CANCELED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SddcStateRequest.STATES_CANCELED</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.SddcStateRequest.STATES_COMPLETED" title="com.vmware.vmc.model_client.SddcStateRequest.STATES_COMPLETED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SddcStateRequest.STATES_COMPLETED</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.SddcStateRequest.STATES_CANCELED">
|
||
<code class="descname">STATES_CANCELED</code><em class="property"> = 'CANCELED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.SddcStateRequest.STATES_CANCELED" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.SddcStateRequest.STATES_COMPLETED">
|
||
<code class="descname">STATES_COMPLETED</code><em class="property"> = 'COMPLETED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.SddcStateRequest.STATES_COMPLETED" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.SddcStateRequest.STATES_RUNNING">
|
||
<code class="descname">STATES_RUNNING</code><em class="property"> = 'RUNNING'</em><a class="headerlink" href="#com.vmware.vmc.model_client.SddcStateRequest.STATES_RUNNING" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.SddcStateRequest.STATES_SCHEDULED">
|
||
<code class="descname">STATES_SCHEDULED</code><em class="property"> = 'SCHEDULED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.SddcStateRequest.STATES_SCHEDULED" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.SddcTemplate">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">SddcTemplate</code><span class="sig-paren">(</span><em>updated=None</em>, <em>user_id=None</em>, <em>updated_by_user_id=None</em>, <em>created=None</em>, <em>version=None</em>, <em>updated_by_user_name=None</em>, <em>user_name=None</em>, <em>id=None</em>, <em>account_link_sddc_configs=None</em>, <em>state=None</em>, <em>network_template=None</em>, <em>name=None</em>, <em>source_sddc_id=None</em>, <em>org_id=None</em>, <em>sddc=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.SddcTemplate" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>updated</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – </li>
|
||
<li><strong>user_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User id that last updated this record</li>
|
||
<li><strong>updated_by_user_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User id that last updated this record</li>
|
||
<li><strong>created</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – </li>
|
||
<li><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Version of this entity format: int32</li>
|
||
<li><strong>updated_by_user_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>) – User name that last updated this record</li>
|
||
<li><strong>user_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User name that last updated this record</li>
|
||
<li><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Unique ID for this entity</li>
|
||
<li><strong>account_link_sddc_configs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.AccountLinkSddcConfig" title="com.vmware.vmc.model_client.AccountLinkSddcConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">AccountLinkSddcConfig</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – A list of the SDDC linking configurations to use.</li>
|
||
<li><strong>state</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>) – <p>Possible values are:</p>
|
||
<ul>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.SddcTemplate.STATE_INITIALIZING" title="com.vmware.vmc.model_client.SddcTemplate.STATE_INITIALIZING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SddcTemplate.STATE_INITIALIZING</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.SddcTemplate.STATE_AVAILABLE" title="com.vmware.vmc.model_client.SddcTemplate.STATE_AVAILABLE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SddcTemplate.STATE_AVAILABLE</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.SddcTemplate.STATE_INUSE" title="com.vmware.vmc.model_client.SddcTemplate.STATE_INUSE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SddcTemplate.STATE_INUSE</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.SddcTemplate.STATE_APPLIED" title="com.vmware.vmc.model_client.SddcTemplate.STATE_APPLIED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SddcTemplate.STATE_APPLIED</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.SddcTemplate.STATE_DELETING" title="com.vmware.vmc.model_client.SddcTemplate.STATE_DELETING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SddcTemplate.STATE_DELETING</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.SddcTemplate.STATE_DELETED" title="com.vmware.vmc.model_client.SddcTemplate.STATE_DELETED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SddcTemplate.STATE_DELETED</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.SddcTemplate.STATE_FAILED" title="com.vmware.vmc.model_client.SddcTemplate.STATE_FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SddcTemplate.STATE_FAILED</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>network_template</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.NetworkTemplate" title="com.vmware.vmc.model_client.NetworkTemplate"><code class="xref py py-class docutils literal notranslate"><span class="pre">NetworkTemplate</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><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>) – name for SDDC configuration template</li>
|
||
<li><strong>source_sddc_id</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>) – </li>
|
||
<li><strong>org_id</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>) – </li>
|
||
<li><strong>sddc</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.Sddc" title="com.vmware.vmc.model_client.Sddc"><code class="xref py py-class docutils literal notranslate"><span class="pre">Sddc</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.SddcTemplate.STATE_APPLIED">
|
||
<code class="descname">STATE_APPLIED</code><em class="property"> = 'APPLIED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.SddcTemplate.STATE_APPLIED" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.SddcTemplate.STATE_AVAILABLE">
|
||
<code class="descname">STATE_AVAILABLE</code><em class="property"> = 'AVAILABLE'</em><a class="headerlink" href="#com.vmware.vmc.model_client.SddcTemplate.STATE_AVAILABLE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.SddcTemplate.STATE_DELETED">
|
||
<code class="descname">STATE_DELETED</code><em class="property"> = 'DELETED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.SddcTemplate.STATE_DELETED" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.SddcTemplate.STATE_DELETING">
|
||
<code class="descname">STATE_DELETING</code><em class="property"> = 'DELETING'</em><a class="headerlink" href="#com.vmware.vmc.model_client.SddcTemplate.STATE_DELETING" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.SddcTemplate.STATE_FAILED">
|
||
<code class="descname">STATE_FAILED</code><em class="property"> = 'FAILED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.SddcTemplate.STATE_FAILED" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.SddcTemplate.STATE_INITIALIZING">
|
||
<code class="descname">STATE_INITIALIZING</code><em class="property"> = 'INITIALIZING'</em><a class="headerlink" href="#com.vmware.vmc.model_client.SddcTemplate.STATE_INITIALIZING" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.SddcTemplate.STATE_INUSE">
|
||
<code class="descname">STATE_INUSE</code><em class="property"> = 'INUSE'</em><a class="headerlink" href="#com.vmware.vmc.model_client.SddcTemplate.STATE_INUSE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.SecondaryAddresses">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">SecondaryAddresses</code><span class="sig-paren">(</span><em>type=None</em>, <em>ip_address=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.SecondaryAddresses" 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>Secondary IP addresses of the NSX Edge vnic address group. These are used
|
||
for NAT, LB, VPN etc. Optional.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>type</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>) – </li>
|
||
<li><strong>ip_address</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 IP addresses.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.ServiceError">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">ServiceError</code><span class="sig-paren">(</span><em>default_message=None</em>, <em>original_service=None</em>, <em>localized_message=None</em>, <em>original_service_error_code=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.ServiceError" 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>Detailed service errors associated with a task.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>default_message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Error message in English.</li>
|
||
<li><strong>original_service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The original service name of the error.</li>
|
||
<li><strong>localized_message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The localized message.</li>
|
||
<li><strong>original_service_error_code</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The original error code of the service.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.Site">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">Site</code><span class="sig-paren">(</span><em>password=None</em>, <em>user_id=None</em>, <em>name=None</em>, <em>rx_bytes_on_local_subnet=None</em>, <em>secure_traffic=None</em>, <em>established_date=None</em>, <em>failure_message=None</em>, <em>dropped_tx_packets=None</em>, <em>dropped_rx_packets=None</em>, <em>tunnel_status=None</em>, <em>tx_bytes_from_local_subnet=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.Site" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>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>) – Site password.</li>
|
||
<li><strong>user_id</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>) – Site user id.</li>
|
||
<li><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>) – Unique name for the site getting configured.</li>
|
||
<li><strong>rx_bytes_on_local_subnet</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>) – Bytes received on local network. format: int64
|
||
This attribute may be present in responses from the server, but if
|
||
it is present in a request to server it will be ignored.</li>
|
||
<li><strong>secure_traffic</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/disable encription.</li>
|
||
<li><strong>established_date</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>) – Date tunnel was established.
|
||
This attribute may be present in responses from the server, but if
|
||
it is present in a request to server it will be ignored.</li>
|
||
<li><strong>failure_message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – failure message.
|
||
This attribute may be present in responses from the server, but if
|
||
it is present in a request to server it will be ignored.</li>
|
||
<li><strong>dropped_tx_packets</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>) – Number of transmitted packets dropped.
|
||
This attribute may be present in responses from the server, but if
|
||
it is present in a request to server it will be ignored.</li>
|
||
<li><strong>dropped_rx_packets</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>) – Number of received packets dropped.
|
||
This attribute may be present in responses from the server, but if
|
||
it is present in a request to server it will be ignored.</li>
|
||
<li><strong>tunnel_status</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>) – <p>Possible values are:</p>
|
||
<ul>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.Site.TUNNEL_STATUS_CONNECTED" title="com.vmware.vmc.model_client.Site.TUNNEL_STATUS_CONNECTED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Site.TUNNEL_STATUS_CONNECTED</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.Site.TUNNEL_STATUS_DISCONNECTED" title="com.vmware.vmc.model_client.Site.TUNNEL_STATUS_DISCONNECTED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Site.TUNNEL_STATUS_DISCONNECTED</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.Site.TUNNEL_STATUS_UNKNOWN" title="com.vmware.vmc.model_client.Site.TUNNEL_STATUS_UNKNOWN"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Site.TUNNEL_STATUS_UNKNOWN</span></code></a></li>
|
||
</ul>
|
||
<blockquote>
|
||
<div>Site tunnel status.</div></blockquote>
|
||
<p>This attribute may be present in responses from the server, but if
|
||
it is present in a request to server it will be ignored.</p>
|
||
</li>
|
||
<li><strong>tx_bytes_from_local_subnet</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>) – Bytes transmitted from local subnet. format: int64
|
||
This attribute may be present in responses from the server, but if
|
||
it is present in a request to server it will be ignored.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.Site.TUNNEL_STATUS_CONNECTED">
|
||
<code class="descname">TUNNEL_STATUS_CONNECTED</code><em class="property"> = 'CONNECTED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Site.TUNNEL_STATUS_CONNECTED" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.Site.TUNNEL_STATUS_DISCONNECTED">
|
||
<code class="descname">TUNNEL_STATUS_DISCONNECTED</code><em class="property"> = 'DISCONNECTED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Site.TUNNEL_STATUS_DISCONNECTED" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.Site.TUNNEL_STATUS_UNKNOWN">
|
||
<code class="descname">TUNNEL_STATUS_UNKNOWN</code><em class="property"> = 'UNKNOWN'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Site.TUNNEL_STATUS_UNKNOWN" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.Sites">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">Sites</code><span class="sig-paren">(</span><em>sites=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.Sites" 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>L2 VPN sites.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>sites</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.Nsxsite" title="com.vmware.vmc.model_client.Nsxsite"><code class="xref py py-class docutils literal notranslate"><span class="pre">Nsxsite</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.SslvpnDashboardStats">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">SslvpnDashboardStats</code><span class="sig-paren">(</span><em>active_clients=None</em>, <em>sslvpn_bytes_in=None</em>, <em>auth_failures=None</em>, <em>sessions_created=None</em>, <em>sslvpn_bytes_out=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.SslvpnDashboardStats" 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>Dashboard Statistics data for SSL VPN.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>active_clients</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Number of active clients.</li>
|
||
<li><strong>sslvpn_bytes_in</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Rx bytes received for SSL VPN.</li>
|
||
<li><strong>auth_failures</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Number of authentication failures.</li>
|
||
<li><strong>sessions_created</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Number of SSL VPN sessions created.</li>
|
||
<li><strong>sslvpn_bytes_out</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.DashboardStat" title="com.vmware.vmc.model_client.DashboardStat"><code class="xref py py-class docutils literal notranslate"><span class="pre">DashboardStat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Tx bytes transmitted for SSL VPN.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.StubFactory">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_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>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>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</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.SubInterface">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">SubInterface</code><span class="sig-paren">(</span><em>index=None</em>, <em>tunnel_id=None</em>, <em>name=None</em>, <em>address_groups=None</em>, <em>vlan_id=None</em>, <em>label=None</em>, <em>logical_switch_name=None</em>, <em>is_connected=None</em>, <em>mtu=None</em>, <em>logical_switch_id=None</em>, <em>enable_send_redirects=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.SubInterface" 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>NSX Edge sub interface configuration details. Sub interfaces are created on
|
||
a trunk interface.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>index</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>) – Index of the sub interface assigned by NSX Manager. Min value is 10
|
||
and max value is 4103. format: int32</li>
|
||
<li><strong>tunnel_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Valid values for tunnel ID are min 1 to max 4093. Required. format:
|
||
int32</li>
|
||
<li><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>) – Name of the sub interface. Required.</li>
|
||
<li><strong>address_groups</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.EdgeVnicAddressGroups" title="com.vmware.vmc.model_client.EdgeVnicAddressGroups"><code class="xref py py-class docutils literal notranslate"><span class="pre">EdgeVnicAddressGroups</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Address group configuration of the sub interface.</li>
|
||
<li><strong>vlan_id</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>) – VLAN ID of the virtual LAN used by this sub interface. VLAN IDs can
|
||
range from 0 to 4094. format: int32</li>
|
||
<li><strong>label</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>) – Sub interface label of format vNic_{index} provided by NSX Manager.
|
||
Read only.</li>
|
||
<li><strong>logical_switch_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>) – Name of the logical switch connected to this sub interface.</li>
|
||
<li><strong>is_connected</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>) – Value is true if the sub interface is connected to a logical
|
||
switch, standard portgroup or distributed portgroup.</li>
|
||
<li><strong>mtu</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>) – MTU value of the sub interface. This value would be the least mtu
|
||
for all the trunk interfaces of the NSX Edge. Default is 1500.
|
||
format: int32</li>
|
||
<li><strong>logical_switch_id</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>) – ID of the logical switch connected to this sub interface.</li>
|
||
<li><strong>enable_send_redirects</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>) – Value is true if send redirects is enabled. Enable ICMP redirect to
|
||
convey routing information to hosts.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.SubInterfaces">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">SubInterfaces</code><span class="sig-paren">(</span><em>sub_interfaces=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.SubInterfaces" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>sub_interfaces</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.SubInterface" title="com.vmware.vmc.model_client.SubInterface"><code class="xref py py-class docutils literal notranslate"><span class="pre">SubInterface</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of sub interfaces.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.SubnetInfo">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">SubnetInfo</code><span class="sig-paren">(</span><em>compatible=None</em>, <em>connected_account_id=None</em>, <em>region_name=None</em>, <em>availability_zone=None</em>, <em>subnet_id=None</em>, <em>subnet_cidr_block=None</em>, <em>note=None</em>, <em>vpc_id=None</em>, <em>vpc_cidr_block=None</em>, <em>name=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.SubnetInfo" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>compatible</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Is this customer subnet compatible with the SDDC?</li>
|
||
<li><strong>connected_account_id</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 ID of the connected account this subnet is from.</li>
|
||
<li><strong>region_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 region this subnet is from.</li>
|
||
<li><strong>availability_zone</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 availability zone (customer-centric) this subnet is in.</li>
|
||
<li><strong>subnet_id</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 ID of the subnet.</li>
|
||
<li><strong>subnet_cidr_block</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 CIDR block of the subnet.</li>
|
||
<li><strong>note</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>) – Why a subnet is marked as not compatible. May be blank if
|
||
compatible.</li>
|
||
<li><strong>vpc_id</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 ID of the VPC this subnet resides in.</li>
|
||
<li><strong>vpc_cidr_block</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 CIDR block of the VPC containing this subnet.</li>
|
||
<li><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>) – The name of the subnet. This is either the tagged name or the
|
||
default AWS id it was given.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.Subnets">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">Subnets</code><span class="sig-paren">(</span><em>subnets=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.Subnets" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>subnets</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 subnets for which IPsec VPN is configured. Subnets should
|
||
be network address specified in CIDR format and can accept
|
||
‘0.0.0.0/0’ (any)</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.SubscriptionDetails">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">SubscriptionDetails</code><span class="sig-paren">(</span><em>status=None</em>, <em>anniversary_billing_date=None</em>, <em>end_date=None</em>, <em>auto_renewed_allowed=None</em>, <em>description=None</em>, <em>commitment_term=None</em>, <em>csp_subscription_id=None</em>, <em>billing_subscription_id=None</em>, <em>commitment_term_uom=None</em>, <em>offer_version=None</em>, <em>region=None</em>, <em>offer_name=None</em>, <em>offer_type=None</em>, <em>start_date=None</em>, <em>quantity=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.SubscriptionDetails" 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>details of a subscription</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>status</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>) – <p>Possible values are:</p>
|
||
<ul>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.SubscriptionDetails.STATUS_CREATED" title="com.vmware.vmc.model_client.SubscriptionDetails.STATUS_CREATED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SubscriptionDetails.STATUS_CREATED</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.SubscriptionDetails.STATUS_ACTIVATED" title="com.vmware.vmc.model_client.SubscriptionDetails.STATUS_ACTIVATED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SubscriptionDetails.STATUS_ACTIVATED</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.SubscriptionDetails.STATUS_FAILED" title="com.vmware.vmc.model_client.SubscriptionDetails.STATUS_FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SubscriptionDetails.STATUS_FAILED</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.SubscriptionDetails.STATUS_CANCELLED" title="com.vmware.vmc.model_client.SubscriptionDetails.STATUS_CANCELLED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SubscriptionDetails.STATUS_CANCELLED</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.SubscriptionDetails.STATUS_EXPIRED" title="com.vmware.vmc.model_client.SubscriptionDetails.STATUS_EXPIRED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SubscriptionDetails.STATUS_EXPIRED</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.SubscriptionDetails.STATUS_PENDING_PROVISIONING" title="com.vmware.vmc.model_client.SubscriptionDetails.STATUS_PENDING_PROVISIONING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SubscriptionDetails.STATUS_PENDING_PROVISIONING</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.SubscriptionDetails.STATUS_ORDER_SUBMITTED" title="com.vmware.vmc.model_client.SubscriptionDetails.STATUS_ORDER_SUBMITTED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SubscriptionDetails.STATUS_ORDER_SUBMITTED</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>anniversary_billing_date</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>) – </li>
|
||
<li><strong>end_date</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>) – </li>
|
||
<li><strong>auto_renewed_allowed</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>) – </li>
|
||
<li><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>commitment_term</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>) – </li>
|
||
<li><strong>csp_subscription_id</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>) – </li>
|
||
<li><strong>billing_subscription_id</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>) – </li>
|
||
<li><strong>commitment_term_uom</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>) – unit of measurment for commitment term</li>
|
||
<li><strong>offer_version</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>) – </li>
|
||
<li><strong>region</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>) – </li>
|
||
<li><strong>offer_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>) – </li>
|
||
<li><strong>offer_type</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.OfferType" title="com.vmware.vmc.model_client.OfferType"><code class="xref py py-class docutils literal notranslate"><span class="pre">OfferType</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>start_date</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>) – </li>
|
||
<li><strong>quantity</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>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.SubscriptionDetails.STATUS_ACTIVATED">
|
||
<code class="descname">STATUS_ACTIVATED</code><em class="property"> = 'ACTIVATED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.SubscriptionDetails.STATUS_ACTIVATED" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.SubscriptionDetails.STATUS_CANCELLED">
|
||
<code class="descname">STATUS_CANCELLED</code><em class="property"> = 'CANCELLED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.SubscriptionDetails.STATUS_CANCELLED" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.SubscriptionDetails.STATUS_CREATED">
|
||
<code class="descname">STATUS_CREATED</code><em class="property"> = 'CREATED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.SubscriptionDetails.STATUS_CREATED" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.SubscriptionDetails.STATUS_EXPIRED">
|
||
<code class="descname">STATUS_EXPIRED</code><em class="property"> = 'EXPIRED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.SubscriptionDetails.STATUS_EXPIRED" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.SubscriptionDetails.STATUS_FAILED">
|
||
<code class="descname">STATUS_FAILED</code><em class="property"> = 'FAILED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.SubscriptionDetails.STATUS_FAILED" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.SubscriptionDetails.STATUS_ORDER_SUBMITTED">
|
||
<code class="descname">STATUS_ORDER_SUBMITTED</code><em class="property"> = 'ORDER_SUBMITTED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.SubscriptionDetails.STATUS_ORDER_SUBMITTED" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.SubscriptionDetails.STATUS_PENDING_PROVISIONING">
|
||
<code class="descname">STATUS_PENDING_PROVISIONING</code><em class="property"> = 'PENDING_PROVISIONING'</em><a class="headerlink" href="#com.vmware.vmc.model_client.SubscriptionDetails.STATUS_PENDING_PROVISIONING" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.SubscriptionProducts">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">SubscriptionProducts</code><span class="sig-paren">(</span><em>product=None</em>, <em>types=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.SubscriptionProducts" 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>Details of products that are available for purchase.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>product</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 name of the product</li>
|
||
<li><strong>types</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>) – A list of different types/version for the product.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.SubscriptionRequest">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">SubscriptionRequest</code><span class="sig-paren">(</span><em>product=None</em>, <em>product_type=None</em>, <em>region=None</em>, <em>commitment_term=None</em>, <em>offer_name=None</em>, <em>type=None</em>, <em>offer_version=None</em>, <em>quantity=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.SubscriptionRequest" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>product</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 product for which subscription needs to be created. Refer
|
||
/vmc/api/orgs/{orgId}/products.</li>
|
||
<li><strong>product_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Old identifier for product. *Deprecarted*. See product and type</li>
|
||
<li><strong>region</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </li>
|
||
<li><strong>commitment_term</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </li>
|
||
<li><strong>offer_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </li>
|
||
<li><strong>type</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 type of the product for which the subscription needs to be
|
||
created.</li>
|
||
<li><strong>offer_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </li>
|
||
<li><strong>quantity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.SupportWindow">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">SupportWindow</code><span class="sig-paren">(</span><em>start_day=None</em>, <em>seats=None</em>, <em>sddcs=None</em>, <em>duration_hours=None</em>, <em>start_hour=None</em>, <em>support_window_id=None</em>, <em>metadata=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.SupportWindow" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>start_day</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>) – <p>Possible values are:</p>
|
||
<ul>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.SupportWindow.START_DAY_MONDAY" title="com.vmware.vmc.model_client.SupportWindow.START_DAY_MONDAY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SupportWindow.START_DAY_MONDAY</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.SupportWindow.START_DAY_TUESDAY" title="com.vmware.vmc.model_client.SupportWindow.START_DAY_TUESDAY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SupportWindow.START_DAY_TUESDAY</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.SupportWindow.START_DAY_WEDNESDAY" title="com.vmware.vmc.model_client.SupportWindow.START_DAY_WEDNESDAY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SupportWindow.START_DAY_WEDNESDAY</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.SupportWindow.START_DAY_THURSDAY" title="com.vmware.vmc.model_client.SupportWindow.START_DAY_THURSDAY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SupportWindow.START_DAY_THURSDAY</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.SupportWindow.START_DAY_FRIDAY" title="com.vmware.vmc.model_client.SupportWindow.START_DAY_FRIDAY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SupportWindow.START_DAY_FRIDAY</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.SupportWindow.START_DAY_SATURDAY" title="com.vmware.vmc.model_client.SupportWindow.START_DAY_SATURDAY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SupportWindow.START_DAY_SATURDAY</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.SupportWindow.START_DAY_SUNDAY" title="com.vmware.vmc.model_client.SupportWindow.START_DAY_SUNDAY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SupportWindow.START_DAY_SUNDAY</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>seats</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>) – </li>
|
||
<li><strong>sddcs</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>) – SDDCs in this window format: UUID</li>
|
||
<li><strong>duration_hours</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>) – </li>
|
||
<li><strong>start_hour</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>) – </li>
|
||
<li><strong>support_window_id</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>) – </li>
|
||
<li><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.SupportWindow.START_DAY_FRIDAY">
|
||
<code class="descname">START_DAY_FRIDAY</code><em class="property"> = 'FRIDAY'</em><a class="headerlink" href="#com.vmware.vmc.model_client.SupportWindow.START_DAY_FRIDAY" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.SupportWindow.START_DAY_MONDAY">
|
||
<code class="descname">START_DAY_MONDAY</code><em class="property"> = 'MONDAY'</em><a class="headerlink" href="#com.vmware.vmc.model_client.SupportWindow.START_DAY_MONDAY" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.SupportWindow.START_DAY_SATURDAY">
|
||
<code class="descname">START_DAY_SATURDAY</code><em class="property"> = 'SATURDAY'</em><a class="headerlink" href="#com.vmware.vmc.model_client.SupportWindow.START_DAY_SATURDAY" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.SupportWindow.START_DAY_SUNDAY">
|
||
<code class="descname">START_DAY_SUNDAY</code><em class="property"> = 'SUNDAY'</em><a class="headerlink" href="#com.vmware.vmc.model_client.SupportWindow.START_DAY_SUNDAY" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.SupportWindow.START_DAY_THURSDAY">
|
||
<code class="descname">START_DAY_THURSDAY</code><em class="property"> = 'THURSDAY'</em><a class="headerlink" href="#com.vmware.vmc.model_client.SupportWindow.START_DAY_THURSDAY" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.SupportWindow.START_DAY_TUESDAY">
|
||
<code class="descname">START_DAY_TUESDAY</code><em class="property"> = 'TUESDAY'</em><a class="headerlink" href="#com.vmware.vmc.model_client.SupportWindow.START_DAY_TUESDAY" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.SupportWindow.START_DAY_WEDNESDAY">
|
||
<code class="descname">START_DAY_WEDNESDAY</code><em class="property"> = 'WEDNESDAY'</em><a class="headerlink" href="#com.vmware.vmc.model_client.SupportWindow.START_DAY_WEDNESDAY" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.SupportWindowId">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">SupportWindowId</code><span class="sig-paren">(</span><em>window_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.SupportWindowId" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>window_id</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>) – Support Window ID</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.Task">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">Task</code><span class="sig-paren">(</span><em>updated=None</em>, <em>user_id=None</em>, <em>updated_by_user_id=None</em>, <em>created=None</em>, <em>version=None</em>, <em>updated_by_user_name=None</em>, <em>user_name=None</em>, <em>id=None</em>, <em>status=None</em>, <em>localized_error_message=None</em>, <em>resource_id=None</em>, <em>parent_task_id=None</em>, <em>task_version=None</em>, <em>correlation_id=None</em>, <em>start_resource_entity_version=None</em>, <em>sub_status=None</em>, <em>task_type=None</em>, <em>start_time=None</em>, <em>task_progress_phases=None</em>, <em>error_message=None</em>, <em>org_id=None</em>, <em>end_resource_entity_version=None</em>, <em>service_errors=None</em>, <em>org_type=None</em>, <em>estimated_remaining_minutes=None</em>, <em>params=None</em>, <em>progress_percent=None</em>, <em>phase_in_progress=None</em>, <em>resource_type=None</em>, <em>end_time=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.Task" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>updated</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – </li>
|
||
<li><strong>user_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User id that last updated this record</li>
|
||
<li><strong>updated_by_user_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User id that last updated this record</li>
|
||
<li><strong>created</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – </li>
|
||
<li><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Version of this entity format: int32</li>
|
||
<li><strong>updated_by_user_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>) – User name that last updated this record</li>
|
||
<li><strong>user_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User name that last updated this record</li>
|
||
<li><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Unique ID for this entity</li>
|
||
<li><strong>status</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>) – <p>Possible values are:</p>
|
||
<ul>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.Task.STATUS_STARTED" title="com.vmware.vmc.model_client.Task.STATUS_STARTED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Task.STATUS_STARTED</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.Task.STATUS_CANCELING" title="com.vmware.vmc.model_client.Task.STATUS_CANCELING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Task.STATUS_CANCELING</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.Task.STATUS_FINISHED" title="com.vmware.vmc.model_client.Task.STATUS_FINISHED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Task.STATUS_FINISHED</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.Task.STATUS_FAILED" title="com.vmware.vmc.model_client.Task.STATUS_FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Task.STATUS_FAILED</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.Task.STATUS_CANCELED" title="com.vmware.vmc.model_client.Task.STATUS_CANCELED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Task.STATUS_CANCELED</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>localized_error_message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>resource_id</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>) – UUID of the resource the task is acting upon</li>
|
||
<li><strong>parent_task_id</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>) – If this task was created by another task - this provides the
|
||
linkage. Mostly for debugging.</li>
|
||
<li><strong>task_version</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>) – </li>
|
||
<li><strong>correlation_id</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>) – (Optional) Client provided uniqifier to make task creation
|
||
idempotent. Be aware not all tasks support this. For tasks that do
|
||
- supplying the same correlation Id, for the same task type, within
|
||
a predefined window will ensure the operation happens at most once.</li>
|
||
<li><strong>start_resource_entity_version</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>) – Entity version of the resource at the start of the task. This is
|
||
only set for some task types. format: int32</li>
|
||
<li><strong>sub_status</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>) – </li>
|
||
<li><strong>task_type</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>) – </li>
|
||
<li><strong>start_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>task_progress_phases</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.TaskProgressPhase" title="com.vmware.vmc.model_client.TaskProgressPhase"><code class="xref py py-class docutils literal notranslate"><span class="pre">TaskProgressPhase</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Task progress phases involved in current task execution</li>
|
||
<li><strong>error_message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>org_id</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>) – </li>
|
||
<li><strong>end_resource_entity_version</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>) – Entity version of the resource at the end of the task. This is only
|
||
set for some task types. format: int32</li>
|
||
<li><strong>service_errors</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.ServiceError" title="com.vmware.vmc.model_client.ServiceError"><code class="xref py py-class docutils literal notranslate"><span class="pre">ServiceError</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Service errors returned from SDDC services.</li>
|
||
<li><strong>org_type</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>) – </li>
|
||
<li><strong>estimated_remaining_minutes</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>) – Estimated remaining time in minute of the task execution, < 0 means
|
||
no estimation for the task. format: int32</li>
|
||
<li><strong>params</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>progress_percent</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>) – Estimated progress percentage the task executed format: int32</li>
|
||
<li><strong>phase_in_progress</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 current in progress phase ID in the task execution, if none in
|
||
progress, empty string returned.</li>
|
||
<li><strong>resource_type</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>) – Type of resource being acted upon</li>
|
||
<li><strong>end_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.Task.STATUS_CANCELED">
|
||
<code class="descname">STATUS_CANCELED</code><em class="property"> = 'CANCELED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Task.STATUS_CANCELED" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.Task.STATUS_CANCELING">
|
||
<code class="descname">STATUS_CANCELING</code><em class="property"> = 'CANCELING'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Task.STATUS_CANCELING" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.Task.STATUS_FAILED">
|
||
<code class="descname">STATUS_FAILED</code><em class="property"> = 'FAILED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Task.STATUS_FAILED" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.Task.STATUS_FINISHED">
|
||
<code class="descname">STATUS_FINISHED</code><em class="property"> = 'FINISHED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Task.STATUS_FINISHED" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.Task.STATUS_STARTED">
|
||
<code class="descname">STATUS_STARTED</code><em class="property"> = 'STARTED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Task.STATUS_STARTED" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.TaskProgressPhase">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">TaskProgressPhase</code><span class="sig-paren">(</span><em>id=None</em>, <em>name=None</em>, <em>progress_percent=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.TaskProgressPhase" 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>A task progress can be (but does NOT have to be) divided to more meaningful
|
||
progress phases.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifier of the task progress phase</li>
|
||
<li><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The display name of the task progress phase</li>
|
||
<li><strong>progress_percent</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The percentage of the phase that has completed format: int32</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.TermOfferInstance">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">TermOfferInstance</code><span class="sig-paren">(</span><em>product_type=None</em>, <em>name=None</em>, <em>region=None</em>, <em>commitment_term=None</em>, <em>unit_price=None</em>, <em>currency=None</em>, <em>version=None</em>, <em>description=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.TermOfferInstance" 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>Holder for the term offer instances.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>product_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </li>
|
||
<li><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </li>
|
||
<li><strong>region</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </li>
|
||
<li><strong>commitment_term</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – </li>
|
||
<li><strong>unit_price</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </li>
|
||
<li><strong>currency</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </li>
|
||
<li><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </li>
|
||
<li><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.TrafficShapingPolicy">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">TrafficShapingPolicy</code><span class="sig-paren">(</span><em>burst_size=None</em>, <em>average_bandwidth=None</em>, <em>peak_bandwidth=None</em>, <em>enabled=None</em>, <em>inherited=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.TrafficShapingPolicy" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>burst_size</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>) – </li>
|
||
<li><strong>average_bandwidth</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>) – </li>
|
||
<li><strong>peak_bandwidth</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>) – </li>
|
||
<li><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>inherited</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>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.VmcLocale">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">VmcLocale</code><span class="sig-paren">(</span><em>locale=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.VmcLocale" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>locale</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 locale to be used for translating responses for the session</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.Vnic">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">Vnic</code><span class="sig-paren">(</span><em>sub_interfaces=None</em>, <em>address_groups=None</em>, <em>is_connected=None</em>, <em>enable_send_redirects=None</em>, <em>in_shaping_policy=None</em>, <em>label=None</em>, <em>enable_proxy_arp=None</em>, <em>index=None</em>, <em>name=None</em>, <em>mtu=None</em>, <em>fence_parameters=None</em>, <em>mac_addresses=None</em>, <em>out_shaping_policy=None</em>, <em>portgroup_name=None</em>, <em>enable_bridge_mode=None</em>, <em>type=None</em>, <em>portgroup_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.Vnic" 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>NSX Edge vnic configuration details.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>sub_interfaces</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.SubInterfaces" title="com.vmware.vmc.model_client.SubInterfaces"><code class="xref py py-class docutils literal notranslate"><span class="pre">SubInterfaces</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of sub interfaces. Sub interfaces can be created only on a
|
||
trunk interface.</li>
|
||
<li><strong>address_groups</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.EdgeVnicAddressGroups" title="com.vmware.vmc.model_client.EdgeVnicAddressGroups"><code class="xref py py-class docutils literal notranslate"><span class="pre">EdgeVnicAddressGroups</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Address group configuration of the interface.</li>
|
||
<li><strong>is_connected</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>) – Value is true if the vnic is connected to a logical switch,
|
||
standard portgroup or distributed portgroup.</li>
|
||
<li><strong>enable_send_redirects</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>) – Value is true if send redirects is enabled. Enable ICMP redirect to
|
||
convey routing information to hosts.</li>
|
||
<li><strong>in_shaping_policy</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.TrafficShapingPolicy" title="com.vmware.vmc.model_client.TrafficShapingPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">TrafficShapingPolicy</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>label</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Interface label of format vNic_{vnicIndex} provided by NSX Manager.
|
||
Read only.</li>
|
||
<li><strong>enable_proxy_arp</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>) – Value is true if proxy arp is enabled. Enable proxy ARP if you want
|
||
to allow the NSX Edge of type ‘gatewayServices’ to answer ARP
|
||
requests intended for other machines.</li>
|
||
<li><strong>index</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Index of the vnic. Min value is 0 and max value is 9. format: int32</li>
|
||
<li><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>) – Name of the interface. Optional.</li>
|
||
<li><strong>mtu</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>) – MTU of the interface, with default as 1500. Min is 68, Max is 9000.
|
||
Optional. format: int32</li>
|
||
<li><strong>fence_parameters</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.KeyValueAttributes" title="com.vmware.vmc.model_client.KeyValueAttributes"><code class="xref py py-class docutils literal notranslate"><span class="pre">KeyValueAttributes</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>mac_addresses</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.MacAddress" title="com.vmware.vmc.model_client.MacAddress"><code class="xref py py-class docutils literal notranslate"><span class="pre">MacAddress</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Distinct MAC addresses configured for the vnic. Optional.</li>
|
||
<li><strong>out_shaping_policy</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.TrafficShapingPolicy" title="com.vmware.vmc.model_client.TrafficShapingPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">TrafficShapingPolicy</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>portgroup_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>) – Name of the port group or logical switch.</li>
|
||
<li><strong>enable_bridge_mode</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>) – Value is true if bridge mode is enabled.</li>
|
||
<li><strong>type</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>) – Type of the vnic. Values are uplink, internal, trunk. At least one
|
||
internal interface must be configured for NSX Edge HA to work.</li>
|
||
<li><strong>portgroup_id</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>) – Value are port group ID (standard portgroup or distributed
|
||
portgroup) or virtual wire ID (logical switch). Logical switch
|
||
cannot be used for a TRUNK vnic. Portgroup cannot be shared among
|
||
vnics/LIFs. Required when isConnected is specified as true. Example
|
||
‘network-17’ (standard portgroup), ‘dvportgroup-34’ (distributed
|
||
portgroup) or ‘virtualwire-2’ (logical switch).</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.Vnics">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">Vnics</code><span class="sig-paren">(</span><em>vnics=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.Vnics" 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>Ordered list of NSX Edge vnics. Until one connected vnic is configured,
|
||
none of the configured features will serve the network.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>vnics</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.Vnic" title="com.vmware.vmc.model_client.Vnic"><code class="xref py py-class docutils literal notranslate"><span class="pre">Vnic</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Ordered list of NSX Edge vnics.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.VpcInfo">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">VpcInfo</code><span class="sig-paren">(</span><em>vpc_cidr=None</em>, <em>vm_security_group_id=None</em>, <em>route_table_id=None</em>, <em>edge_subnet_id=None</em>, <em>id=None</em>, <em>api_association_id=None</em>, <em>private_subnet_id=None</em>, <em>api_subnet_id=None</em>, <em>esx_security_group_id=None</em>, <em>subnet_id=None</em>, <em>internet_gateway_id=None</em>, <em>security_group_id=None</em>, <em>association_id=None</em>, <em>vgw_route_table_id=None</em>, <em>edge_association_id=None</em>, <em>vif_ids=None</em>, <em>peering_connection_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.VpcInfo" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>vpc_cidr</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>) – </li>
|
||
<li><strong>vm_security_group_id</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>) – </li>
|
||
<li><strong>route_table_id</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>) – </li>
|
||
<li><strong>edge_subnet_id</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>) – Id of the NSX edge associated with this VPC</li>
|
||
<li><strong>id</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>) – </li>
|
||
<li><strong>api_association_id</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>) – Id of the association between subnet and route-table</li>
|
||
<li><strong>private_subnet_id</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>) – </li>
|
||
<li><strong>api_subnet_id</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>) – Id associated with this VPC</li>
|
||
<li><strong>esx_security_group_id</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>) – </li>
|
||
<li><strong>subnet_id</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>) – </li>
|
||
<li><strong>internet_gateway_id</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>) – </li>
|
||
<li><strong>security_group_id</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>) – </li>
|
||
<li><strong>association_id</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>) – </li>
|
||
<li><strong>vgw_route_table_id</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>) – Route table which contains the route to VGW</li>
|
||
<li><strong>edge_association_id</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>) – Id of the association between edge subnet and route-table</li>
|
||
<li><strong>vif_ids</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>peering_connection_id</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>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.VpcInfoSubnets">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">VpcInfoSubnets</code><span class="sig-paren">(</span><em>vpc_id=None</em>, <em>cidr_block=None</em>, <em>description=None</em>, <em>subnets=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.VpcInfoSubnets" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>vpc_id</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 ID of the VPC these subnets belong to.</li>
|
||
<li><strong>cidr_block</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 overall CIDR block of the VPC. This is the AWS primary CIDR
|
||
block.</li>
|
||
<li><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The description of the VPC; usually it’s name or id.</li>
|
||
<li><strong>subnets</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.SubnetInfo" title="com.vmware.vmc.model_client.SubnetInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">SubnetInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.Vpn">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">Vpn</code><span class="sig-paren">(</span><em>version=None</em>, <em>on_prem_gateway_ip=None</em>, <em>on_prem_network_cidr=None</em>, <em>pfs_enabled=None</em>, <em>id=None</em>, <em>channel_status=None</em>, <em>on_prem_nat_ip=None</em>, <em>name=None</em>, <em>internal_network_ids=None</em>, <em>tunnel_statuses=None</em>, <em>encryption=None</em>, <em>enabled=None</em>, <em>state=None</em>, <em>dh_group=None</em>, <em>authentication=None</em>, <em>pre_shared_key=None</em>, <em>ike_option=None</em>, <em>digest_algorithm=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.Vpn" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>version</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>) – </li>
|
||
<li><strong>on_prem_gateway_ip</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>) – </li>
|
||
<li><strong>on_prem_network_cidr</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>) – </li>
|
||
<li><strong>pfs_enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>id</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>) – </li>
|
||
<li><strong>channel_status</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.VpnChannelStatus" title="com.vmware.vmc.model_client.VpnChannelStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">VpnChannelStatus</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>on_prem_nat_ip</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>) – </li>
|
||
<li><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>) – </li>
|
||
<li><strong>internal_network_ids</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>tunnel_statuses</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.VpnTunnelStatus" title="com.vmware.vmc.model_client.VpnTunnelStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">VpnTunnelStatus</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>encryption</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>) – <p>Possible values are:</p>
|
||
<ul>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.Vpn.ENCRYPTION_AES" title="com.vmware.vmc.model_client.Vpn.ENCRYPTION_AES"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Vpn.ENCRYPTION_AES</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.Vpn.ENCRYPTION_AES256" title="com.vmware.vmc.model_client.Vpn.ENCRYPTION_AES256"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Vpn.ENCRYPTION_AES256</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.Vpn.ENCRYPTION_AES_GCM" title="com.vmware.vmc.model_client.Vpn.ENCRYPTION_AES_GCM"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Vpn.ENCRYPTION_AES_GCM</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.Vpn.ENCRYPTION_TRIPLE_DES" title="com.vmware.vmc.model_client.Vpn.ENCRYPTION_TRIPLE_DES"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Vpn.ENCRYPTION_TRIPLE_DES</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.Vpn.ENCRYPTION_UNKNOWN" title="com.vmware.vmc.model_client.Vpn.ENCRYPTION_UNKNOWN"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Vpn.ENCRYPTION_UNKNOWN</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>state</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>) – <p>Possible values are:</p>
|
||
<ul>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.Vpn.STATE_CONNECTED" title="com.vmware.vmc.model_client.Vpn.STATE_CONNECTED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Vpn.STATE_CONNECTED</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.Vpn.STATE_DISCONNECTED" title="com.vmware.vmc.model_client.Vpn.STATE_DISCONNECTED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Vpn.STATE_DISCONNECTED</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.Vpn.STATE_PARTIALLY_CONNECTED" title="com.vmware.vmc.model_client.Vpn.STATE_PARTIALLY_CONNECTED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Vpn.STATE_PARTIALLY_CONNECTED</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.Vpn.STATE_UNKNOWN" title="com.vmware.vmc.model_client.Vpn.STATE_UNKNOWN"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Vpn.STATE_UNKNOWN</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>dh_group</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>) – <p>Possible values are:</p>
|
||
<ul>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.Vpn.DH_GROUP_DH2" title="com.vmware.vmc.model_client.Vpn.DH_GROUP_DH2"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Vpn.DH_GROUP_DH2</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.Vpn.DH_GROUP_DH5" title="com.vmware.vmc.model_client.Vpn.DH_GROUP_DH5"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Vpn.DH_GROUP_DH5</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.Vpn.DH_GROUP_DH14" title="com.vmware.vmc.model_client.Vpn.DH_GROUP_DH14"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Vpn.DH_GROUP_DH14</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.Vpn.DH_GROUP_DH15" title="com.vmware.vmc.model_client.Vpn.DH_GROUP_DH15"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Vpn.DH_GROUP_DH15</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.Vpn.DH_GROUP_DH16" title="com.vmware.vmc.model_client.Vpn.DH_GROUP_DH16"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Vpn.DH_GROUP_DH16</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.Vpn.DH_GROUP_UNKNOWN" title="com.vmware.vmc.model_client.Vpn.DH_GROUP_UNKNOWN"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Vpn.DH_GROUP_UNKNOWN</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>authentication</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>) – <p>Possible values are:</p>
|
||
<ul>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.Vpn.AUTHENTICATION_PSK" title="com.vmware.vmc.model_client.Vpn.AUTHENTICATION_PSK"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Vpn.AUTHENTICATION_PSK</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.Vpn.AUTHENTICATION_UNKNOWN" title="com.vmware.vmc.model_client.Vpn.AUTHENTICATION_UNKNOWN"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Vpn.AUTHENTICATION_UNKNOWN</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>pre_shared_key</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>) – </li>
|
||
<li><strong>ike_option</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>) – <p>Possible values are:</p>
|
||
<ul>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.Vpn.IKE_OPTION_IKEV1" title="com.vmware.vmc.model_client.Vpn.IKE_OPTION_IKEV1"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Vpn.IKE_OPTION_IKEV1</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.Vpn.IKE_OPTION_IKEV2" title="com.vmware.vmc.model_client.Vpn.IKE_OPTION_IKEV2"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Vpn.IKE_OPTION_IKEV2</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>digest_algorithm</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>) – <p>Possible values are:</p>
|
||
<ul>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.Vpn.DIGEST_ALGORITHM_SHA1" title="com.vmware.vmc.model_client.Vpn.DIGEST_ALGORITHM_SHA1"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Vpn.DIGEST_ALGORITHM_SHA1</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.Vpn.DIGEST_ALGORITHM_SHA_256" title="com.vmware.vmc.model_client.Vpn.DIGEST_ALGORITHM_SHA_256"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Vpn.DIGEST_ALGORITHM_SHA_256</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.Vpn.AUTHENTICATION_PSK">
|
||
<code class="descname">AUTHENTICATION_PSK</code><em class="property"> = 'PSK'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Vpn.AUTHENTICATION_PSK" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.Vpn.AUTHENTICATION_UNKNOWN">
|
||
<code class="descname">AUTHENTICATION_UNKNOWN</code><em class="property"> = 'UNKNOWN'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Vpn.AUTHENTICATION_UNKNOWN" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.Vpn.DH_GROUP_DH14">
|
||
<code class="descname">DH_GROUP_DH14</code><em class="property"> = 'DH14'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Vpn.DH_GROUP_DH14" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.Vpn.DH_GROUP_DH15">
|
||
<code class="descname">DH_GROUP_DH15</code><em class="property"> = 'DH15'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Vpn.DH_GROUP_DH15" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.Vpn.DH_GROUP_DH16">
|
||
<code class="descname">DH_GROUP_DH16</code><em class="property"> = 'DH16'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Vpn.DH_GROUP_DH16" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.Vpn.DH_GROUP_DH2">
|
||
<code class="descname">DH_GROUP_DH2</code><em class="property"> = 'DH2'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Vpn.DH_GROUP_DH2" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.Vpn.DH_GROUP_DH5">
|
||
<code class="descname">DH_GROUP_DH5</code><em class="property"> = 'DH5'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Vpn.DH_GROUP_DH5" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.Vpn.DH_GROUP_UNKNOWN">
|
||
<code class="descname">DH_GROUP_UNKNOWN</code><em class="property"> = 'UNKNOWN'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Vpn.DH_GROUP_UNKNOWN" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.Vpn.DIGEST_ALGORITHM_SHA1">
|
||
<code class="descname">DIGEST_ALGORITHM_SHA1</code><em class="property"> = 'SHA1'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Vpn.DIGEST_ALGORITHM_SHA1" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.Vpn.DIGEST_ALGORITHM_SHA_256">
|
||
<code class="descname">DIGEST_ALGORITHM_SHA_256</code><em class="property"> = 'SHA_256'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Vpn.DIGEST_ALGORITHM_SHA_256" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.Vpn.ENCRYPTION_AES">
|
||
<code class="descname">ENCRYPTION_AES</code><em class="property"> = 'AES'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Vpn.ENCRYPTION_AES" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.Vpn.ENCRYPTION_AES256">
|
||
<code class="descname">ENCRYPTION_AES256</code><em class="property"> = 'AES256'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Vpn.ENCRYPTION_AES256" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.Vpn.ENCRYPTION_AES_GCM">
|
||
<code class="descname">ENCRYPTION_AES_GCM</code><em class="property"> = 'AES_GCM'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Vpn.ENCRYPTION_AES_GCM" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.Vpn.ENCRYPTION_TRIPLE_DES">
|
||
<code class="descname">ENCRYPTION_TRIPLE_DES</code><em class="property"> = 'TRIPLE_DES'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Vpn.ENCRYPTION_TRIPLE_DES" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.Vpn.ENCRYPTION_UNKNOWN">
|
||
<code class="descname">ENCRYPTION_UNKNOWN</code><em class="property"> = 'UNKNOWN'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Vpn.ENCRYPTION_UNKNOWN" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.Vpn.IKE_OPTION_IKEV1">
|
||
<code class="descname">IKE_OPTION_IKEV1</code><em class="property"> = 'IKEV1'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Vpn.IKE_OPTION_IKEV1" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.Vpn.IKE_OPTION_IKEV2">
|
||
<code class="descname">IKE_OPTION_IKEV2</code><em class="property"> = 'IKEV2'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Vpn.IKE_OPTION_IKEV2" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.Vpn.STATE_CONNECTED">
|
||
<code class="descname">STATE_CONNECTED</code><em class="property"> = 'CONNECTED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Vpn.STATE_CONNECTED" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.Vpn.STATE_DISCONNECTED">
|
||
<code class="descname">STATE_DISCONNECTED</code><em class="property"> = 'DISCONNECTED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Vpn.STATE_DISCONNECTED" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.Vpn.STATE_PARTIALLY_CONNECTED">
|
||
<code class="descname">STATE_PARTIALLY_CONNECTED</code><em class="property"> = 'PARTIALLY_CONNECTED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Vpn.STATE_PARTIALLY_CONNECTED" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.Vpn.STATE_UNKNOWN">
|
||
<code class="descname">STATE_UNKNOWN</code><em class="property"> = 'UNKNOWN'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Vpn.STATE_UNKNOWN" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.VpnChannelStatus">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">VpnChannelStatus</code><span class="sig-paren">(</span><em>channel_status=None</em>, <em>channel_state=None</em>, <em>last_info_message=None</em>, <em>failure_message=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.VpnChannelStatus" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>channel_status</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>) – <p>Possible values are:</p>
|
||
<ul>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.VpnChannelStatus.CHANNEL_STATUS_CONNECTED" title="com.vmware.vmc.model_client.VpnChannelStatus.CHANNEL_STATUS_CONNECTED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">VpnChannelStatus.CHANNEL_STATUS_CONNECTED</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.VpnChannelStatus.CHANNEL_STATUS_DISCONNECTED" title="com.vmware.vmc.model_client.VpnChannelStatus.CHANNEL_STATUS_DISCONNECTED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">VpnChannelStatus.CHANNEL_STATUS_DISCONNECTED</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.VpnChannelStatus.CHANNEL_STATUS_UNKNOWN" title="com.vmware.vmc.model_client.VpnChannelStatus.CHANNEL_STATUS_UNKNOWN"><code class="xref py py-attr docutils literal notranslate"><span class="pre">VpnChannelStatus.CHANNEL_STATUS_UNKNOWN</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>channel_state</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>) – </li>
|
||
<li><strong>last_info_message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>failure_message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.VpnChannelStatus.CHANNEL_STATUS_CONNECTED">
|
||
<code class="descname">CHANNEL_STATUS_CONNECTED</code><em class="property"> = 'CONNECTED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.VpnChannelStatus.CHANNEL_STATUS_CONNECTED" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.VpnChannelStatus.CHANNEL_STATUS_DISCONNECTED">
|
||
<code class="descname">CHANNEL_STATUS_DISCONNECTED</code><em class="property"> = 'DISCONNECTED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.VpnChannelStatus.CHANNEL_STATUS_DISCONNECTED" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.VpnChannelStatus.CHANNEL_STATUS_UNKNOWN">
|
||
<code class="descname">CHANNEL_STATUS_UNKNOWN</code><em class="property"> = 'UNKNOWN'</em><a class="headerlink" href="#com.vmware.vmc.model_client.VpnChannelStatus.CHANNEL_STATUS_UNKNOWN" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.VpnTunnelStatus">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">VpnTunnelStatus</code><span class="sig-paren">(</span><em>on_prem_subnet=None</em>, <em>traffic_stats=None</em>, <em>last_info_message=None</em>, <em>local_subnet=None</em>, <em>tunnel_state=None</em>, <em>failure_message=None</em>, <em>tunnel_status=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.VpnTunnelStatus" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>on_prem_subnet</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>) – </li>
|
||
<li><strong>traffic_stats</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.VpnTunnelTrafficStats" title="com.vmware.vmc.model_client.VpnTunnelTrafficStats"><code class="xref py py-class docutils literal notranslate"><span class="pre">VpnTunnelTrafficStats</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>last_info_message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>local_subnet</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>) – </li>
|
||
<li><strong>tunnel_state</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>) – </li>
|
||
<li><strong>failure_message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
|
||
<li><strong>tunnel_status</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>) – <p>Possible values are:</p>
|
||
<ul>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.VpnTunnelStatus.TUNNEL_STATUS_CONNECTED" title="com.vmware.vmc.model_client.VpnTunnelStatus.TUNNEL_STATUS_CONNECTED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">VpnTunnelStatus.TUNNEL_STATUS_CONNECTED</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.VpnTunnelStatus.TUNNEL_STATUS_DISCONNECTED" title="com.vmware.vmc.model_client.VpnTunnelStatus.TUNNEL_STATUS_DISCONNECTED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">VpnTunnelStatus.TUNNEL_STATUS_DISCONNECTED</span></code></a></li>
|
||
<li><a class="reference internal" href="#com.vmware.vmc.model_client.VpnTunnelStatus.TUNNEL_STATUS_UNKNOWN" title="com.vmware.vmc.model_client.VpnTunnelStatus.TUNNEL_STATUS_UNKNOWN"><code class="xref py py-attr docutils literal notranslate"><span class="pre">VpnTunnelStatus.TUNNEL_STATUS_UNKNOWN</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.VpnTunnelStatus.TUNNEL_STATUS_CONNECTED">
|
||
<code class="descname">TUNNEL_STATUS_CONNECTED</code><em class="property"> = 'CONNECTED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.VpnTunnelStatus.TUNNEL_STATUS_CONNECTED" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.VpnTunnelStatus.TUNNEL_STATUS_DISCONNECTED">
|
||
<code class="descname">TUNNEL_STATUS_DISCONNECTED</code><em class="property"> = 'DISCONNECTED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.VpnTunnelStatus.TUNNEL_STATUS_DISCONNECTED" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.model_client.VpnTunnelStatus.TUNNEL_STATUS_UNKNOWN">
|
||
<code class="descname">TUNNEL_STATUS_UNKNOWN</code><em class="property"> = 'UNKNOWN'</em><a class="headerlink" href="#com.vmware.vmc.model_client.VpnTunnelStatus.TUNNEL_STATUS_UNKNOWN" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.VpnTunnelTrafficStats">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">VpnTunnelTrafficStats</code><span class="sig-paren">(</span><em>packets_out=None</em>, <em>packet_received_errors=None</em>, <em>rx_bytes_on_local_subnet=None</em>, <em>replay_errors=None</em>, <em>sequence_number_over_flow_errors=None</em>, <em>encryption_failures=None</em>, <em>integrity_errors=None</em>, <em>packet_sent_errors=None</em>, <em>decryption_failures=None</em>, <em>packets_in=None</em>, <em>tx_bytes_from_local_subnet=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.VpnTunnelTrafficStats" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>packets_out</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>) – </li>
|
||
<li><strong>packet_received_errors</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>) – </li>
|
||
<li><strong>rx_bytes_on_local_subnet</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>) – </li>
|
||
<li><strong>replay_errors</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>) – </li>
|
||
<li><strong>sequence_number_over_flow_errors</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>) – </li>
|
||
<li><strong>encryption_failures</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>) – </li>
|
||
<li><strong>integrity_errors</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>) – </li>
|
||
<li><strong>packet_sent_errors</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>) – </li>
|
||
<li><strong>decryption_failures</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>) – </li>
|
||
<li><strong>packets_in</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>) – </li>
|
||
<li><strong>tx_bytes_from_local_subnet</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>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.VsanConfigConstraints">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">VsanConfigConstraints</code><span class="sig-paren">(</span><em>max_capacity=None</em>, <em>recommended_capacities=None</em>, <em>supported_capacity_increment=None</em>, <em>min_capacity=None</em>, <em>num_hosts=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.VsanConfigConstraints" 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 describes the possible physical storage capacity choices for use with
|
||
a given VsanStorageDesigner implementation. These choices are specific to a
|
||
customer-defined number of hosts per cluster.</p>
|
||
<div class="admonition tip">
|
||
<p class="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>max_capacity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Maximum capacity supported for cluster (GiB). format: int64</li>
|
||
<li><strong>recommended_capacities</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>) – List of supported capacities which may offer preferable performance
|
||
(GiB). format: int64</li>
|
||
<li><strong>supported_capacity_increment</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>) – Increment to be added to min_capacity to result in a supported
|
||
capacity (GiB). format: int64</li>
|
||
<li><strong>min_capacity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Minimum capacity supported for cluster (GiB). format: int64</li>
|
||
<li><strong>num_hosts</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Number of hosts in cluster. format: int64</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.model_client.VsanEncryptionConfig">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.model_client.</code><code class="descname">VsanEncryptionConfig</code><span class="sig-paren">(</span><em>port=None</em>, <em>certificate=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.VsanEncryptionConfig" 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="first admonition-title">Tip</p>
|
||
<p class="last">The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>port</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Port to connect to AWS Key Management Service</li>
|
||
<li><strong>certificate</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>) – Public certificate used to connect to AWS Key Management Service</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-com.vmware.vmc.orgs_client">
|
||
<span id="com-vmware-vmc-orgs-client-module"></span><h2>com.vmware.vmc.orgs_client module<a class="headerlink" href="#module-com.vmware.vmc.orgs_client" title="Permalink to this headline">¶</a></h2>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.orgs_client.AccountLink">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs_client.</code><code class="descname">AccountLink</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs_client.AccountLink" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<dl class="method">
|
||
<dt id="com.vmware.vmc.orgs_client.AccountLink.get">
|
||
<code class="descname">get</code><span class="sig-paren">(</span><em>org</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs_client.AccountLink.get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Gets a link that can be used on a customer’s account to start the
|
||
linking process.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
|
||
Generic Error</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.orgs_client.Providers">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs_client.</code><code class="descname">Providers</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs_client.Providers" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<dl class="method">
|
||
<dt id="com.vmware.vmc.orgs_client.Providers.list">
|
||
<code class="descname">list</code><span class="sig-paren">(</span><em>org</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs_client.Providers.list" title="Permalink to this definition">¶</a></dt>
|
||
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vmc.orgs_client.Providers.list" title="com.vmware.vmc.orgs_client.Providers.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vmc.model_client.AwsCloudProvider" title="com.vmware.vmc.model_client.AwsCloudProvider"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.AwsCloudProvider</span></code></a></td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"></td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
||
Unauthorized</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||
Forbidden</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||
Organization doesn’t exist</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.orgs_client.Reservations">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs_client.</code><code class="descname">Reservations</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs_client.Reservations" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<dl class="method">
|
||
<dt id="com.vmware.vmc.orgs_client.Reservations.list">
|
||
<code class="descname">list</code><span class="sig-paren">(</span><em>org</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs_client.Reservations.list" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get all reservations for this org</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vmc.orgs_client.Reservations.list" title="com.vmware.vmc.orgs_client.Reservations.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vmc.model_client.MaintenanceWindowEntry" title="com.vmware.vmc.model_client.MaintenanceWindowEntry"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.MaintenanceWindowEntry</span></code></a></td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"></td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
||
Unauthorized</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||
Access not allowed to the operation for the current user</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.orgs_client.SddcTemplates">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs_client.</code><code class="descname">SddcTemplates</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs_client.SddcTemplates" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<dl class="method">
|
||
<dt id="com.vmware.vmc.orgs_client.SddcTemplates.delete">
|
||
<code class="descname">delete</code><span class="sig-paren">(</span><em>org</em>, <em>template_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs_client.SddcTemplates.delete" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Delete SDDC template identified by given id.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||
<li><strong>template_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – SDDC Template identifier (required)</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.vmc.model_client.Task" title="com.vmware.vmc.model_client.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Task</span></code></a></p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.vmc.model.Task</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
||
Unauthorized</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||
Forbidden</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vmc.orgs_client.SddcTemplates.get">
|
||
<code class="descname">get</code><span class="sig-paren">(</span><em>org</em>, <em>template_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs_client.SddcTemplates.get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get configuration template by given template id.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||
<li><strong>template_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – SDDC Template identifier (required)</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.vmc.model_client.SddcTemplate" title="com.vmware.vmc.model_client.SddcTemplate"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.SddcTemplate</span></code></a></p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.vmc.model.SddcTemplate</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
||
Unauthorized</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||
Forbidden</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||
Cannot find the SDDC Template with given identifier</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vmc.orgs_client.SddcTemplates.list">
|
||
<code class="descname">list</code><span class="sig-paren">(</span><em>org</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs_client.SddcTemplates.list" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>List all available SDDC configuration templates in an organization</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vmc.orgs_client.SddcTemplates.list" title="com.vmware.vmc.orgs_client.SddcTemplates.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vmc.model_client.SddcTemplate" title="com.vmware.vmc.model_client.SddcTemplate"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.SddcTemplate</span></code></a></td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"></td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
||
Unauthorized</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||
Forbidden</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.orgs_client.Sddcs">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs_client.</code><code class="descname">Sddcs</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs_client.Sddcs" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<dl class="method">
|
||
<dt id="com.vmware.vmc.orgs_client.Sddcs.create">
|
||
<code class="descname">create</code><span class="sig-paren">(</span><em>org</em>, <em>sddc_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs_client.Sddcs.create" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Provision an SDDC in target cloud</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||
<li><strong>sddc_config</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.AwsSddcConfig" title="com.vmware.vmc.model_client.AwsSddcConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.AwsSddcConfig</span></code></a>) – sddcConfig (required)</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.vmc.model_client.Task" title="com.vmware.vmc.model_client.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Task</span></code></a></p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.vmc.model.Task</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
||
Unauthorized</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||
Forbidden</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vmc.orgs_client.Sddcs.delete">
|
||
<code class="descname">delete</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>retain_configuration=None</em>, <em>template_name=None</em>, <em>force=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs_client.Sddcs.delete" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Delete SDDC</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||
<li><strong>retain_configuration</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – If = ‘true’, the SDDC’s configuration is retained as a template for
|
||
later use. This flag is applicable only to SDDCs in ACTIVE state.
|
||
(optional)</li>
|
||
<li><strong>template_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>) – Only applicable when retainConfiguration is also set to ‘true’.
|
||
When set, this value will be used as the name of the SDDC
|
||
configuration template generated. (optional)</li>
|
||
<li><strong>force</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>) – If = ‘true’, will delete forcefully. Beware: do not use the force
|
||
flag if there is a chance an active provisioning or deleting task
|
||
is running against this SDDC. This option is restricted. (optional)</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.vmc.model_client.Task" title="com.vmware.vmc.model_client.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Task</span></code></a></p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.vmc.model.Task</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
||
Unauthorized</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||
The sddc is not in a state that’s valid for deletion</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||
Access not allowed to the operation for the current user</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||
Cannot find the SDDC with given identifier</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vmc.orgs_client.Sddcs.get">
|
||
<code class="descname">get</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs_client.Sddcs.get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get SDDC</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.vmc.model_client.Sddc" title="com.vmware.vmc.model_client.Sddc"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Sddc</span></code></a></p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.vmc.model.Sddc</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
||
Unauthorized</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||
Forbidden</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||
Cannot find the SDDC with given identifier</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vmc.orgs_client.Sddcs.list">
|
||
<code class="descname">list</code><span class="sig-paren">(</span><em>org</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs_client.Sddcs.list" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>List all the SDDCs of an organization</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vmc.orgs_client.Sddcs.list" title="com.vmware.vmc.orgs_client.Sddcs.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vmc.model_client.Sddc" title="com.vmware.vmc.model_client.Sddc"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Sddc</span></code></a></td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"></td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
||
Unauthorized</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||
Forbidden</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.orgs_client.StubFactory">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs_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>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>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</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.orgs_client.Subscriptions">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs_client.</code><code class="descname">Subscriptions</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs_client.Subscriptions" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.orgs_client.Subscriptions.GET_0_OFFER_TYPE_ON_DEMAND">
|
||
<code class="descname">GET_0_OFFER_TYPE_ON_DEMAND</code><em class="property"> = 'ON_DEMAND'</em><a class="headerlink" href="#com.vmware.vmc.orgs_client.Subscriptions.GET_0_OFFER_TYPE_ON_DEMAND" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">offerType</span></code> of method <a class="reference internal" href="#com.vmware.vmc.orgs_client.Subscriptions.get_0" title="com.vmware.vmc.orgs_client.Subscriptions.get_0"><code class="xref py py-func docutils literal notranslate"><span class="pre">Subscriptions.get_0()</span></code></a>.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vmc.orgs_client.Subscriptions.GET_0_OFFER_TYPE_TERM">
|
||
<code class="descname">GET_0_OFFER_TYPE_TERM</code><em class="property"> = 'TERM'</em><a class="headerlink" href="#com.vmware.vmc.orgs_client.Subscriptions.GET_0_OFFER_TYPE_TERM" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">offerType</span></code> of method <a class="reference internal" href="#com.vmware.vmc.orgs_client.Subscriptions.get_0" title="com.vmware.vmc.orgs_client.Subscriptions.get_0"><code class="xref py py-func docutils literal notranslate"><span class="pre">Subscriptions.get_0()</span></code></a>.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vmc.orgs_client.Subscriptions.create">
|
||
<code class="descname">create</code><span class="sig-paren">(</span><em>org</em>, <em>subscription_request</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs_client.Subscriptions.create" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Initiates the creation of a subscription</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||
<li><strong>subscription_request</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.SubscriptionRequest" title="com.vmware.vmc.model_client.SubscriptionRequest"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.SubscriptionRequest</span></code></a>) – subscriptionRequest (required)</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.vmc.model_client.Task" title="com.vmware.vmc.model_client.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Task</span></code></a></p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.vmc.model.Task</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
||
Unauthorized</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||
Forbidden</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||
Server error. Check retryable flag to see if request should be
|
||
retried.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vmc.orgs_client.Subscriptions.get">
|
||
<code class="descname">get</code><span class="sig-paren">(</span><em>org</em>, <em>subscription</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs_client.Subscriptions.get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get subscription details for a given subscription id</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||
<li><strong>subscription</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – SubscriptionId for an sddc. (required)</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.vmc.model_client.SubscriptionDetails" title="com.vmware.vmc.model_client.SubscriptionDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.SubscriptionDetails</span></code></a></p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.vmc.model.SubscriptionDetails</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||
Server error. Check retryable flag to see if request should be
|
||
retried.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||
Not Found</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vmc.orgs_client.Subscriptions.get_0">
|
||
<code class="descname">get_0</code><span class="sig-paren">(</span><em>org</em>, <em>offer_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs_client.Subscriptions.get_0" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns all subscriptions for a given org id</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||
<li><strong>offer_type</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>) – Offer Type * `ON_DEMAND` - on-demand subscription *
|
||
`TERM` - term subscription * All subscriptions if not
|
||
specified (optional)</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.SubscriptionDetails" title="com.vmware.vmc.model_client.SubscriptionDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.SubscriptionDetails</span></code></a></p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"></p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
||
Unauthorized</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||
Server error. Check retryable flag to see if request should be
|
||
retried.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||
Not Found</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vmc.orgs_client.Tasks">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs_client.</code><code class="descname">Tasks</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs_client.Tasks" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<dl class="method">
|
||
<dt id="com.vmware.vmc.orgs_client.Tasks.get">
|
||
<code class="descname">get</code><span class="sig-paren">(</span><em>org</em>, <em>task</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs_client.Tasks.get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Retrieve details of a task.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||
<li><strong>task</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Task identifier (required)</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.vmc.model_client.Task" title="com.vmware.vmc.model_client.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Task</span></code></a></p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.vmc.model.Task</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
||
Unauthorized</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||
Forbidden</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||
Cannot find the task with given identifier</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vmc.orgs_client.Tasks.list">
|
||
<code class="descname">list</code><span class="sig-paren">(</span><em>org</em>, <em>filter=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs_client.Tasks.list" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>List all tasks with optional filtering.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||
<li><strong>filter</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>) – Filter expression Binary Operators: ‘eq’, ‘ne’, ‘lt’, ‘gt’, ‘le’,
|
||
‘ge’, ‘mul’, ‘div’, ‘mod’, ‘sub’, ‘add’ Unary Operators: ‘not’, ‘-‘
|
||
(minus) String Operators: ‘startswith’, ‘endswith’, ‘length’,
|
||
‘contains’, ‘tolower’, ‘toupper’, Nested attributes are composed
|
||
using ‘.’ Dates must be formatted as yyyy-MM-dd or
|
||
yyyy-MM-ddTHH:mm:ss[.SSS]Z Strings should enclosed in single
|
||
quotes, escape single quote with two single quotes The special
|
||
literal ‘created’ will be mapped to the time the resource was first
|
||
created. Examples: - $filter=(updated gt 2016-08-09T13:00:00Z) and
|
||
(org_id eq 278710ff4e-6b6d-4d4e-aefb-ca637f38609e) -
|
||
$filter=(created eq 2016-08-09) - $filter=(created gt 2016-08-09)
|
||
and (sddc.status eq ‘READY’) (optional)</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.vmc.orgs_client.Tasks.list" title="com.vmware.vmc.orgs_client.Tasks.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vmc.model_client.Task" title="com.vmware.vmc.model_client.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Task</span></code></a></p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"></p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
||
Unauthorized</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||
Forbidden</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vmc.orgs_client.Tasks.update">
|
||
<code class="descname">update</code><span class="sig-paren">(</span><em>org</em>, <em>task</em>, <em>action=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs_client.Tasks.update" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Request that a running task be canceled. This is advisory only, some
|
||
tasks may not be cancelable, and some tasks might take an arbitrary
|
||
amount of time to respond to a cancelation request. The task must be
|
||
monitored to determine subsequent status.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||
<li><strong>task</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Task identifier (required)</li>
|
||
<li><strong>action</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>) – If = ‘cancel’, task will be canceled (optional)</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.vmc.model_client.Task" title="com.vmware.vmc.model_client.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Task</span></code></a></p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.vmc.model.Task</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
|
||
Unauthorized</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||
Invalid action or bad argument</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||
Forbidden</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||
Cannot find the task with given identifier</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<footer>
|
||
|
||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||
|
||
<a href="com.vmware.vmc.orgs.html" class="btn btn-neutral float-right" title="com.vmware.vmc.orgs package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||
|
||
|
||
<a href="com.vmware.html" class="btn btn-neutral" title="com.vmware package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||
|
||
</div>
|
||
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>
|
||
© Copyright 2019, 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" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||
<script type="text/javascript" src="_static/language_data.js"></script>
|
||
|
||
|
||
|
||
|
||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||
|
||
<script type="text/javascript">
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
</body>
|
||
</html> |