1
0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-29 12:00:00 -05:00
vsphere-automation-sdk-python/vmc/com.vmware.vmc.html

7574 lines
807 KiB
HTML
Raw Normal View History

2018-08-07 19:42:25 -04:00
<!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 &mdash; vmc 1.24.0 documentation</title>
2018-08-07 19:42:25 -04:00
2019-05-29 06:01:09 -04:00
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
2019-04-17 00:48:58 -04:00
2019-04-15 06:06:35 -04:00
2019-05-29 06:01:09 -04:00
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
2019-05-29 06:01:09 -04:00
<script type="text/javascript" src="_static/js/theme.js"></script>
2018-08-07 19:42:25 -04:00
2019-05-29 06:01:09 -04:00
2019-04-17 00:48:58 -04:00
2019-05-29 06:01:09 -04:00
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
2018-08-07 19:42:25 -04:00
<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" />
</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">
2019-05-29 06:01:09 -04:00
<div class="wy-side-nav-search" >
2018-08-07 19:42:25 -04:00
<a href="index.html" class="icon icon-home"> vmc
2018-08-07 19:42:25 -04:00
</a>
<div class="version">
1.24.0
2018-08-07 19:42:25 -04:00
</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>
2019-01-16 05:37:32 -05:00
<li class="toctree-l1"><a class="reference internal" href="vmware.html">vmware package</a></li>
2018-08-07 19:42:25 -04:00
</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">vmc</a>
2018-08-07 19:42:25 -04:00
</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> &raquo;</li>
<li><a href="com.html">com package</a> &raquo;</li>
<li><a href="com.vmware.html">com.vmware package</a> &raquo;</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.clusters.html">com.vmware.vmc.orgs.sddcs.clusters package</a><ul>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.clusters.html#submodules">Submodules</a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.clusters.html#module-com.vmware.vmc.orgs.sddcs.clusters.config_client">com.vmware.vmc.orgs.sddcs.clusters.config_client module</a></li>
</ul>
</li>
2018-08-07 19:42:25 -04:00
<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>
2019-05-29 06:01:09 -04:00
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.html#module-com.vmware.vmc.orgs.sddcs.addons_client">com.vmware.vmc.orgs.sddcs.addons_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.clusters_client">com.vmware.vmc.orgs.sddcs.clusters_client module</a></li>
2018-08-07 19:42:25 -04:00
<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>
2019-06-04 08:24:55 -04:00
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.html#module-com.vmware.vmc.orgs.sddcs.management_vms_client">com.vmware.vmc.orgs.sddcs.management_vms_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>
2018-08-07 19:42:25 -04:00
<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>
2019-01-16 05:37:32 -05:00
<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>
2018-08-07 19:42:25 -04:00
<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>
2019-01-16 05:37:32 -05:00
<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>
2018-08-07 19:42:25 -04:00
</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">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">AbstractEntity</code><span class="sig-paren">(</span><em class="sig-param">updated=None</em>, <em class="sig-param">user_id=None</em>, <em class="sig-param">updated_by_user_id=None</em>, <em class="sig-param">created=None</em>, <em class="sig-param">version=None</em>, <em class="sig-param">updated_by_user_name=None</em>, <em class="sig-param">user_name=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>updated</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) </p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><strong>created</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) </p></li>
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) Version of this entity format: int32</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Unique ID for this entity</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.AccountLinkConfig">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">AccountLinkConfig</code><span class="sig-paren">(</span><em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><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.</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.AccountLinkSddcConfig">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">AccountLinkSddcConfig</code><span class="sig-paren">(</span><em class="sig-param">customer_subnet_ids=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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>) </p></li>
<li><p><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.</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.AdditionalHostSpec">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">AdditionalHostSpec</code><span class="sig-paren">(</span><em class="sig-param">additional_host_count=None</em>, <em class="sig-param">storage_policy_reconfig_info=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.AdditionalHostSpec" title="Permalink to this definition"></a></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>Represents part of a structure of host provisioning spec.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>additional_host_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>) The additional valid host count.</p></li>
<li><p><strong>storage_policy_reconfig_info</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.StoragePolicyReconfigInfo" title="com.vmware.vmc.model_client.StoragePolicyReconfigInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">StoragePolicyReconfigInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Information regarding storage policy reconfiguration. It will be
set to null if no storage policy reconfiguration is available.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
2018-08-07 19:42:25 -04:00
<dl class="class">
<dt id="com.vmware.vmc.model_client.AddressFWSourceDestination">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">AddressFWSourceDestination</code><span class="sig-paren">(</span><em class="sig-param">exclude=None</em>, <em class="sig-param">ip_address=None</em>, <em class="sig-param">grouping_object_id=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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,
2018-08-07 19:42:25 -04:00
legacyPortGroup, VirtualMachine, vApp, resourcePool, logicalSwitch,
2019-06-08 00:29:34 -04:00
IPSet, securityGroup. Can define multiple.</p></li>
<li><p><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.</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.Agent">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">Agent</code><span class="sig-paren">(</span><em class="sig-param">internal_ip=None</em>, <em class="sig-param">agent_url=None</em>, <em class="sig-param">management_ip=None</em>, <em class="sig-param">hostname_verifier_enabled=None</em>, <em class="sig-param">master=None</em>, <em class="sig-param">network_netmask=None</em>, <em class="sig-param">network_gateway=None</em>, <em class="sig-param">provider='Agent'</em>, <em class="sig-param">cert_enabled=None</em>, <em class="sig-param">agent_state=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.Agent" title="Permalink to this definition"></a></dt>
2019-06-08 00:29:34 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>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>) The internal IP address of the agent which is provided by the
underlying cloud provider</p></li>
<li><p><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>) The accessible URL of the agent service, it is resolved to public
IP address from the Internet and private IP address within SDDC</p></li>
<li><p><strong>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>) The internal management IP address of the agent exposed to the
SDDC, which might be different from the internal IP</p></li>
2019-06-08 00:29:34 -04:00
<li><p><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</p></li>
<li><p><strong>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, only the
master Agent is accessible</p></li>
2019-06-08 00:29:34 -04:00
<li><p><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>) Network netmask of the agent</p></li>
<li><p><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>) Network gateway of the agent</p></li>
<li><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The cloud provider</p></li>
<li><p><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</p></li>
2019-06-08 00:29:34 -04:00
<li><p><strong>agent_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>
2019-05-29 06:01:09 -04:00
<ul>
2019-06-08 00:29:34 -04:00
<li><p><a class="reference internal" href="#com.vmware.vmc.model_client.Agent.AGENT_STATE_NOT_READY" title="com.vmware.vmc.model_client.Agent.AGENT_STATE_NOT_READY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Agent.AGENT_STATE_NOT_READY</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.vmc.model_client.Agent.AGENT_STATE_DEPLOYING" title="com.vmware.vmc.model_client.Agent.AGENT_STATE_DEPLOYING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Agent.AGENT_STATE_DEPLOYING</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.vmc.model_client.Agent.AGENT_STATE_CUSTOMIZING" title="com.vmware.vmc.model_client.Agent.AGENT_STATE_CUSTOMIZING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Agent.AGENT_STATE_CUSTOMIZING</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.vmc.model_client.Agent.AGENT_STATE_READY" title="com.vmware.vmc.model_client.Agent.AGENT_STATE_READY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Agent.AGENT_STATE_READY</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.vmc.model_client.Agent.AGENT_STATE_DELETING" title="com.vmware.vmc.model_client.Agent.AGENT_STATE_DELETING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Agent.AGENT_STATE_DELETING</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.vmc.model_client.Agent.AGENT_STATE_DELETED" title="com.vmware.vmc.model_client.Agent.AGENT_STATE_DELETED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Agent.AGENT_STATE_DELETED</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.vmc.model_client.Agent.AGENT_STATE_FAILED" title="com.vmware.vmc.model_client.Agent.AGENT_STATE_FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Agent.AGENT_STATE_FAILED</span></code></a></p></li>
2019-05-29 06:01:09 -04:00
</ul>
<blockquote>
2019-06-08 00:29:34 -04:00
<div><p>Agent state</p>
</div></blockquote>
</p></li>
2019-05-29 06:01:09 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2019-05-29 06:01:09 -04:00
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Agent.AGENT_STATE_CUSTOMIZING">
2019-06-08 00:29:34 -04:00
<code class="sig-name descname">AGENT_STATE_CUSTOMIZING</code><em class="property"> = 'CUSTOMIZING'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Agent.AGENT_STATE_CUSTOMIZING" title="Permalink to this definition"></a></dt>
2019-05-29 06:01:09 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Agent.AGENT_STATE_DELETED">
2019-06-08 00:29:34 -04:00
<code class="sig-name descname">AGENT_STATE_DELETED</code><em class="property"> = 'DELETED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Agent.AGENT_STATE_DELETED" title="Permalink to this definition"></a></dt>
2019-05-29 06:01:09 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Agent.AGENT_STATE_DELETING">
2019-06-08 00:29:34 -04:00
<code class="sig-name descname">AGENT_STATE_DELETING</code><em class="property"> = 'DELETING'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Agent.AGENT_STATE_DELETING" title="Permalink to this definition"></a></dt>
2019-05-29 06:01:09 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Agent.AGENT_STATE_DEPLOYING">
2019-06-08 00:29:34 -04:00
<code class="sig-name descname">AGENT_STATE_DEPLOYING</code><em class="property"> = 'DEPLOYING'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Agent.AGENT_STATE_DEPLOYING" title="Permalink to this definition"></a></dt>
2019-05-29 06:01:09 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Agent.AGENT_STATE_FAILED">
2019-06-08 00:29:34 -04:00
<code class="sig-name descname">AGENT_STATE_FAILED</code><em class="property"> = 'FAILED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Agent.AGENT_STATE_FAILED" title="Permalink to this definition"></a></dt>
2019-05-29 06:01:09 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Agent.AGENT_STATE_NOT_READY">
2019-06-08 00:29:34 -04:00
<code class="sig-name descname">AGENT_STATE_NOT_READY</code><em class="property"> = 'NOT_READY'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Agent.AGENT_STATE_NOT_READY" title="Permalink to this definition"></a></dt>
2019-05-29 06:01:09 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Agent.AGENT_STATE_READY">
2019-06-08 00:29:34 -04:00
<code class="sig-name descname">AGENT_STATE_READY</code><em class="property"> = 'READY'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Agent.AGENT_STATE_READY" title="Permalink to this definition"></a></dt>
2019-05-29 06:01:09 -04:00
<dd></dd></dl>
2019-06-08 00:29:34 -04:00
<dl class="method">
2019-05-29 06:01:09 -04:00
<dt id="com.vmware.vmc.model_client.Agent.provider">
2019-06-08 00:29:34 -04:00
<em class="property">property </em><code class="sig-name descname">provider</code><a class="headerlink" href="#com.vmware.vmc.model_client.Agent.provider" title="Permalink to this definition"></a></dt>
2019-05-29 06:01:09 -04:00
<dd><p>Return the discriminator value</p>
</dd></dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.AmiInfo">
2019-07-04 06:14:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">AmiInfo</code><span class="sig-paren">(</span><em class="sig-param">instance_type=None</em>, <em class="sig-param">region=None</em>, <em class="sig-param">id=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
2019-07-04 06:14:34 -04:00
<li><p><strong>instance_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>) instance type of the esx ami</p></li>
2019-06-08 00:29:34 -04:00
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) the name of the esx ami</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.AppliancesSummary">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">AppliancesSummary</code><span class="sig-paren">(</span><em class="sig-param">data_store_moid_of_active_vse=None</em>, <em class="sig-param">enable_fips=None</em>, <em class="sig-param">host_name_of_active_vse=None</em>, <em class="sig-param">vm_build_info=None</em>, <em class="sig-param">deploy_appliances=None</em>, <em class="sig-param">communication_channel=None</em>, <em class="sig-param">vm_name_of_active_vse=None</em>, <em class="sig-param">number_of_deployed_vms=None</em>, <em class="sig-param">resource_pool_moid_of_active_vse=None</em>, <em class="sig-param">data_store_name_of_active_vse=None</em>, <em class="sig-param">vm_moid_of_active_vse=None</em>, <em class="sig-param">status_from_vse_updated_on=None</em>, <em class="sig-param">fqdn=None</em>, <em class="sig-param">appliance_size=None</em>, <em class="sig-param">resource_pool_name_of_active_vse=None</em>, <em class="sig-param">active_vse_ha_index=None</em>, <em class="sig-param">vm_version=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>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 appliances data store.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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</p></li>
<li><p><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 appliances resource
2018-08-07 19:42:25 -04:00
pool/cluster. Can be resource pool ID, e.g. resgroup-15 or cluster
2019-06-08 00:29:34 -04:00
ID, e.g. domain-c41.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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</p></li>
<li><p><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.</p></li>
<li><p><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 appliances host.</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.Application">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">Application</code><span class="sig-paren">(</span><em class="sig-param">application_id=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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.</p></li>
<li><p><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.</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.AvailableZoneInfo">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">AvailableZoneInfo</code><span class="sig-paren">(</span><em class="sig-param">subnets=None</em>, <em class="sig-param">name=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.AvailableZoneInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>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.Subnet" title="com.vmware.vmc.model_client.Subnet"><code class="xref py py-class docutils literal notranslate"><span class="pre">Subnet</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) null</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) available zone name</p></li>
</ul>
</dd>
</dl>
</dd></dl>
2018-08-07 19:42:25 -04:00
<dl class="class">
<dt id="com.vmware.vmc.model_client.AwsAgent">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">AwsAgent</code><span class="sig-paren">(</span><em class="sig-param">instance_id=None</em>, <em class="sig-param">key_pair=None</em>, <em class="sig-param">internal_ip=None</em>, <em class="sig-param">agent_url=None</em>, <em class="sig-param">management_ip=None</em>, <em class="sig-param">hostname_verifier_enabled=None</em>, <em class="sig-param">master=None</em>, <em class="sig-param">network_netmask=None</em>, <em class="sig-param">network_gateway=None</em>, <em class="sig-param">provider='AWS'</em>, <em class="sig-param">cert_enabled=None</em>, <em class="sig-param">agent_state=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.AwsAgent" title="Permalink to this definition"></a></dt>
2019-06-08 00:29:34 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) The internal IP address of the agent which is provided by the
underlying cloud provider</p></li>
<li><p><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>) The accessible URL of the agent service, it is resolved to public
IP address from the Internet and private IP address within SDDC</p></li>
<li><p><strong>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>) The internal management IP address of the agent exposed to the
SDDC, which might be different from the internal IP</p></li>
2019-06-08 00:29:34 -04:00
<li><p><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</p></li>
<li><p><strong>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, only the
master Agent is accessible</p></li>
2019-06-08 00:29:34 -04:00
<li><p><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>) Network netmask of the agent</p></li>
<li><p><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>) Network gateway of the agent</p></li>
<li><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The cloud provider</p></li>
<li><p><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</p></li>
2019-06-08 00:29:34 -04:00
<li><p><strong>agent_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>
2019-05-29 06:01:09 -04:00
<ul>
2019-06-08 00:29:34 -04:00
<li><p><a class="reference internal" href="#com.vmware.vmc.model_client.Agent.AGENT_STATE_NOT_READY" title="com.vmware.vmc.model_client.Agent.AGENT_STATE_NOT_READY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Agent.AGENT_STATE_NOT_READY</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.vmc.model_client.Agent.AGENT_STATE_DEPLOYING" title="com.vmware.vmc.model_client.Agent.AGENT_STATE_DEPLOYING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Agent.AGENT_STATE_DEPLOYING</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.vmc.model_client.Agent.AGENT_STATE_CUSTOMIZING" title="com.vmware.vmc.model_client.Agent.AGENT_STATE_CUSTOMIZING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Agent.AGENT_STATE_CUSTOMIZING</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.vmc.model_client.Agent.AGENT_STATE_READY" title="com.vmware.vmc.model_client.Agent.AGENT_STATE_READY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Agent.AGENT_STATE_READY</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.vmc.model_client.Agent.AGENT_STATE_DELETING" title="com.vmware.vmc.model_client.Agent.AGENT_STATE_DELETING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Agent.AGENT_STATE_DELETING</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.vmc.model_client.Agent.AGENT_STATE_DELETED" title="com.vmware.vmc.model_client.Agent.AGENT_STATE_DELETED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Agent.AGENT_STATE_DELETED</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.vmc.model_client.Agent.AGENT_STATE_FAILED" title="com.vmware.vmc.model_client.Agent.AGENT_STATE_FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Agent.AGENT_STATE_FAILED</span></code></a></p></li>
2019-05-29 06:01:09 -04:00
</ul>
<blockquote>
2019-06-08 00:29:34 -04:00
<div><p>Agent state</p>
</div></blockquote>
</p></li>
</ul>
</dd>
</dl>
<dl class="method">
2019-05-29 06:01:09 -04:00
<dt id="com.vmware.vmc.model_client.AwsAgent.provider">
2019-06-08 00:29:34 -04:00
<em class="property">property </em><code class="sig-name descname">provider</code><a class="headerlink" href="#com.vmware.vmc.model_client.AwsAgent.provider" title="Permalink to this definition"></a></dt>
2019-05-29 06:01:09 -04:00
<dd><p>Return the discriminator value</p>
</dd></dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.AwsCloudProvider">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">AwsCloudProvider</code><span class="sig-paren">(</span><em class="sig-param">regions=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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>) </p></li>
<li><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Name of the Cloud Provider</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
<dl class="method">
2019-05-29 06:01:09 -04:00
<dt id="com.vmware.vmc.model_client.AwsCloudProvider.provider">
2019-06-08 00:29:34 -04:00
<em class="property">property </em><code class="sig-name descname">provider</code><a class="headerlink" href="#com.vmware.vmc.model_client.AwsCloudProvider.provider" title="Permalink to this definition"></a></dt>
2019-05-29 06:01:09 -04:00
<dd><p>Return the discriminator value</p>
</dd></dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.AwsCompatibleSubnets">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">AwsCompatibleSubnets</code><span class="sig-paren">(</span><em class="sig-param">customer_available_zones=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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>) </p></li>
<li><p><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>) </p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.AwsCustomerConnectedAccount">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">AwsCustomerConnectedAccount</code><span class="sig-paren">(</span><em class="sig-param">updated=None</em>, <em class="sig-param">user_id=None</em>, <em class="sig-param">updated_by_user_id=None</em>, <em class="sig-param">created=None</em>, <em class="sig-param">version=None</em>, <em class="sig-param">updated_by_user_name=None</em>, <em class="sig-param">user_name=None</em>, <em class="sig-param">id=None</em>, <em class="sig-param">policy_payer_arn=None</em>, <em class="sig-param">region_to_az_to_shadow_mapping=None</em>, <em class="sig-param">org_id=None</em>, <em class="sig-param">cf_stack_name=None</em>, <em class="sig-param">state=None</em>, <em class="sig-param">account_number=None</em>, <em class="sig-param">policy_service_arn=None</em>, <em class="sig-param">policy_external_id=None</em>, <em class="sig-param">policy_payer_linked_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="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>updated</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) </p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><strong>created</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) </p></li>
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) Version of this entity format: int32</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Unique ID for this entity</p></li>
<li><p><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>) </p></li>
<li><p><strong>region_to_az_to_shadow_mapping</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">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>) Provides a map of regions to availability zones from the shadow
accounts perspective</p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>
2019-05-29 06:01:09 -04:00
<ul>
2019-06-08 00:29:34 -04:00
<li><p><a class="reference internal" href="#com.vmware.vmc.model_client.AwsCustomerConnectedAccount.STATE_ACTIVE" title="com.vmware.vmc.model_client.AwsCustomerConnectedAccount.STATE_ACTIVE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">AwsCustomerConnectedAccount.STATE_ACTIVE</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.vmc.model_client.AwsCustomerConnectedAccount.STATE_BROKEN" title="com.vmware.vmc.model_client.AwsCustomerConnectedAccount.STATE_BROKEN"><code class="xref py py-attr docutils literal notranslate"><span class="pre">AwsCustomerConnectedAccount.STATE_BROKEN</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.vmc.model_client.AwsCustomerConnectedAccount.STATE_DELETED" title="com.vmware.vmc.model_client.AwsCustomerConnectedAccount.STATE_DELETED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">AwsCustomerConnectedAccount.STATE_DELETED</span></code></a></p></li>
2019-05-29 06:01:09 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><strong>policy_payer_linked_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>) </p></li>
2019-05-29 06:01:09 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2019-05-29 06:01:09 -04:00
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.AwsCustomerConnectedAccount.STATE_ACTIVE">
2019-06-08 00:29:34 -04:00
<code class="sig-name descname">STATE_ACTIVE</code><em class="property"> = 'ACTIVE'</em><a class="headerlink" href="#com.vmware.vmc.model_client.AwsCustomerConnectedAccount.STATE_ACTIVE" title="Permalink to this definition"></a></dt>
2019-05-29 06:01:09 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.AwsCustomerConnectedAccount.STATE_BROKEN">
2019-06-08 00:29:34 -04:00
<code class="sig-name descname">STATE_BROKEN</code><em class="property"> = 'BROKEN'</em><a class="headerlink" href="#com.vmware.vmc.model_client.AwsCustomerConnectedAccount.STATE_BROKEN" title="Permalink to this definition"></a></dt>
2019-05-29 06:01:09 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.AwsCustomerConnectedAccount.STATE_DELETED">
2019-06-08 00:29:34 -04:00
<code class="sig-name descname">STATE_DELETED</code><em class="property"> = 'DELETED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.AwsCustomerConnectedAccount.STATE_DELETED" title="Permalink to this definition"></a></dt>
2019-05-29 06:01:09 -04:00
<dd></dd></dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.AwsEsxHost">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">AwsEsxHost</code><span class="sig-paren">(</span><em class="sig-param">internal_public_ip_pool=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">availability_zone=None</em>, <em class="sig-param">esx_id=None</em>, <em class="sig-param">hostname=None</em>, <em class="sig-param">provider='AWS'</em>, <em class="sig-param">instance_type=None</em>, <em class="sig-param">mac_address=None</em>, <em class="sig-param">custom_properties=None</em>, <em class="sig-param">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>
2019-06-08 00:29:34 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>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>) </p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) </p></li>
<li><p><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.</p></li>
<li><p><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>) </p></li>
<li><p><strong>hostname</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) </p></li>
<li><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) </p></li>
<li><p><strong>instance_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>) Backing cloud provider instance type for host.</p></li>
2019-06-08 00:29:34 -04:00
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>
2018-08-07 19:42:25 -04:00
<ul>
2019-06-08 00:29:34 -04:00
<li><p><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></p></li>
2019-07-10 02:17:34 -04:00
<li><p><a class="reference internal" href="#com.vmware.vmc.model_client.EsxHost.ESX_STATE_INITIALIZING" title="com.vmware.vmc.model_client.EsxHost.ESX_STATE_INITIALIZING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">EsxHost.ESX_STATE_INITIALIZING</span></code></a></p></li>
2019-06-08 00:29:34 -04:00
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
2019-07-10 02:17:34 -04:00
<li><p><a class="reference internal" href="#com.vmware.vmc.model_client.EsxHost.ESX_STATE_ADDING_TO_VCENTER" title="com.vmware.vmc.model_client.EsxHost.ESX_STATE_ADDING_TO_VCENTER"><code class="xref py py-attr docutils literal notranslate"><span class="pre">EsxHost.ESX_STATE_ADDING_TO_VCENTER</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.vmc.model_client.EsxHost.ESX_STATE_DELETING_FROM_VCENTER" title="com.vmware.vmc.model_client.EsxHost.ESX_STATE_DELETING_FROM_VCENTER"><code class="xref py py-attr docutils literal notranslate"><span class="pre">EsxHost.ESX_STATE_DELETING_FROM_VCENTER</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.vmc.model_client.EsxHost.ESX_STATE_PENDING_CLOUD_DELETION" title="com.vmware.vmc.model_client.EsxHost.ESX_STATE_PENDING_CLOUD_DELETION"><code class="xref py py-attr docutils literal notranslate"><span class="pre">EsxHost.ESX_STATE_PENDING_CLOUD_DELETION</span></code></a></p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
<dl class="method">
2019-05-29 06:01:09 -04:00
<dt id="com.vmware.vmc.model_client.AwsEsxHost.provider">
2019-06-08 00:29:34 -04:00
<em class="property">property </em><code class="sig-name descname">provider</code><a class="headerlink" href="#com.vmware.vmc.model_client.AwsEsxHost.provider" title="Permalink to this definition"></a></dt>
2019-05-29 06:01:09 -04:00
<dd><p>Return the discriminator value</p>
</dd></dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.AwsKeyPair">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">AwsKeyPair</code><span class="sig-paren">(</span><em class="sig-param">key_name=None</em>, <em class="sig-param">key_fingerprint=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.AwsKmsInfo">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">AwsKmsInfo</code><span class="sig-paren">(</span><em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><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.</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.AwsSddcConfig">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">AwsSddcConfig</code><span class="sig-paren">(</span><em class="sig-param">region=None</em>, <em class="sig-param">one_node_reduced_capacity=None</em>, <em class="sig-param">vpc_cidr=None</em>, <em class="sig-param">host_instance_type=None</em>, <em class="sig-param">skip_creating_vxlan=None</em>, <em class="sig-param">vxlan_subnet=None</em>, <em class="sig-param">size=None</em>, <em class="sig-param">storage_capacity=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">account_link_sddc_config=None</em>, <em class="sig-param">num_hosts=None</em>, <em class="sig-param">sddc_type=None</em>, <em class="sig-param">account_link_config=None</em>, <em class="sig-param">provider='AWS'</em>, <em class="sig-param">sso_domain=None</em>, <em class="sig-param">sddc_template_id=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>region</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) </p></li>
<li><p><strong>one_node_reduced_capacity</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>) Whether this sddc is reduced capacity 1NODE.</p></li>
<li><p><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.</p></li>
<li><p><strong>host_instance_type</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.HostInstanceTypes" title="com.vmware.vmc.model_client.HostInstanceTypes"><code class="xref py py-class docutils literal notranslate"><span class="pre">HostInstanceTypes</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The instance type for the esx hosts in the primary cluster of the
SDDC.</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><strong>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>) The size of the vCenter and NSX appliances. “large” sddcSize
corresponds to a large vCenter appliance and large NSX
appliance. medium sddcSize corresponds to medium vCenter
appliance and medium NSX appliance. Value defaults to medium.</p></li>
2019-06-08 00:29:34 -04:00
<li><p><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
2019-01-16 05:37:32 -05:00
cluster, in GiBs. If provided, instead of using the direct-attached
storage, a capacity value amount of seperable storage will be used.
2019-06-08 00:29:34 -04:00
format: int64</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) </p></li>
<li><p><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.</p></li>
<li><p><strong>num_hosts</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) </p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) <p>Possible values are:</p>
2018-08-07 19:42:25 -04:00
<ul>
2019-06-08 00:29:34 -04:00
<li><p><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></p></li>
<li><p><a class="reference internal" href="#com.vmware.vmc.model_client.SddcConfig.PROVIDER_ZEROCLOUD" title="com.vmware.vmc.model_client.SddcConfig.PROVIDER_ZEROCLOUD"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SddcConfig.PROVIDER_ZEROCLOUD</span></code></a></p></li>
2018-08-07 19:42:25 -04:00
</ul>
<p>Determines what additional properties are available based on cloud
provider.</p>
2019-06-08 00:29:34 -04:00
</p></li>
<li><p><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.</p></li>
<li><p><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</p></li>
<li><p><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>
2018-08-07 19:42:25 -04:00
<ul>
2019-06-08 00:29:34 -04:00
<li><p><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></p></li>
<li><p><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></p></li>
2018-08-07 19:42:25 -04:00
</ul>
<p>Denotes if request is for a SingleAZ or a MultiAZ SDDC. Default is
SingleAZ.</p>
2019-06-08 00:29:34 -04:00
</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
<dl class="method">
2019-05-29 06:01:09 -04:00
<dt id="com.vmware.vmc.model_client.AwsSddcConfig.provider">
2019-06-08 00:29:34 -04:00
<em class="property">property </em><code class="sig-name descname">provider</code><a class="headerlink" href="#com.vmware.vmc.model_client.AwsSddcConfig.provider" title="Permalink to this definition"></a></dt>
2019-05-29 06:01:09 -04:00
<dd><p>Return the discriminator value</p>
</dd></dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.AwsSddcConnection">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">AwsSddcConnection</code><span class="sig-paren">(</span><em class="sig-param">updated=None</em>, <em class="sig-param">user_id=None</em>, <em class="sig-param">updated_by_user_id=None</em>, <em class="sig-param">created=None</em>, <em class="sig-param">version=None</em>, <em class="sig-param">updated_by_user_name=None</em>, <em class="sig-param">user_name=None</em>, <em class="sig-param">id=None</em>, <em class="sig-param">cidr_block_subnet=None</em>, <em class="sig-param">connected_account_id=None</em>, <em class="sig-param">eni_group=None</em>, <em class="sig-param">subnet_id=None</em>, <em class="sig-param">cgw_present=None</em>, <em class="sig-param">org_id=None</em>, <em class="sig-param">sddc_id=None</em>, <em class="sig-param">cidr_block_vpc=None</em>, <em class="sig-param">connection_order=None</em>, <em class="sig-param">state=None</em>, <em class="sig-param">subnet_availability_zone=None</em>, <em class="sig-param">vpc_id=None</em>, <em class="sig-param">customer_eni_infos=None</em>, <em class="sig-param">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="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>updated</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) </p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><strong>created</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) </p></li>
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) Version of this entity format: int32</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Unique ID for this entity</p></li>
<li><p><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>) The CIDR block of the customers subnet this link is in.</p></li>
<li><p><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 corresponding connected (customer) account UUID this connection
is attached to.</p></li>
<li><p><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>) Which group the ENIs belongs to. (deprecated)</p></li>
<li><p><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 this link is to.</p></li>
<li><p><strong>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>) Determines whether the CGW is present in this connection set or
not. Used for multi-az deployments.</p></li>
<li><p><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 this link belongs to.</p></li>
<li><p><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>) The SDDC this link is used for.</p></li>
<li><p><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>) The CIDR block of the customers VPC.</p></li>
<li><p><strong>connection_order</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 order of the connection</p></li>
<li><p><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>
2019-05-29 06:01:09 -04:00
<ul>
2019-06-08 00:29:34 -04:00
<li><p><a class="reference internal" href="#com.vmware.vmc.model_client.AwsSddcConnection.STATE_ACTIVE" title="com.vmware.vmc.model_client.AwsSddcConnection.STATE_ACTIVE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">AwsSddcConnection.STATE_ACTIVE</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.vmc.model_client.AwsSddcConnection.STATE_BROKEN" title="com.vmware.vmc.model_client.AwsSddcConnection.STATE_BROKEN"><code class="xref py py-attr docutils literal notranslate"><span class="pre">AwsSddcConnection.STATE_BROKEN</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.vmc.model_client.AwsSddcConnection.STATE_DELETED" title="com.vmware.vmc.model_client.AwsSddcConnection.STATE_DELETED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">AwsSddcConnection.STATE_DELETED</span></code></a></p></li>
2019-05-29 06:01:09 -04:00
</ul>
<blockquote>
2019-06-08 00:29:34 -04:00
<div><p>The state of the connection.</p>
</div></blockquote>
</p></li>
<li><p><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>) Which availability zone is this connection in?</p></li>
<li><p><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 of the subnet this link is to.</p></li>
<li><p><strong>customer_eni_infos</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.CustomerEniInfo" title="com.vmware.vmc.model_client.CustomerEniInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">CustomerEniInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) A list of all ENIs used for this connection.</p></li>
<li><p><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>) The default routing table in the customers VPC.</p></li>
2019-05-29 06:01:09 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2019-05-29 06:01:09 -04:00
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.AwsSddcConnection.STATE_ACTIVE">
2019-06-08 00:29:34 -04:00
<code class="sig-name descname">STATE_ACTIVE</code><em class="property"> = 'ACTIVE'</em><a class="headerlink" href="#com.vmware.vmc.model_client.AwsSddcConnection.STATE_ACTIVE" title="Permalink to this definition"></a></dt>
2019-05-29 06:01:09 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.AwsSddcConnection.STATE_BROKEN">
2019-06-08 00:29:34 -04:00
<code class="sig-name descname">STATE_BROKEN</code><em class="property"> = 'BROKEN'</em><a class="headerlink" href="#com.vmware.vmc.model_client.AwsSddcConnection.STATE_BROKEN" title="Permalink to this definition"></a></dt>
2019-05-29 06:01:09 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.AwsSddcConnection.STATE_DELETED">
2019-06-08 00:29:34 -04:00
<code class="sig-name descname">STATE_DELETED</code><em class="property"> = 'DELETED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.AwsSddcConnection.STATE_DELETED" title="Permalink to this definition"></a></dt>
2019-05-29 06:01:09 -04:00
<dd></dd></dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.AwsSddcResourceConfig">
2019-07-10 02:17:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">AwsSddcResourceConfig</code><span class="sig-paren">(</span><em class="sig-param">backup_restore_bucket=None</em>, <em class="sig-param">public_ip_pool=None</em>, <em class="sig-param">vpc_info=None</em>, <em class="sig-param">kms_vpc_endpoint=None</em>, <em class="sig-param">max_num_public_ip=None</em>, <em class="sig-param">account_link_sddc_config=None</em>, <em class="sig-param">vsan_encryption_config=None</em>, <em class="sig-param">vpc_info_peered_agent=None</em>, <em class="sig-param">mgmt_appliance_network_name=None</em>, <em class="sig-param">nsxt=None</em>, <em class="sig-param">mgw_id=None</em>, <em class="sig-param">nsx_mgr_url=None</em>, <em class="sig-param">psc_management_ip=None</em>, <em class="sig-param">psc_url=None</em>, <em class="sig-param">cgws=None</em>, <em class="sig-param">availability_zones=None</em>, <em class="sig-param">management_ds=None</em>, <em class="sig-param">nsx_api_public_endpoint_url=None</em>, <em class="sig-param">custom_properties=None</em>, <em class="sig-param">cloud_password=None</em>, <em class="sig-param">provider='AWS'</em>, <em class="sig-param">clusters=None</em>, <em class="sig-param">vc_management_ip=None</em>, <em class="sig-param">sddc_networks=None</em>, <em class="sig-param">cloud_username=None</em>, <em class="sig-param">esx_hosts=None</em>, <em class="sig-param">nsx_mgr_management_ip=None</em>, <em class="sig-param">vc_instance_id=None</em>, <em class="sig-param">esx_cluster_id=None</em>, <em class="sig-param">vc_public_ip=None</em>, <em class="sig-param">skip_creating_vxlan=None</em>, <em class="sig-param">vc_url=None</em>, <em class="sig-param">sddc_manifest=None</em>, <em class="sig-param">vxlan_subnet=None</em>, <em class="sig-param">cloud_user_group=None</em>, <em class="sig-param">management_rp=None</em>, <em class="sig-param">region=None</em>, <em class="sig-param">witness_availability_zone=None</em>, <em class="sig-param">sddc_id=None</em>, <em class="sig-param">pop_agent_xeni_connection=None</em>, <em class="sig-param">nsx_controller_ips=None</em>, <em class="sig-param">esx_host_subnet=None</em>, <em class="sig-param">sso_domain=None</em>, <em class="sig-param">deployment_type=None</em>, <em class="sig-param">nsxt_addons=None</em>, <em class="sig-param">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>
2019-06-08 00:29:34 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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.</p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><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>) </p></li>
<li><p><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
2018-08-07 19:42:25 -04:00
SDDCs will have hosts provisioned over two availability zones while
2019-06-08 00:29:34 -04:00
SingleAZ SDDCs will provision over one.</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><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>) </p></li>
<li><p><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</p></li>
<li><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) <p>Possible values are:</p>
2018-08-07 19:42:25 -04:00
<ul>
2019-06-08 00:29:34 -04:00
<li><p><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></p></li>
<li><p><a class="reference internal" href="#com.vmware.vmc.model_client.SddcResourceConfig.PROVIDER_ZEROCLOUD" title="com.vmware.vmc.model_client.SddcResourceConfig.PROVIDER_ZEROCLOUD"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SddcResourceConfig.PROVIDER_ZEROCLOUD</span></code></a></p></li>
2018-08-07 19:42:25 -04:00
</ul>
<blockquote>
2019-06-08 00:29:34 -04:00
<div><p>Discriminator for additional properties</p>
</div></blockquote>
</p></li>
<li><p><strong>clusters</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.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> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) List of clusters in the SDDC.</p></li>
<li><p><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</p></li>
<li><p><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>) </p></li>
<li><p><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</p></li>
<li><p><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>) </p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><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>) </p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><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>) </p></li>
2019-07-10 02:17:34 -04:00
<li><p><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>) region in which sddc is deployed</p></li>
2019-06-08 00:29:34 -04:00
<li><p><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.</p></li>
2019-07-10 02:17:34 -04:00
<li><p><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 identifier</p></li>
2019-06-08 00:29:34 -04:00
<li><p><strong>pop_agent_xeni_connection</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.PopAgentXeniConnection" title="com.vmware.vmc.model_client.PopAgentXeniConnection"><code class="xref py py-class docutils literal notranslate"><span class="pre">PopAgentXeniConnection</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) </p></li>
<li><p><strong>nsx_controller_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 Controller IPs</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><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>
2018-08-07 19:42:25 -04:00
<ul>
2019-06-08 00:29:34 -04:00
<li><p><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></p></li>
<li><p><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></p></li>
2018-08-07 19:42:25 -04:00
</ul>
<blockquote>
2019-06-08 00:29:34 -04:00
<div><p>Denotes if this is a SingleAZ SDDC or a MultiAZ SDDC.</p>
</div></blockquote>
</p></li>
<li><p><strong>nsxt_addons</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.NsxtAddons" title="com.vmware.vmc.model_client.NsxtAddons"><code class="xref py py-class docutils literal notranslate"><span class="pre">NsxtAddons</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) </p></li>
<li><p><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</p></li>
</ul>
</dd>
</dl>
<dl class="method">
2019-05-29 06:01:09 -04:00
<dt id="com.vmware.vmc.model_client.AwsSddcResourceConfig.provider">
2019-06-08 00:29:34 -04:00
<em class="property">property </em><code class="sig-name descname">provider</code><a class="headerlink" href="#com.vmware.vmc.model_client.AwsSddcResourceConfig.provider" title="Permalink to this definition"></a></dt>
2019-05-29 06:01:09 -04:00
<dd><p>Return the discriminator value</p>
</dd></dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.AwsSubnet">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">AwsSubnet</code><span class="sig-paren">(</span><em class="sig-param">connected_account_id=None</em>, <em class="sig-param">region_name=None</em>, <em class="sig-param">availability_zone=None</em>, <em class="sig-param">subnet_id=None</em>, <em class="sig-param">subnet_cidr_block=None</em>, <em class="sig-param">is_compatible=None</em>, <em class="sig-param">vpc_id=None</em>, <em class="sig-param">vpc_cidr_block=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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.</p></li>
<li><p><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).</p></li>
<li><p><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).</p></li>
<li><p><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-######.</p></li>
<li><p><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 #.#.#.#/#.</p></li>
<li><p><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.</p></li>
<li><p><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-#######.</p></li>
<li><p><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 #.#.#.#/#.</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Optional field (may not be provided by AWS), indicates the found
name tag for the subnet.</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.CaCertificates">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">CaCertificates</code><span class="sig-paren">(</span><em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><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>) </p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.CbmStatistic">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">CbmStatistic</code><span class="sig-paren">(</span><em class="sig-param">vnic=None</em>, <em class="sig-param">timestamp=None</em>, <em class="sig-param">out=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.CbmStatistics">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">CbmStatistics</code><span class="sig-paren">(</span><em class="sig-param">data_dto=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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.</p></li>
<li><p><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.</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.CbmStatsData">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">CbmStatsData</code><span class="sig-paren">(</span><em class="sig-param">vnic9=None</em>, <em class="sig-param">vnic8=None</em>, <em class="sig-param">vnic7=None</em>, <em class="sig-param">vnic6=None</em>, <em class="sig-param">vnic5=None</em>, <em class="sig-param">vnic4=None</em>, <em class="sig-param">vnic3=None</em>, <em class="sig-param">vnic2=None</em>, <em class="sig-param">vnic1=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.CloudProvider">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">CloudProvider</code><span class="sig-paren">(</span><em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Name of the Cloud Provider</p>
</dd>
</dl>
<dl class="method">
2019-05-29 06:01:09 -04:00
<dt id="com.vmware.vmc.model_client.CloudProvider.provider">
2019-06-08 00:29:34 -04:00
<em class="property">property </em><code class="sig-name descname">provider</code><a class="headerlink" href="#com.vmware.vmc.model_client.CloudProvider.provider" title="Permalink to this definition"></a></dt>
2019-05-29 06:01:09 -04:00
<dd><p>Return the discriminator value</p>
</dd></dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.Cluster">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">Cluster</code><span class="sig-paren">(</span><em class="sig-param">esx_host_list=None</em>, <em class="sig-param">cluster_state=None</em>, <em class="sig-param">aws_kms_info=None</em>, <em class="sig-param">esx_host_info=None</em>, <em class="sig-param">host_cpu_cores_count=None</em>, <em class="sig-param">cluster_capacity=None</em>, <em class="sig-param">cluster_id=None</em>, <em class="sig-param">cluster_name=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.Cluster" title="Permalink to this definition"></a></dt>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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>) </p></li>
<li><p><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>
2018-08-07 19:42:25 -04:00
<ul>
2019-06-08 00:29:34 -04:00
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</p></li>
<li><p><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</p></li>
<li><p><strong>esx_host_info</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.EsxHostInfo" title="com.vmware.vmc.model_client.EsxHostInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">EsxHostInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Information of the hosts added to this cluster</p></li>
2019-06-08 00:29:34 -04:00
<li><p><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>) Number of cores enabled on ESX hosts added to this cluster format:
int32</p></li>
<li><p><strong>cluster_capacity</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.EntityCapacity" title="com.vmware.vmc.model_client.EntityCapacity"><code class="xref py py-class docutils literal notranslate"><span class="pre">EntityCapacity</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The capacity of this cluster.</p></li>
2019-06-08 00:29:34 -04:00
<li><p><strong>cluster_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) </p></li>
<li><p><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>) </p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Cluster.CLUSTER_STATE_ADDING_HOSTS">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Cluster.CLUSTER_STATE_DEPLOYING">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Cluster.CLUSTER_STATE_FAILED">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Cluster.CLUSTER_STATE_READY">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.ClusterConfig">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">ClusterConfig</code><span class="sig-paren">(</span><em class="sig-param">host_cpu_cores_count=None</em>, <em class="sig-param">host_instance_type=None</em>, <em class="sig-param">storage_capacity=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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</p></li>
<li><p><strong>host_instance_type</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.HostInstanceTypes" title="com.vmware.vmc.model_client.HostInstanceTypes"><code class="xref py py-class docutils literal notranslate"><span class="pre">HostInstanceTypes</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The instance type for the esx hosts added to this cluster.</p></li>
2019-06-08 00:29:34 -04:00
<li><p><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</p></li>
<li><p><strong>num_hosts</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) </p></li>
2019-01-16 05:37:32 -05:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.ClusterProvisionSpec">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">ClusterProvisionSpec</code><span class="sig-paren">(</span><em class="sig-param">instance_type_configs=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.ClusterProvisionSpec" title="Permalink to this definition"></a></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>Represents a provisioning spec for a new cluster in an sddc.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>instance_type_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.InstanceTypeConfigForCluster" title="com.vmware.vmc.model_client.InstanceTypeConfigForCluster"><code class="xref py py-class docutils literal notranslate"><span class="pre">InstanceTypeConfigForCluster</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) List of instances available for the new cluster.</p>
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.ClusterReconfigureParams">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">ClusterReconfigureParams</code><span class="sig-paren">(</span><em class="sig-param">storage_capacity=None</em>, <em class="sig-param">bias=None</em>, <em class="sig-param">num_hosts=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.ClusterReconfigureParams" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>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 final desired storage capacity after reconfiguring the cluster
in GiB. format: int64</p></li>
<li><p><strong>bias</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Bias value as obtained from the storage constraints call.</p></li>
<li><p><strong>num_hosts</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) Number of hosts in the cluster after reconfiguring. format: int32</p></li>
</ul>
</dd>
</dl>
</dd></dl>
2018-08-07 19:42:25 -04:00
<dl class="class">
<dt id="com.vmware.vmc.model_client.ComputeGatewayTemplate">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">ComputeGatewayTemplate</code><span class="sig-paren">(</span><em class="sig-param">public_ip=None</em>, <em class="sig-param">primary_dns=None</em>, <em class="sig-param">secondary_dns=None</em>, <em class="sig-param">firewall_rules=None</em>, <em class="sig-param">vpns=None</em>, <em class="sig-param">logical_networks=None</em>, <em class="sig-param">nat_rules=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.ConfigSpec">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">ConfigSpec</code><span class="sig-paren">(</span><em class="sig-param">expiry_in_days=None</em>, <em class="sig-param">availability=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.ConfigSpec" title="Permalink to this definition"></a></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>Represents a configuration spec for any sddc provision operation.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>expiry_in_days</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Indicates after how many days the sddc should expire</p></li>
<li><p><strong>availability</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">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.InstanceTypeConfig" title="com.vmware.vmc.model_client.InstanceTypeConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">InstanceTypeConfig</span></code></a>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Map of region to instance types available in that region</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.ConnectivityAgentValidation">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">ConnectivityAgentValidation</code><span class="sig-paren">(</span><em class="sig-param">source=None</em>, <em class="sig-param">type=None</em>, <em class="sig-param">ports=None</em>, <em class="sig-param">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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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>
2019-01-16 05:37:32 -05:00
<ul>
2019-06-08 00:29:34 -04:00
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
2019-01-16 05:37:32 -05:00
</ul>
<blockquote>
2019-06-08 00:29:34 -04:00
<div><p>source appliance of connectivity test, i.e. VCENTER, SRM, VR.</p>
</div></blockquote>
</p></li>
<li><p><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>
2019-06-08 00:29:34 -04:00
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
</ul>
<p>type of connectivity test, i.e. PING, TRACEROUTE, DNS,
2019-01-16 05:37:32 -05:00
CONNECTIVITY, CURL. For CONNECTIVITY and CURL tests only, please
specify the ports to be tested against.</p>
2019-06-08 00:29:34 -04:00
</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2019-01-16 05:37:32 -05:00
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.ConnectivityAgentValidation.SOURCE_SRM">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2019-01-16 05:37:32 -05:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.ConnectivityAgentValidation.SOURCE_VCENTER">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2019-01-16 05:37:32 -05:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.ConnectivityAgentValidation.SOURCE_VR">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2019-01-16 05:37:32 -05:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.ConnectivityAgentValidation.TYPE_CONNECTIVITY">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2019-01-16 05:37:32 -05:00
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.ConnectivityAgentValidation.TYPE_CURL">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2019-01-16 05:37:32 -05:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.ConnectivityAgentValidation.TYPE_DNS">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">ConnectivityValidationGroup</code><span class="sig-paren">(</span><em class="sig-param">id=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) <p>Possible values are:</p>
<ul>
2019-06-08 00:29:34 -04:00
<li><p><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></p></li>
<li><p><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></p></li>
</ul>
<blockquote>
2019-06-08 00:29:34 -04:00
<div><p>test group id, currently, only HLM.</p>
</div></blockquote>
</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Name of the test group.</p></li>
<li><p><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.</p></li>
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2019-01-16 05:37:32 -05:00
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.ConnectivityValidationGroup.ID_DRAAS">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2019-01-16 05:37:32 -05:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.ConnectivityValidationGroup.ID_HLM">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">ConnectivityValidationGroups</code><span class="sig-paren">(</span><em class="sig-param">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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><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.</p>
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.ConnectivityValidationInput">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">ConnectivityValidationInput</code><span class="sig-paren">(</span><em class="sig-param">id=None</em>, <em class="sig-param">value=None</em>, <em class="sig-param">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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) <p>Possible values are:</p>
<ul>
2019-06-08 00:29:34 -04:00
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></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>
2019-06-08 00:29:34 -04:00
</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.ConnectivityValidationInput.ID_HOSTNAME">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">ConnectivityValidationSubGroup</code><span class="sig-paren">(</span><em class="sig-param">inputs=None</em>, <em class="sig-param">tests=None</em>, <em class="sig-param">label=None</em>, <em class="sig-param">help=None</em>, <em class="sig-param">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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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>
2019-06-08 00:29:34 -04:00
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
</ul>
<p>subGroup id, i.e. PRIMARY_DNS, SECONDARY_DNS, ONPREM_VCENTER,
2019-01-16 05:37:32 -05:00
ONPREM_PSC, ACTIVE_DIRECTORY, ONPREM_ESX, DRAAS_ONPREM_VCENTER,
DRAAS_ONPREM_PSC, DRAAS_ONPREM_SRM and DRAAS_ONPREM_VR.</p>
2019-06-08 00:29:34 -04:00
</p></li>
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_ACTIVE_DIRECTORY">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2019-01-16 05:37:32 -05:00
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_DRAAS_ONPREM_PSC">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2019-01-16 05:37:32 -05:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_DRAAS_ONPREM_SRM">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2019-01-16 05:37:32 -05:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_DRAAS_ONPREM_VCENTER">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2019-01-16 05:37:32 -05:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_DRAAS_ONPREM_VR">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2019-01-16 05:37:32 -05:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_ONPREM_ESX">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dl class="class">
<dt id="com.vmware.vmc.model_client.CrlCertificates">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">CrlCertificates</code><span class="sig-paren">(</span><em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><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>) </p>
</dd>
</dl>
2019-05-29 06:01:09 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.CustomerEniInfo">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">CustomerEniInfo</code><span class="sig-paren">(</span><em class="sig-param">secondary_ip_addresses=None</em>, <em class="sig-param">eni_id=None</em>, <em class="sig-param">primary_ip_address=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.CustomerEniInfo" title="Permalink to this definition"></a></dt>
2019-05-29 06:01:09 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Indicates a single cross-account ENI and its characteristics.</p>
<div class="admonition tip">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2019-05-29 06:01:09 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>secondary_ip_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>) Indicates list of secondary IP created for this ENI.</p></li>
<li><p><strong>eni_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>) Interface ID on customer account.</p></li>
<li><p><strong>primary_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>) Indicates primary address of the ENI.</p></li>
2019-05-29 06:01:09 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.DashboardData">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">DashboardData</code><span class="sig-paren">(</span><em class="sig-param">firewall=None</em>, <em class="sig-param">sslvpn=None</em>, <em class="sig-param">interfaces=None</em>, <em class="sig-param">load_balancer=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.DashboardStat">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">DashboardStat</code><span class="sig-paren">(</span><em class="sig-param">timestamp=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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>) </p></li>
<li><p><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>) </p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.DashboardStatistics">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">DashboardStatistics</code><span class="sig-paren">(</span><em class="sig-param">data_dto=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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.</p></li>
<li><p><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.</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.DataPageEdgeSummary">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">DataPageEdgeSummary</code><span class="sig-paren">(</span><em class="sig-param">paging_info=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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>) </p></li>
<li><p><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>) </p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.DataPageSddcNetwork">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">DataPageSddcNetwork</code><span class="sig-paren">(</span><em class="sig-param">paging_info=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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>) </p></li>
<li><p><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>) </p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.DataPermissions">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">DataPermissions</code><span class="sig-paren">(</span><em class="sig-param">save_permission=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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>) </p></li>
<li><p><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>) </p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.DhcpLeaseInfo">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">DhcpLeaseInfo</code><span class="sig-paren">(</span><em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><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.</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.DhcpLeases">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">DhcpLeases</code><span class="sig-paren">(</span><em class="sig-param">time_stamp=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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</p></li>
<li><p><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.</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.DnsConfig">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">DnsConfig</code><span class="sig-paren">(</span><em class="sig-param">feature_type=None</em>, <em class="sig-param">logging=None</em>, <em class="sig-param">enabled=None</em>, <em class="sig-param">dns_views=None</em>, <em class="sig-param">listeners=None</em>, <em class="sig-param">version=None</em>, <em class="sig-param">template=None</em>, <em class="sig-param">cache_size=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>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>) </p></li>
<li><p><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.</p></li>
<li><p><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Value is true if feature is enabled. Default value is true.
Optional.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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
2018-08-07 19:42:25 -04:00
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
2019-06-08 00:29:34 -04:00
not in sync with the latest change. format: int64</p></li>
<li><p><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>) </p></li>
<li><p><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</p></li>
<li><p><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>) </p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.DnsForwarders">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">DnsForwarders</code><span class="sig-paren">(</span><em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><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.</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.DnsListeners">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">DnsListeners</code><span class="sig-paren">(</span><em class="sig-param">ip_address=None</em>, <em class="sig-param">vnic=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.DnsResponseStats">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">DnsResponseStats</code><span class="sig-paren">(</span><em class="sig-param">total=None</em>, <em class="sig-param">form_err=None</em>, <em class="sig-param">nx_domain=None</em>, <em class="sig-param">success=None</em>, <em class="sig-param">server_fail=None</em>, <em class="sig-param">nxrrset=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.DnsStatusAndStats">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">DnsStatusAndStats</code><span class="sig-paren">(</span><em class="sig-param">time_stamp=None</em>, <em class="sig-param">requests=None</em>, <em class="sig-param">responses=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.DnsView">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">DnsView</code><span class="sig-paren">(</span><em class="sig-param">name=None</em>, <em class="sig-param">view_match=None</em>, <em class="sig-param">recursion=None</em>, <em class="sig-param">view_id=None</em>, <em class="sig-param">forwarders=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Name of the DNS view.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) DNS view is enabled.</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.DnsViewMatch">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">DnsViewMatch</code><span class="sig-paren">(</span><em class="sig-param">vnic=None</em>, <em class="sig-param">ip_set=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.DnsViews">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">DnsViews</code><span class="sig-paren">(</span><em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><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.</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
2019-07-04 06:14:34 -04:00
<dl class="class">
<dt id="com.vmware.vmc.model_client.EbsBackedVsanConfig">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">EbsBackedVsanConfig</code><span class="sig-paren">(</span><em class="sig-param">instance_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.EbsBackedVsanConfig" title="Permalink to this definition"></a></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>information for EBS-backed VSAN configuration</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>instance_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>) instance type for EBS-backed VSAN configuration</p>
</dd>
</dl>
</dd></dl>
2018-08-07 19:42:25 -04:00
<dl class="class">
<dt id="com.vmware.vmc.model_client.EdgeJob">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">EdgeJob</code><span class="sig-paren">(</span><em class="sig-param">status=None</em>, <em class="sig-param">edge_id=None</em>, <em class="sig-param">module=None</em>, <em class="sig-param">job_id=None</em>, <em class="sig-param">error_code=None</em>, <em class="sig-param">result=None</em>, <em class="sig-param">start_time=None</em>, <em class="sig-param">message=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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</p></li>
<li><p><strong>message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Job message.</p></li>
<li><p><strong>end_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Job end time. format: date-time</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.EdgeStatus">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">EdgeStatus</code><span class="sig-paren">(</span><em class="sig-param">pre_rules_exists=None</em>, <em class="sig-param">feature_statuses=None</em>, <em class="sig-param">timestamp=None</em>, <em class="sig-param">publish_status=None</em>, <em class="sig-param">last_published_pre_rules_generation_number=None</em>, <em class="sig-param">version=None</em>, <em class="sig-param">edge_vm_status=None</em>, <em class="sig-param">active_vse_ha_index=None</em>, <em class="sig-param">system_status=None</em>, <em class="sig-param">ha_vnic_in_use=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>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.</p></li>
<li><p><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.</p></li>
<li><p><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</p></li>
<li><p><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).</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><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.</p></li>
<li><p><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</p></li>
<li><p><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.</p></li>
<li><p><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</p></li>
<li><p><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
2018-08-07 19:42:25 -04:00
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
2019-06-08 00:29:34 -04:00
RED.</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.EdgeSummary">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">EdgeSummary</code><span class="sig-paren">(</span><em class="sig-param">feature_capabilities=None</em>, <em class="sig-param">edge_type=None</em>, <em class="sig-param">logical_router_scopes=None</em>, <em class="sig-param">recent_job_info=None</em>, <em class="sig-param">hypervisor_assist=None</em>, <em class="sig-param">edge_assist_id=None</em>, <em class="sig-param">edge_status=None</em>, <em class="sig-param">edge_assist_instance_name=None</em>, <em class="sig-param">object_id=None</em>, <em class="sig-param">node_id=None</em>, <em class="sig-param">id=None</em>, <em class="sig-param">datacenter_name=None</em>, <em class="sig-param">state=None</em>, <em class="sig-param">client_handle=None</em>, <em class="sig-param">scope=None</em>, <em class="sig-param">type=None</em>, <em class="sig-param">revision=None</em>, <em class="sig-param">vsm_uuid=None</em>, <em class="sig-param">description=None</em>, <em class="sig-param">extended_attributes=None</em>, <em class="sig-param">local_egress_enabled=None</em>, <em class="sig-param">universal_revision=None</em>, <em class="sig-param">allowed_actions=None</em>, <em class="sig-param">object_type_name=None</em>, <em class="sig-param">is_upgrade_available=None</em>, <em class="sig-param">is_universal=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">lrouter_uuid=None</em>, <em class="sig-param">appliances_summary=None</em>, <em class="sig-param">api_version=None</em>, <em class="sig-param">tenant_id=None</em>, <em class="sig-param">datacenter_moid=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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>) </p></li>
<li><p><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</p></li>
<li><p><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
2018-08-07 19:42:25 -04:00
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
2019-06-08 00:29:34 -04:00
RED.</p></li>
<li><p><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.</p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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
2018-08-07 19:42:25 -04:00
when VMs have been deployed, undeployed when no VMs are deployed
and active when Edge type is Distributed Logical Router and has
2019-06-08 00:29:34 -04:00
no appliance deployed but is serving data path.</p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) </p></li>
<li><p><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>) </p></li>
<li><p><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.</p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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.</p></li>
<li><p><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>) </p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) </p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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</p></li>
</ul>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.EdgeVmStatus">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">EdgeVmStatus</code><span class="sig-paren">(</span><em class="sig-param">index=None</em>, <em class="sig-param">ha_state=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">id=None</em>, <em class="sig-param">edge_vm_status=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>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</p></li>
<li><p><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.</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Name of the NSX Edge appliance.</p></li>
<li><p><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.</p></li>
<li><p><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
2018-08-07 19:42:25 -04:00
status), GREEN (health checks are successful), YELLOW (intermittent
2019-06-08 00:29:34 -04:00
health check failure), RED (appliance not in serving state).</p></li>
<li><p><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</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.EdgeVnicAddressGroup">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">EdgeVnicAddressGroup</code><span class="sig-paren">(</span><em class="sig-param">subnet_prefix_length=None</em>, <em class="sig-param">secondary_addresses=None</em>, <em class="sig-param">primary_address=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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>) </p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.EdgeVnicAddressGroups">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">EdgeVnicAddressGroups</code><span class="sig-paren">(</span><em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2019-05-29 06:01:09 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><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.</p>
</dd>
</dl>
2019-05-29 06:01:09 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.EniInfo">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">EniInfo</code><span class="sig-paren">(</span><em class="sig-param">subnet_id=None</em>, <em class="sig-param">id=None</em>, <em class="sig-param">security_group_id=None</em>, <em class="sig-param">private_ip=None</em>, <em class="sig-param">mac_address=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.EniInfo" title="Permalink to this definition"></a></dt>
2019-05-29 06:01:09 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
2019-07-10 02:17:34 -04:00
<p>Information of the x-eni created.</p>
2019-05-29 06:01:09 -04:00
<div class="admonition tip">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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>) Subnet it belongs to.</p></li>
<li><p><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>) Interface ID.</p></li>
<li><p><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>) Security Group of Eni.</p></li>
<li><p><strong>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>) Private ip of eni.</p></li>
<li><p><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 nic.</p></li>
2019-05-29 06:01:09 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.EntityCapacity">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">EntityCapacity</code><span class="sig-paren">(</span><em class="sig-param">storage_capacity_gib=None</em>, <em class="sig-param">memory_capacity_gib=None</em>, <em class="sig-param">total_number_of_cores=None</em>, <em class="sig-param">number_of_ssds=None</em>, <em class="sig-param">cpu_capacity_ghz=None</em>, <em class="sig-param">number_of_sockets=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.EntityCapacity" title="Permalink to this definition"></a></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>Decribes the capacity of a given entity.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>storage_capacity_gib</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>) </p></li>
<li><p><strong>memory_capacity_gib</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>) </p></li>
<li><p><strong>total_number_of_cores</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>) </p></li>
<li><p><strong>number_of_ssds</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>) </p></li>
<li><p><strong>cpu_capacity_ghz</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>) </p></li>
<li><p><strong>number_of_sockets</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>) </p></li>
</ul>
</dd>
</dl>
</dd></dl>
2018-08-07 19:42:25 -04:00
<dl class="class">
<dt id="com.vmware.vmc.model_client.ErrorResponse">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">ErrorResponse</code><span class="sig-paren">(</span><em class="sig-param">status=None</em>, <em class="sig-param">path=None</em>, <em class="sig-param">retryable=None</em>, <em class="sig-param">error_code=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>status</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) HTTP status code</p></li>
<li><p><strong>path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Originating request URI</p></li>
<li><p><strong>retryable</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) If true, client should retry operation</p></li>
<li><p><strong>error_code</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) unique error code</p></li>
<li><p><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</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.EsxConfig">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">EsxConfig</code><span class="sig-paren">(</span><em class="sig-param">availability_zone=None</em>, <em class="sig-param">esxs=None</em>, <em class="sig-param">cluster_id=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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).</p></li>
<li><p><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>) </p></li>
<li><p><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.</p></li>
<li><p><strong>num_hosts</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) </p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.EsxHost">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">EsxHost</code><span class="sig-paren">(</span><em class="sig-param">name=None</em>, <em class="sig-param">availability_zone=None</em>, <em class="sig-param">esx_id=None</em>, <em class="sig-param">hostname=None</em>, <em class="sig-param">provider='EsxHost'</em>, <em class="sig-param">instance_type=None</em>, <em class="sig-param">mac_address=None</em>, <em class="sig-param">custom_properties=None</em>, <em class="sig-param">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>
2019-06-08 00:29:34 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) </p></li>
<li><p><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.</p></li>
<li><p><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>) </p></li>
<li><p><strong>hostname</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) </p></li>
<li><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) </p></li>
<li><p><strong>instance_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>) Backing cloud provider instance type for host.</p></li>
2019-06-08 00:29:34 -04:00
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>
2018-08-07 19:42:25 -04:00
<ul>
2019-06-08 00:29:34 -04:00
<li><p><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></p></li>
2019-07-10 02:17:34 -04:00
<li><p><a class="reference internal" href="#com.vmware.vmc.model_client.EsxHost.ESX_STATE_INITIALIZING" title="com.vmware.vmc.model_client.EsxHost.ESX_STATE_INITIALIZING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">EsxHost.ESX_STATE_INITIALIZING</span></code></a></p></li>
2019-06-08 00:29:34 -04:00
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
2019-07-10 02:17:34 -04:00
<li><p><a class="reference internal" href="#com.vmware.vmc.model_client.EsxHost.ESX_STATE_ADDING_TO_VCENTER" title="com.vmware.vmc.model_client.EsxHost.ESX_STATE_ADDING_TO_VCENTER"><code class="xref py py-attr docutils literal notranslate"><span class="pre">EsxHost.ESX_STATE_ADDING_TO_VCENTER</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.vmc.model_client.EsxHost.ESX_STATE_DELETING_FROM_VCENTER" title="com.vmware.vmc.model_client.EsxHost.ESX_STATE_DELETING_FROM_VCENTER"><code class="xref py py-attr docutils literal notranslate"><span class="pre">EsxHost.ESX_STATE_DELETING_FROM_VCENTER</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.vmc.model_client.EsxHost.ESX_STATE_PENDING_CLOUD_DELETION" title="com.vmware.vmc.model_client.EsxHost.ESX_STATE_PENDING_CLOUD_DELETION"><code class="xref py py-attr docutils literal notranslate"><span class="pre">EsxHost.ESX_STATE_PENDING_CLOUD_DELETION</span></code></a></p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2019-07-10 02:17:34 -04:00
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.EsxHost.ESX_STATE_ADDING_TO_VCENTER">
<code class="sig-name descname">ESX_STATE_ADDING_TO_VCENTER</code><em class="property"> = 'ADDING_TO_VCENTER'</em><a class="headerlink" href="#com.vmware.vmc.model_client.EsxHost.ESX_STATE_ADDING_TO_VCENTER" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
2018-08-07 19:42:25 -04:00
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.EsxHost.ESX_STATE_DELETED">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.EsxHost.ESX_STATE_DELETING">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
2019-07-10 02:17:34 -04:00
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.EsxHost.ESX_STATE_DELETING_FROM_VCENTER">
<code class="sig-name descname">ESX_STATE_DELETING_FROM_VCENTER</code><em class="property"> = 'DELETING_FROM_VCENTER'</em><a class="headerlink" href="#com.vmware.vmc.model_client.EsxHost.ESX_STATE_DELETING_FROM_VCENTER" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
2018-08-07 19:42:25 -04:00
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.EsxHost.ESX_STATE_DEPLOYING">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.EsxHost.ESX_STATE_FAILED">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
2019-07-10 02:17:34 -04:00
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.EsxHost.ESX_STATE_INITIALIZING">
<code class="sig-name descname">ESX_STATE_INITIALIZING</code><em class="property"> = 'INITIALIZING'</em><a class="headerlink" href="#com.vmware.vmc.model_client.EsxHost.ESX_STATE_INITIALIZING" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.EsxHost.ESX_STATE_PENDING_CLOUD_DELETION">
<code class="sig-name descname">ESX_STATE_PENDING_CLOUD_DELETION</code><em class="property"> = 'PENDING_CLOUD_DELETION'</em><a class="headerlink" href="#com.vmware.vmc.model_client.EsxHost.ESX_STATE_PENDING_CLOUD_DELETION" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
2018-08-07 19:42:25 -04:00
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.EsxHost.ESX_STATE_PROVISIONED">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.EsxHost.ESX_STATE_READY">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
2019-06-08 00:29:34 -04:00
<dl class="method">
2019-05-29 06:01:09 -04:00
<dt id="com.vmware.vmc.model_client.EsxHost.provider">
2019-06-08 00:29:34 -04:00
<em class="property">property </em><code class="sig-name descname">provider</code><a class="headerlink" href="#com.vmware.vmc.model_client.EsxHost.provider" title="Permalink to this definition"></a></dt>
2019-05-29 06:01:09 -04:00
<dd><p>Return the discriminator value</p>
</dd></dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.EsxHostInfo">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">EsxHostInfo</code><span class="sig-paren">(</span><em class="sig-param">instance_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.EsxHostInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>instance_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>) Backing cloud provider instance type for cluster.</p>
</dd>
</dl>
</dd></dl>
2018-08-07 19:42:25 -04:00
<dl class="class">
<dt id="com.vmware.vmc.model_client.ExtendedAttribute">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">ExtendedAttribute</code><span class="sig-paren">(</span><em class="sig-param">name=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) </p></li>
<li><p><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>) </p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.FeatureCapabilities">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">FeatureCapabilities</code><span class="sig-paren">(</span><em class="sig-param">timestamp=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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</p></li>
<li><p><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.</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.FeatureCapability">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">FeatureCapability</code><span class="sig-paren">(</span><em class="sig-param">configuration_limits=None</em>, <em class="sig-param">is_supported=None</em>, <em class="sig-param">service=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.FeatureStatus">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">FeatureStatus</code><span class="sig-paren">(</span><em class="sig-param">status=None</em>, <em class="sig-param">configured=None</em>, <em class="sig-param">server_status=None</em>, <em class="sig-param">publish_status=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.FirewallConfig">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">FirewallConfig</code><span class="sig-paren">(</span><em class="sig-param">firewall_rules=None</em>, <em class="sig-param">feature_type=None</em>, <em class="sig-param">version=None</em>, <em class="sig-param">template=None</em>, <em class="sig-param">global_config=None</em>, <em class="sig-param">enabled=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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.</p></li>
<li><p><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>) </p></li>
<li><p><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
2018-08-07 19:42:25 -04:00
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
2019-06-08 00:29:34 -04:00
not in sync with the latest change. format: int64</p></li>
<li><p><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>) </p></li>
<li><p><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.</p></li>
<li><p><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Value is true if feature is enabled. Default value is true.
Optional.</p></li>
<li><p><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.</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.FirewallDashboardStats">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">FirewallDashboardStats</code><span class="sig-paren">(</span><em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><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.</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.FirewallDefaultPolicy">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">FirewallDefaultPolicy</code><span class="sig-paren">(</span><em class="sig-param">action=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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</p></li>
<li><p><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.</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.FirewallGlobalConfig">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">FirewallGlobalConfig</code><span class="sig-paren">(</span><em class="sig-param">tcp_allow_out_of_window_packets=None</em>, <em class="sig-param">udp_timeout=None</em>, <em class="sig-param">ip_generic_timeout=None</em>, <em class="sig-param">tcp_pick_ongoing_connections=None</em>, <em class="sig-param">tcp_timeout_open=None</em>, <em class="sig-param">tcp_timeout_close=None</em>, <em class="sig-param">icmp6_timeout=None</em>, <em class="sig-param">drop_icmp_replays=None</em>, <em class="sig-param">log_icmp_errors=None</em>, <em class="sig-param">tcp_send_reset_for_closed_vse_ports=None</em>, <em class="sig-param">drop_invalid_traffic=None</em>, <em class="sig-param">enable_syn_flood_protection=None</em>, <em class="sig-param">icmp_timeout=None</em>, <em class="sig-param">tcp_timeout_established=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>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.</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><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.</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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
2018-08-07 19:42:25 -04:00
connections and terminating them without consuming firewall state
2019-06-08 00:29:34 -04:00
tracking resources. Default : false</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><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.</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.FirewallRule">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">FirewallRule</code><span class="sig-paren">(</span><em class="sig-param">rule_type=None</em>, <em class="sig-param">application_ids=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">rule_interface=None</em>, <em class="sig-param">destination=None</em>, <em class="sig-param">id=None</em>, <em class="sig-param">destination_scope=None</em>, <em class="sig-param">source=None</em>, <em class="sig-param">source_scope=None</em>, <em class="sig-param">services=None</em>, <em class="sig-param">action=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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>
2018-08-07 19:42:25 -04:00
<ul>
2019-06-08 00:29:34 -04:00
<li><p><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></p></li>
<li><p><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></p></li>
</ul>
</p></li>
<li><p><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>) </p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) </p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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></li>
<li><p><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>) </p></li>
<li><p><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.</p></li>
<li><p><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>) </p></li>
<li><p><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</p></li>
<li><p><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>
2018-08-07 19:42:25 -04:00
<ul>
2019-06-08 00:29:34 -04:00
<li><p><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></p></li>
<li><p><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></p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</p></li>
<li><p><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
2018-08-07 19:42:25 -04:00
against concurrent modification (first writer wins) format: int32
This attribute may be present in responses from the server, but if
2019-06-08 00:29:34 -04:00
it is present in a request to server it will be ignored.</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.FirewallRule.ACTION_ALLOW">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.FirewallRule.ACTION_DENY">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.FirewallRule.RULE_TYPE_DEFAULT">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.FirewallRule.RULE_TYPE_USER">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.FirewallRuleScope">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">FirewallRuleScope</code><span class="sig-paren">(</span><em class="sig-param">grouping_object_ids=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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>) </p></li>
<li><p><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>
2018-08-07 19:42:25 -04:00
<ul>
2019-06-08 00:29:34 -04:00
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
</ul>
</p></li>
</ul>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_EXTERNAL">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_INTERNAL">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_0">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_1">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_2">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_3">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_4">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_5">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_6">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_7">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_8">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_9">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VSE">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.FirewallRuleStats">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">FirewallRuleStats</code><span class="sig-paren">(</span><em class="sig-param">timestamp=None</em>, <em class="sig-param">connection_count=None</em>, <em class="sig-param">byte_count=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.FirewallRules">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">FirewallRules</code><span class="sig-paren">(</span><em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><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.</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.FirewallService">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">FirewallService</code><span class="sig-paren">(</span><em class="sig-param">protocol=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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.</p></li>
<li><p><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.</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.GatewayTemplate">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">GatewayTemplate</code><span class="sig-paren">(</span><em class="sig-param">public_ip=None</em>, <em class="sig-param">primary_dns=None</em>, <em class="sig-param">secondary_dns=None</em>, <em class="sig-param">firewall_rules=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.GlcmBundle">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">GlcmBundle</code><span class="sig-paren">(</span><em class="sig-param">s3_bucket=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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 glcmbundles s3 bucket</p></li>
<li><p><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 glcmbundles id</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.HostInstanceTypes">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">HostInstanceTypes</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.HostInstanceTypes" title="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="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <a class="reference internal" href="#com.vmware.vmc.model_client.HostInstanceTypes" title="com.vmware.vmc.model_client.HostInstanceTypes"><code class="xref py py-class docutils literal notranslate"><span class="pre">HostInstanceTypes</span></code></a> instance.</p>
</dd>
</dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.HostInstanceTypes.I3EN_METAL">
<code class="sig-name descname">I3EN_METAL</code><em class="property"> = HostInstanceTypes(string='I3EN_METAL')</em><a class="headerlink" href="#com.vmware.vmc.model_client.HostInstanceTypes.I3EN_METAL" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.HostInstanceTypes.I3_METAL">
<code class="sig-name descname">I3_METAL</code><em class="property"> = HostInstanceTypes(string='I3_METAL')</em><a class="headerlink" href="#com.vmware.vmc.model_client.HostInstanceTypes.I3_METAL" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.HostInstanceTypes.R5_METAL">
<code class="sig-name descname">R5_METAL</code><em class="property"> = HostInstanceTypes(string='R5_METAL')</em><a class="headerlink" href="#com.vmware.vmc.model_client.HostInstanceTypes.R5_METAL" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
2018-08-07 19:42:25 -04:00
<dl class="class">
<dt id="com.vmware.vmc.model_client.HostLeaseInfo">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">HostLeaseInfo</code><span class="sig-paren">(</span><em class="sig-param">mac_address=None</em>, <em class="sig-param">ends=None</em>, <em class="sig-param">abandoned=None</em>, <em class="sig-param">cltt=None</em>, <em class="sig-param">client_hostname=None</em>, <em class="sig-param">starts=None</em>, <em class="sig-param">binding_state=None</em>, <em class="sig-param">hardware_type=None</em>, <em class="sig-param">tsfp=None</em>, <em class="sig-param">uid=None</em>, <em class="sig-param">next_binding_state=None</em>, <em class="sig-param">ip_address=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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>) Leases binding state.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
</ul>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.HostProvisionSpec">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">HostProvisionSpec</code><span class="sig-paren">(</span><em class="sig-param">additional_host_specs=None</em>, <em class="sig-param">instance_provisioning_error_cause=None</em>, <em class="sig-param">entity_capacity=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.HostProvisionSpec" title="Permalink to this definition"></a></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>Represents a provisioning spec for an add host operation in the given sddc.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>additional_host_specs</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.AdditionalHostSpec" title="com.vmware.vmc.model_client.AdditionalHostSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">AdditionalHostSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) </p></li>
<li><p><strong>instance_provisioning_error_cause</strong> (<code class="xref 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 due to which instance provisioning is restricted on the
cluster.</p></li>
<li><p><strong>entity_capacity</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.EntityCapacity" title="com.vmware.vmc.model_client.EntityCapacity"><code class="xref py py-class docutils literal notranslate"><span class="pre">EntityCapacity</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The capacity of the given host.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.InstanceTypeConfig">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">InstanceTypeConfig</code><span class="sig-paren">(</span><em class="sig-param">instance_type=None</em>, <em class="sig-param">hosts=None</em>, <em class="sig-param">display_name=None</em>, <em class="sig-param">entity_capacity=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.InstanceTypeConfig" title="Permalink to this definition"></a></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>Represents a structure for instance type config</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>instance_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>) Instance type name.</p></li>
<li><p><strong>hosts</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> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Array of number of hosts allowed for this operation. Range of hosts
user can select for sddc provision</p></li>
<li><p><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>) Display name of instance_type.</p></li>
<li><p><strong>entity_capacity</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.EntityCapacity" title="com.vmware.vmc.model_client.EntityCapacity"><code class="xref py py-class docutils literal notranslate"><span class="pre">EntityCapacity</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The capacity of the given instance type.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.InstanceTypeConfigForCluster">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">InstanceTypeConfigForCluster</code><span class="sig-paren">(</span><em class="sig-param">instance_type=None</em>, <em class="sig-param">display_name=None</em>, <em class="sig-param">instance_provisioning_error_cause=None</em>, <em class="sig-param">hosts=None</em>, <em class="sig-param">entity_capacity=None</em>, <em class="sig-param">cpu_cores=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.InstanceTypeConfigForCluster" title="Permalink to this definition"></a></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>Represents a structure for instance type config</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>instance_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>) Instance type name.</p></li>
<li><p><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>) Display name of instance_type.</p></li>
<li><p><strong>instance_provisioning_error_cause</strong> (<code class="xref 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 due to which instance provisioning is restricted on the
cluster.</p></li>
<li><p><strong>hosts</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> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Array of number of hosts allowed for this operation. Range of hosts
user can select for sddc provision</p></li>
<li><p><strong>entity_capacity</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.EntityCapacity" title="com.vmware.vmc.model_client.EntityCapacity"><code class="xref py py-class docutils literal notranslate"><span class="pre">EntityCapacity</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The capacity of the given entity.</p></li>
<li><p><strong>cpu_cores</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> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Array of valid cpu cores values for the given instance type. Range
of cpu cores user can select for new cluster.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
2018-08-07 19:42:25 -04:00
<dl class="class">
<dt id="com.vmware.vmc.model_client.InteractionPermissions">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">InteractionPermissions</code><span class="sig-paren">(</span><em class="sig-param">manage_permission=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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>) </p></li>
<li><p><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>) </p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.InterfacesDashboardStats">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">InterfacesDashboardStats</code><span class="sig-paren">(</span><em class="sig-param">vnic7_in_pkt=None</em>, <em class="sig-param">vnic0_in_byte=None</em>, <em class="sig-param">vnic8_out_pkt=None</em>, <em class="sig-param">vnic5_in_byte=None</em>, <em class="sig-param">vnic2_in_pkt=None</em>, <em class="sig-param">vnic3_in_pkt=None</em>, <em class="sig-param">vnic6_out_byte=None</em>, <em class="sig-param">vnic3_in_byte=None</em>, <em class="sig-param">vnic8_in_pkt=None</em>, <em class="sig-param">vnic1_in_byte=None</em>, <em class="sig-param">vnic1_out_pkt=None</em>, <em class="sig-param">vnic5_out_byte=None</em>, <em class="sig-param">vnic0_out_pkt=None</em>, <em class="sig-param">vnic0_out_byte=None</em>, <em class="sig-param">vnic6_out_pkt=None</em>, <em class="sig-param">vnic3_out_byte=None</em>, <em class="sig-param">vnic7_in_byte=None</em>, <em class="sig-param">vnic1_out_byte=None</em>, <em class="sig-param">vnic9_out_pkt=None</em>, <em class="sig-param">vnic9_in_pkt=None</em>, <em class="sig-param">vnic4_in_byte=None</em>, <em class="sig-param">vnic5_out_pkt=None</em>, <em class="sig-param">vnic2_out_pkt=None</em>, <em class="sig-param">vnic2_in_byte=None</em>, <em class="sig-param">vnic5_in_pkt=None</em>, <em class="sig-param">vnic7_out_pkt=None</em>, <em class="sig-param">vnic3_out_pkt=None</em>, <em class="sig-param">vnic4_out_pkt=None</em>, <em class="sig-param">vnic4_out_byte=None</em>, <em class="sig-param">vnic1_in_pkt=None</em>, <em class="sig-param">vnic2_out_byte=None</em>, <em class="sig-param">vnic6_in_byte=None</em>, <em class="sig-param">vnic0_in_pkt=None</em>, <em class="sig-param">vnic9_in_byte=None</em>, <em class="sig-param">vnic7_out_byte=None</em>, <em class="sig-param">vnic4_in_pkt=None</em>, <em class="sig-param">vnic9_out_byte=None</em>, <em class="sig-param">vnic8_out_byte=None</em>, <em class="sig-param">vnic8_in_byte=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
</ul>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.IpAddresses">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">IpAddresses</code><span class="sig-paren">(</span><em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><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.</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.Ipsec">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">Ipsec</code><span class="sig-paren">(</span><em class="sig-param">feature_type=None</em>, <em class="sig-param">logging=None</em>, <em class="sig-param">global_=None</em>, <em class="sig-param">enabled=None</em>, <em class="sig-param">sites=None</em>, <em class="sig-param">disable_event=None</em>, <em class="sig-param">version=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>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>) </p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Value is true if feature is enabled. Default value is true.
Optional.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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
2018-08-07 19:42:25 -04:00
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
2019-06-08 00:29:34 -04:00
not in sync with the latest change. format: int64</p></li>
<li><p><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>) </p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.IpsecDashboardStats">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">IpsecDashboardStats</code><span class="sig-paren">(</span><em class="sig-param">ipsec_bytes_out=None</em>, <em class="sig-param">ipsec_bytes_in=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.IpsecGlobalConfig">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">IpsecGlobalConfig</code><span class="sig-paren">(</span><em class="sig-param">psk=None</em>, <em class="sig-param">ca_certificates=None</em>, <em class="sig-param">service_certificate=None</em>, <em class="sig-param">crl_certificates=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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
2018-08-07 19:42:25 -04:00
when peerIp is configured as any in NSX Edge IPsec Site
2019-06-08 00:29:34 -04:00
configuration.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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>) </p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.IpsecSite">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">IpsecSite</code><span class="sig-paren">(</span><em class="sig-param">psk=None</em>, <em class="sig-param">local_id=None</em>, <em class="sig-param">enable_pfs=None</em>, <em class="sig-param">authentication_mode=None</em>, <em class="sig-param">peer_subnets=None</em>, <em class="sig-param">dh_group=None</em>, <em class="sig-param">site_id=None</em>, <em class="sig-param">description=None</em>, <em class="sig-param">peer_ip=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">certificate=None</em>, <em class="sig-param">local_ip=None</em>, <em class="sig-param">encryption_algorithm=None</em>, <em class="sig-param">enabled=None</em>, <em class="sig-param">mtu=None</em>, <em class="sig-param">extension=None</em>, <em class="sig-param">peer_id=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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
2018-08-07 19:42:25 -04:00
any. Global PSK is used when Authentication mode is PSK and Site
2019-06-08 00:29:34 -04:00
peerIp is any.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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
2018-08-07 19:42:25 -04:00
NSX Edge. DH2 and DH5 are not supported when FIPS is enabled on NSX
2019-06-08 00:29:34 -04:00
Edge. Valid values are DH2, DH5, DH14, DH15, DH16.</p></li>
<li><p><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.</p></li>
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Description of the IPsec Site.</p></li>
<li><p><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.</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Name of the IPsec Site.</p></li>
<li><p><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>) </p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Enable/disable IPsec Site.</p></li>
<li><p><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</p></li>
<li><p><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>) </p></li>
<li><p><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 Sites configured for an
NSX Edge.</p></li>
<li><p><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.</p></li>
</ul>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.IpsecSiteIKEStatus">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">IpsecSiteIKEStatus</code><span class="sig-paren">(</span><em class="sig-param">channel_status=None</em>, <em class="sig-param">channel_state=None</em>, <em class="sig-param">peer_ip_address=None</em>, <em class="sig-param">local_ip_address=None</em>, <em class="sig-param">peer_subnets=None</em>, <em class="sig-param">peer_id=None</em>, <em class="sig-param">last_informational_message=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.IpsecSiteStats">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">IpsecSiteStats</code><span class="sig-paren">(</span><em class="sig-param">rx_bytes_on_site=None</em>, <em class="sig-param">tunnel_stats=None</em>, <em class="sig-param">ike_status=None</em>, <em class="sig-param">site_status=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.IpsecSites">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">IpsecSites</code><span class="sig-paren">(</span><em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><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>) </p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.IpsecStatusAndStats">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">IpsecStatusAndStats</code><span class="sig-paren">(</span><em class="sig-param">time_stamp=None</em>, <em class="sig-param">server_status=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.IpsecTunnelStats">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">IpsecTunnelStats</code><span class="sig-paren">(</span><em class="sig-param">tunnel_status=None</em>, <em class="sig-param">peer_spi=None</em>, <em class="sig-param">rx_bytes_on_local_subnet=None</em>, <em class="sig-param">established_date=None</em>, <em class="sig-param">peer_subnet=None</em>, <em class="sig-param">authentication_algorithm=None</em>, <em class="sig-param">tunnel_state=None</em>, <em class="sig-param">tx_bytes_from_local_subnet=None</em>, <em class="sig-param">last_informational_message=None</em>, <em class="sig-param">local_spi=None</em>, <em class="sig-param">encryption_algorithm=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.KeyValueAttributes">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">KeyValueAttributes</code><span class="sig-paren">(</span><em class="sig-param">value=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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.</p></li>
<li><p><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.</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.KmsVpcEndpoint">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">KmsVpcEndpoint</code><span class="sig-paren">(</span><em class="sig-param">vpc_endpoint_id=None</em>, <em class="sig-param">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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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</p></li>
<li><p><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>) </p></li>
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
</dd></dl>
2018-08-07 19:42:25 -04:00
<dl class="class">
<dt id="com.vmware.vmc.model_client.L2Extension">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">L2Extension</code><span class="sig-paren">(</span><em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><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</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.L2Vpn">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">L2Vpn</code><span class="sig-paren">(</span><em class="sig-param">enabled=None</em>, <em class="sig-param">sites=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Enable (true) or disable (false) L2 VPN.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.L2vpnStats">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">L2vpnStats</code><span class="sig-paren">(</span><em class="sig-param">tunnel_status=None</em>, <em class="sig-param">established_date=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">dropped_rx_packets=None</em>, <em class="sig-param">encryption_algorithm=None</em>, <em class="sig-param">failure_message=None</em>, <em class="sig-param">tx_bytes_from_local_subnet=None</em>, <em class="sig-param">rx_bytes_on_local_subnet=None</em>, <em class="sig-param">dropped_tx_packets=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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).</p></li>
<li><p><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</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) User defined name of the site.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.L2vpnStatusAndStats">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">L2vpnStatusAndStats</code><span class="sig-paren">(</span><em class="sig-param">time_stamp=None</em>, <em class="sig-param">server_status=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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</p></li>
<li><p><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>) </p></li>
<li><p><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.</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.LicenceAclPermissions">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">LicenceAclPermissions</code><span class="sig-paren">(</span><em class="sig-param">data_permission=None</em>, <em class="sig-param">is_licensed=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.LoadBalancerDashboardStats">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">LoadBalancerDashboardStats</code><span class="sig-paren">(</span><em class="sig-param">lb_bps_in=None</em>, <em class="sig-param">lb_http_reqs=None</em>, <em class="sig-param">lb_bps_out=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.Logging">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">Logging</code><span class="sig-paren">(</span><em class="sig-param">log_level=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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.</p></li>
<li><p><strong>enable</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Logging enabled.</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.LogicalNetwork">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">LogicalNetwork</code><span class="sig-paren">(</span><em class="sig-param">subnet_cidr=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">gateway_ip=None</em>, <em class="sig-param">dhcp_enabled=None</em>, <em class="sig-param">dhcp_ip_range=None</em>, <em class="sig-param">tunnel_id=None</em>, <em class="sig-param">id=None</em>, <em class="sig-param">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="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>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</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) name of the network</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><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)</p></li>
<li><p><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</p></li>
<li><p><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></li>
<li><p><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>
2018-08-07 19:42:25 -04:00
<ul>
2019-06-08 00:29:34 -04:00
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.LogicalNetwork.NETWORK_TYPE_EXTENDED">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.LogicalNetwork.NETWORK_TYPE_HOSTED">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.LogicalNetwork.NETWORK_TYPE_ROUTED">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.LogicalRouterScope">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">LogicalRouterScope</code><span class="sig-paren">(</span><em class="sig-param">type=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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></li>
<li><p><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></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.LogicalRouterScopes">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">LogicalRouterScopes</code><span class="sig-paren">(</span><em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><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>) </p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.MacAddress">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">MacAddress</code><span class="sig-paren">(</span><em class="sig-param">edge_vm_ha_index=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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>) </p></li>
<li><p><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>) </p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.MaintenanceWindow">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">MaintenanceWindow</code><span class="sig-paren">(</span><em class="sig-param">day_of_week=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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>
2019-06-08 00:29:34 -04:00
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
</ul>
2019-06-08 00:29:34 -04:00
</p></li>
<li><p><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>) </p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.MaintenanceWindow.DAY_OF_WEEK_FRIDAY">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.MaintenanceWindowEntry">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">MaintenanceWindowEntry</code><span class="sig-paren">(</span><em class="sig-param">in_maintenance_window=None</em>, <em class="sig-param">reservation_schedule=None</em>, <em class="sig-param">reservation_id=None</em>, <em class="sig-param">in_maintenance_mode=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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</p></li>
<li><p><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>) </p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.MaintenanceWindowGet">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">MaintenanceWindowGet</code><span class="sig-paren">(</span><em class="sig-param">day_of_week=None</em>, <em class="sig-param">hour_of_day=None</em>, <em class="sig-param">duration_min=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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>
2019-06-08 00:29:34 -04:00
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
</ul>
</p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
</ul>
</dd>
</dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.MaintenanceWindowGet.DAY_OF_WEEK_FRIDAY">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.ManagementGatewayTemplate">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">ManagementGatewayTemplate</code><span class="sig-paren">(</span><em class="sig-param">public_ip=None</em>, <em class="sig-param">primary_dns=None</em>, <em class="sig-param">secondary_dns=None</em>, <em class="sig-param">firewall_rules=None</em>, <em class="sig-param">vpns=None</em>, <em class="sig-param">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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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</p></li>
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.MapZonesRequest">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">MapZonesRequest</code><span class="sig-paren">(</span><em class="sig-param">connected_account_id=None</em>, <em class="sig-param">org_id=None</em>, <em class="sig-param">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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.MetaDashboardStats">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">MetaDashboardStats</code><span class="sig-paren">(</span><em class="sig-param">vnics=None</em>, <em class="sig-param">end_time=None</em>, <em class="sig-param">start_time=None</em>, <em class="sig-param">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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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.</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.Metadata">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">Metadata</code><span class="sig-paren">(</span><em class="sig-param">timestamp=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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</p></li>
<li><p><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</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.Nat">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">Nat</code><span class="sig-paren">(</span><em class="sig-param">rules=None</em>, <em class="sig-param">feature_type=None</em>, <em class="sig-param">version=None</em>, <em class="sig-param">enabled=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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.</p></li>
<li><p><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>) </p></li>
<li><p><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
2018-08-07 19:42:25 -04:00
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
2019-06-08 00:29:34 -04:00
not in sync with the latest change. format: int64</p></li>
<li><p><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Value is true if feature is enabled. Default value is true.
Optional.</p></li>
<li><p><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>) </p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.NatRule">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">NatRule</code><span class="sig-paren">(</span><em class="sig-param">rule_type=None</em>, <em class="sig-param">protocol=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">internal_ports=None</em>, <em class="sig-param">public_ports=None</em>, <em class="sig-param">public_ip=None</em>, <em class="sig-param">internal_ip=None</em>, <em class="sig-param">action=None</em>, <em class="sig-param">id=None</em>, <em class="sig-param">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="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>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></li>
<li><p><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>) </p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>
2018-08-07 19:42:25 -04:00
<ul>
2019-06-08 00:29:34 -04:00
<li><p><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></p></li>
<li><p><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></p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</p></li>
<li><p><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></li>
<li><p><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
2018-08-07 19:42:25 -04:00
concurrent modification (first writer wins) format: int32
This attribute may be present in responses from the server, but if
2019-06-08 00:29:34 -04:00
it is present in a request to server it will be ignored.</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.NatRule.ACTION_DNAT">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.NatRule.ACTION_SNAT">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.NatRules">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">NatRules</code><span class="sig-paren">(</span><em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><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.</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.NetworkTemplate">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">NetworkTemplate</code><span class="sig-paren">(</span><em class="sig-param">management_gateway_templates=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2019-05-29 06:01:09 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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>) </p></li>
<li><p><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>) </p></li>
2019-05-29 06:01:09 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2019-05-29 06:01:09 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.NewCredentials">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">NewCredentials</code><span class="sig-paren">(</span><em class="sig-param">username=None</em>, <em class="sig-param">password=None</em>, <em class="sig-param">name=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.NewCredentials" title="Permalink to this definition"></a></dt>
2019-05-29 06:01:09 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>username</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Username of the credentials</p></li>
<li><p><strong>password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Password associated with the credentials</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Name of the credentials</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.Nsxfirewallrule">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">Nsxfirewallrule</code><span class="sig-paren">(</span><em class="sig-param">rule_type=None</em>, <em class="sig-param">description=None</em>, <em class="sig-param">rule_id=None</em>, <em class="sig-param">match_translated=None</em>, <em class="sig-param">invalid_application=None</em>, <em class="sig-param">direction=None</em>, <em class="sig-param">statistics=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">invalid_source=None</em>, <em class="sig-param">logging_enabled=None</em>, <em class="sig-param">destination=None</em>, <em class="sig-param">enabled=None</em>, <em class="sig-param">application=None</em>, <em class="sig-param">source=None</em>, <em class="sig-param">action=None</em>, <em class="sig-param">invalid_destination=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>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.</p></li>
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Description for the rule</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><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>) </p></li>
<li><p><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.</p></li>
<li><p><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</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Name for the rule.</p></li>
<li><p><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>) </p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Enable rule.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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</p></li>
<li><p><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>) </p></li>
<li><p><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</p></li>
</ul>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.Nsxfirewallservice">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">Nsxfirewallservice</code><span class="sig-paren">(</span><em class="sig-param">source_port=None</em>, <em class="sig-param">protocol=None</em>, <em class="sig-param">port=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.Nsxl2vpn">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">Nsxl2vpn</code><span class="sig-paren">(</span><em class="sig-param">listener_ips=None</em>, <em class="sig-param">enabled=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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.</p></li>
<li><p><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Enabled state of L2 VPN service.</p></li>
<li><p><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.</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.Nsxnatrule">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">Nsxnatrule</code><span class="sig-paren">(</span><em class="sig-param">vnic=None</em>, <em class="sig-param">rule_type=None</em>, <em class="sig-param">protocol=None</em>, <em class="sig-param">description=None</em>, <em class="sig-param">rule_id=None</em>, <em class="sig-param">snat_match_destination_port=None</em>, <em class="sig-param">original_address=None</em>, <em class="sig-param">dnat_match_source_address=None</em>, <em class="sig-param">dnat_match_source_port=None</em>, <em class="sig-param">snat_match_destination_address=None</em>, <em class="sig-param">original_port=None</em>, <em class="sig-param">logging_enabled=None</em>, <em class="sig-param">translated_address=None</em>, <em class="sig-param">enabled=None</em>, <em class="sig-param">icmp_type=None</em>, <em class="sig-param">translated_port=None</em>, <em class="sig-param">action=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>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.</p></li>
<li><p><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.</p></li>
<li><p><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</p></li>
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Description for the rule.</p></li>
<li><p><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</p></li>
<li><p><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.</p></li>
<li><p><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
2018-08-07 19:42:25 -04:00
address for SNAT rules and the original destination address for
2019-06-08 00:29:34 -04:00
DNAT rules.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Enable rule.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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</p></li>
</ul>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.Nsxsite">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">Nsxsite</code><span class="sig-paren">(</span><em class="sig-param">secure_traffic=None</em>, <em class="sig-param">site_id=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">password=None</em>, <em class="sig-param">user_id=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Name of L2 VPN site. Length: 1-255 characters.</p></li>
<li><p><strong>password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Password for L2 VPN user. Passwords must contain the following:
2018-08-07 19:42:25 -04:00
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
2019-06-08 00:29:34 -04:00
more times.</p></li>
<li><p><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.</p></li>
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Description of L2 VPN site.</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2019-05-29 06:01:09 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.NsxtAddons">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">NsxtAddons</code><span class="sig-paren">(</span><em class="sig-param">enable_nsx_advanced_addon=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.NsxtAddons" title="Permalink to this definition"></a></dt>
2019-05-29 06:01:09 -04:00
<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 the state of different NSX add-ons.</p>
<div class="admonition tip">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2019-05-29 06:01:09 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>enable_nsx_advanced_addon</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>) Indicates whether NSX Advanced addon is enabled or disabled.</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.ObjectType">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">ObjectType</code><span class="sig-paren">(</span><em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) </p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.OfferInstancesHolder">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">OfferInstancesHolder</code><span class="sig-paren">(</span><em class="sig-param">on_demand=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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>) </p></li>
<li><p><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>) </p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.OfferType">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">OfferType</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.OfferType" title="Permalink to this definition"></a></dt>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
2018-08-07 19:42:25 -04:00
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>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <a class="reference internal" href="#com.vmware.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.</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.OfferType.ON_DEMAND">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.OfferType.TERM">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.OnDemandOfferInstance">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">OnDemandOfferInstance</code><span class="sig-paren">(</span><em class="sig-param">product=None</em>, <em class="sig-param">product_type=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">currency=None</em>, <em class="sig-param">region=None</em>, <em class="sig-param">unit_price=None</em>, <em class="sig-param">monthly_cost=None</em>, <em class="sig-param">version=None</em>, <em class="sig-param">type=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>product</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) </p></li>
<li><p><strong>product_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>) Deprecated. Please use product and type fields instead.</p></li>
2019-06-08 00:29:34 -04:00
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) </p></li>
<li><p><strong>currency</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) </p></li>
<li><p><strong>region</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) </p></li>
<li><p><strong>unit_price</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) </p></li>
<li><p><strong>monthly_cost</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) </p></li>
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) </p></li>
<li><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) </p></li>
2019-06-08 00:29:34 -04:00
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) </p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.OrgProperties">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">OrgProperties</code><span class="sig-paren">(</span><em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><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.</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.Organization">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">Organization</code><span class="sig-paren">(</span><em class="sig-param">updated=None</em>, <em class="sig-param">user_id=None</em>, <em class="sig-param">updated_by_user_id=None</em>, <em class="sig-param">created=None</em>, <em class="sig-param">version=None</em>, <em class="sig-param">updated_by_user_name=None</em>, <em class="sig-param">user_name=None</em>, <em class="sig-param">id=None</em>, <em class="sig-param">org_type=None</em>, <em class="sig-param">display_name=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">project_state=None</em>, <em class="sig-param">properties=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="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>updated</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) </p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><strong>created</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) </p></li>
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) Version of this entity format: int32</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Unique ID for this entity</p></li>
<li><p><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</p></li>
<li><p><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>) </p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) </p></li>
<li><p><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>
2018-08-07 19:42:25 -04:00
<ul>
2019-06-08 00:29:34 -04:00
<li><p><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></p></li>
<li><p><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></p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</p></li>
<li><p><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>) </p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Organization.PROJECT_STATE_CREATED">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Organization.PROJECT_STATE_DELETED">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.PagedEdgeList">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">PagedEdgeList</code><span class="sig-paren">(</span><em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><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.</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.PagingInfo">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">PagingInfo</code><span class="sig-paren">(</span><em class="sig-param">sort_order_ascending=None</em>, <em class="sig-param">total_count=None</em>, <em class="sig-param">start_index=None</em>, <em class="sig-param">sort_by=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2019-05-29 06:01:09 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.PaymentMethodInfo">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">PaymentMethodInfo</code><span class="sig-paren">(</span><em class="sig-param">_default=None</em>, <em class="sig-param">type=None</em>, <em class="sig-param">payment_method_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.PaymentMethodInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>_default</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) </p></li>
<li><p><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></li>
<li><p><strong>payment_method_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></li>
</ul>
</dd>
</dl>
</dd></dl>
2019-05-29 06:01:09 -04:00
<dl class="class">
<dt id="com.vmware.vmc.model_client.PopAgentXeniConnection">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">PopAgentXeniConnection</code><span class="sig-paren">(</span><em class="sig-param">default_subnet_route=None</em>, <em class="sig-param">eni_info=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.PopAgentXeniConnection" title="Permalink to this definition"></a></dt>
2019-05-29 06:01:09 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2019-05-29 06:01:09 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>default_subnet_route</strong> (<code class="xref 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 gateway route ip fo the subnet.</p></li>
2019-07-10 02:17:34 -04:00
<li><p><strong>eni_info</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.EniInfo" title="com.vmware.vmc.model_client.EniInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">EniInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) </p></li>
2019-05-29 06:01:09 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.PopAmiInfo">
2019-07-04 06:14:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">PopAmiInfo</code><span class="sig-paren">(</span><em class="sig-param">instance_type=None</em>, <em class="sig-param">region=None</em>, <em class="sig-param">id=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
2019-07-04 06:14:34 -04:00
<li><p><strong>instance_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>) instance type of the esx ami</p></li>
2019-06-08 00:29:34 -04:00
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) the name of the esx ami</p></li>
<li><p><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>
2018-08-07 19:42:25 -04:00
<ul>
2019-06-08 00:29:34 -04:00
<li><p><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></p></li>
<li><p><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></p></li>
2018-08-07 19:42:25 -04:00
</ul>
<blockquote>
2019-06-08 00:29:34 -04:00
<div><p>PoP AMI type. CENTOS: a Centos AMI; POP: a PoP AMI.</p>
</div></blockquote>
</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.PopAmiInfo.TYPE_CENTOS">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.PopAmiInfo.TYPE_POP">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.PopInfo">
2019-07-04 06:14:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">PopInfo</code><span class="sig-paren">(</span><em class="sig-param">ami_infos=None</em>, <em class="sig-param">created_at=None</em>, <em class="sig-param">service_infos=None</em>, <em class="sig-param">id=None</em>, <em class="sig-param">manifest_version=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.PopInfo" title="Permalink to this definition"></a></dt>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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].</p></li>
<li><p><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</p></li>
<li><p><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]</p></li>
2019-07-04 06:14:34 -04:00
<li><p><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</p></li>
<li><p><strong>manifest_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>) version of the manifest.</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.PopServiceInfo">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">PopServiceInfo</code><span class="sig-paren">(</span><em class="sig-param">cln=None</em>, <em class="sig-param">version=None</em>, <em class="sig-param">build=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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>
2018-08-07 19:42:25 -04:00
<ul>
2019-06-08 00:29:34 -04:00
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
2018-08-07 19:42:25 -04:00
</ul>
<blockquote>
2019-06-08 00:29:34 -04:00
<div><p>An enum of PoP related services (including os platform and JRE).</p>
</div></blockquote>
</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_AGENT">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_AIDE">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_BRE">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_BRF">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_DNS">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_DOCKER">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_FM_LOG_COLLECTOR">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_FM_METRICS_COLLECTOR">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_FORWARD_PROXY">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_GLCM">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_JRE">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_LOGZ_LOG_COLLECTOR">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_NTP">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_OS">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_REVERSE_PROXY">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_RTS">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.PopServiceInfo.SERVICE_S3_ADAPTER">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.ProvisionSpec">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">ProvisionSpec</code><span class="sig-paren">(</span><em class="sig-param">provider=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.ProvisionSpec" title="Permalink to this definition"></a></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>Represents a provisioning spec for a sddc</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>provider</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.SddcConfigSpec" title="com.vmware.vmc.model_client.SddcConfigSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">SddcConfigSpec</span></code></a>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Map of provider to sddc config spec</p>
</dd>
</dl>
</dd></dl>
2018-08-07 19:42:25 -04:00
<dl class="class">
<dt id="com.vmware.vmc.model_client.Requests">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">Requests</code><span class="sig-paren">(</span><em class="sig-param">total=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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>) </p></li>
<li><p><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>) </p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.Reservation">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">Reservation</code><span class="sig-paren">(</span><em class="sig-param">duration=None</em>, <em class="sig-param">rid=None</em>, <em class="sig-param">create_time=None</em>, <em class="sig-param">start_time=None</em>, <em class="sig-param">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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.ReservationInMw">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">ReservationInMw</code><span class="sig-paren">(</span><em class="sig-param">rid=None</em>, <em class="sig-param">week_of=None</em>, <em class="sig-param">create_time=None</em>, <em class="sig-param">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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.ReservationSchedule">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">ReservationSchedule</code><span class="sig-paren">(</span><em class="sig-param">day_of_week=None</em>, <em class="sig-param">hour_of_day=None</em>, <em class="sig-param">duration_min=None</em>, <em class="sig-param">version=None</em>, <em class="sig-param">reservations=None</em>, <em class="sig-param">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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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>
2019-06-08 00:29:34 -04:00
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
</ul>
</p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
</ul>
</dd>
</dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.ReservationSchedule.DAY_OF_WEEK_FRIDAY">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">ReservationWindow</code><span class="sig-paren">(</span><em class="sig-param">reservation_state=None</em>, <em class="sig-param">emergency=None</em>, <em class="sig-param">maintenance_properties=None</em>, <em class="sig-param">reserve_id=None</em>, <em class="sig-param">start_hour=None</em>, <em class="sig-param">sddc_id=None</em>, <em class="sig-param">manifest_id=None</em>, <em class="sig-param">duration_hours=None</em>, <em class="sig-param">start_date=None</em>, <em class="sig-param">metadata=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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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>
2019-06-08 00:29:34 -04:00
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
</ul>
</p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) Metadata for reservation window, in key-value form</p></li>
</ul>
</dd>
</dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.ReservationWindow.RESERVATION_STATE_CANCELED">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">ReservationWindowMaintenanceProperties</code><span class="sig-paren">(</span><em class="sig-param">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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><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</p>
</dd>
</dl>
</dd></dl>
2018-08-07 19:42:25 -04:00
<dl class="class">
<dt id="com.vmware.vmc.model_client.Result">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">Result</code><span class="sig-paren">(</span><em class="sig-param">value=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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.</p></li>
<li><p><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.</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.RouteTableInfo">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">RouteTableInfo</code><span class="sig-paren">(</span><em class="sig-param">name=None</em>, <em class="sig-param">id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.RouteTableInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) route table name</p></li>
<li><p><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>) route table id</p></li>
</ul>
</dd>
</dl>
</dd></dl>
2018-08-07 19:42:25 -04:00
<dl class="class">
<dt id="com.vmware.vmc.model_client.ScopeInfo">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">ScopeInfo</code><span class="sig-paren">(</span><em class="sig-param">object_type_name=None</em>, <em class="sig-param">id=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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>) </p></li>
<li><p><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></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) </p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.Sddc">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">Sddc</code><span class="sig-paren">(</span><em class="sig-param">updated=None</em>, <em class="sig-param">user_id=None</em>, <em class="sig-param">updated_by_user_id=None</em>, <em class="sig-param">created=None</em>, <em class="sig-param">version=None</em>, <em class="sig-param">updated_by_user_name=None</em>, <em class="sig-param">user_name=None</em>, <em class="sig-param">id=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">sddc_state=None</em>, <em class="sig-param">expiration_date=None</em>, <em class="sig-param">org_id=None</em>, <em class="sig-param">sddc_type=None</em>, <em class="sig-param">one_node_reduced_capacity=None</em>, <em class="sig-param">provider=None</em>, <em class="sig-param">account_link_state=None</em>, <em class="sig-param">sddc_access_state=None</em>, <em class="sig-param">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>
2019-06-08 00:29:34 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>updated</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) </p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><strong>created</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) </p></li>
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) Version of this entity format: int32</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Unique ID for this entity</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) name for SDDC</p></li>
<li><p><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>
2018-08-07 19:42:25 -04:00
<ul>
2019-06-08 00:29:34 -04:00
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
</ul>
</p></li>
<li><p><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</p></li>
<li><p><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>) </p></li>
<li><p><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</p></li>
<li><p><strong>one_node_reduced_capacity</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>) Whether this sddc is reduced capacity 1NODE</p></li>
2019-06-08 00:29:34 -04:00
<li><p><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>
2018-08-07 19:42:25 -04:00
<ul>
2019-06-08 00:29:34 -04:00
<li><p><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></p></li>
<li><p><a class="reference internal" href="#com.vmware.vmc.model_client.Sddc.PROVIDER_ZEROCLOUD" title="com.vmware.vmc.model_client.Sddc.PROVIDER_ZEROCLOUD"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Sddc.PROVIDER_ZEROCLOUD</span></code></a></p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</p></li>
<li><p><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>
2018-08-07 19:42:25 -04:00
<ul>
2019-06-08 00:29:34 -04:00
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
2018-08-07 19:42:25 -04:00
</ul>
<blockquote>
2019-06-08 00:29:34 -04:00
<div><p>Account linking state of the sddc</p>
</div></blockquote>
</p></li>
<li><p><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</p></li>
<li><p><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>) </p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Sddc.ACCOUNT_LINK_STATE_DELAYED">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Sddc.ACCOUNT_LINK_STATE_LINKED">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Sddc.ACCOUNT_LINK_STATE_UNLINKED">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Sddc.PROVIDER_AWS">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Sddc.PROVIDER_ZEROCLOUD">
<code class="sig-name descname">PROVIDER_ZEROCLOUD</code><em class="property"> = 'ZEROCLOUD'</em><a class="headerlink" href="#com.vmware.vmc.model_client.Sddc.PROVIDER_ZEROCLOUD" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
2018-08-07 19:42:25 -04:00
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Sddc.SDDC_STATE_DELETED">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Sddc.SDDC_STATE_DELETING">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Sddc.SDDC_STATE_DELETION_FAILED">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Sddc.SDDC_STATE_DEPLOYING">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Sddc.SDDC_STATE_FAILED">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Sddc.SDDC_STATE_READY">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.SddcAllocatePublicIpSpec">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">SddcAllocatePublicIpSpec</code><span class="sig-paren">(</span><em class="sig-param">count=None</em>, <em class="sig-param">private_ips=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) </p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.SddcConfig">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">SddcConfig</code><span class="sig-paren">(</span><em class="sig-param">one_node_reduced_capacity=None</em>, <em class="sig-param">vpc_cidr=None</em>, <em class="sig-param">host_instance_type=None</em>, <em class="sig-param">skip_creating_vxlan=None</em>, <em class="sig-param">vxlan_subnet=None</em>, <em class="sig-param">size=None</em>, <em class="sig-param">storage_capacity=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">account_link_sddc_config=None</em>, <em class="sig-param">num_hosts=None</em>, <em class="sig-param">sddc_type=None</em>, <em class="sig-param">account_link_config=None</em>, <em class="sig-param">provider='SddcConfig'</em>, <em class="sig-param">sso_domain=None</em>, <em class="sig-param">sddc_template_id=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>one_node_reduced_capacity</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>) Whether this sddc is reduced capacity 1NODE.</p></li>
<li><p><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.</p></li>
<li><p><strong>host_instance_type</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.HostInstanceTypes" title="com.vmware.vmc.model_client.HostInstanceTypes"><code class="xref py py-class docutils literal notranslate"><span class="pre">HostInstanceTypes</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The instance type for the esx hosts in the primary cluster of the
SDDC.</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><strong>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>) The size of the vCenter and NSX appliances. “large” sddcSize
corresponds to a large vCenter appliance and large NSX
appliance. medium sddcSize corresponds to medium vCenter
appliance and medium NSX appliance. Value defaults to medium.</p></li>
2019-06-08 00:29:34 -04:00
<li><p><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
2019-01-16 05:37:32 -05:00
cluster, in GiBs. If provided, instead of using the direct-attached
storage, a capacity value amount of seperable storage will be used.
2019-06-08 00:29:34 -04:00
format: int64</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) </p></li>
<li><p><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.</p></li>
<li><p><strong>num_hosts</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) </p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) <p>Possible values are:</p>
2018-08-07 19:42:25 -04:00
<ul>
2019-06-08 00:29:34 -04:00
<li><p><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></p></li>
<li><p><a class="reference internal" href="#com.vmware.vmc.model_client.SddcConfig.PROVIDER_ZEROCLOUD" title="com.vmware.vmc.model_client.SddcConfig.PROVIDER_ZEROCLOUD"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SddcConfig.PROVIDER_ZEROCLOUD</span></code></a></p></li>
2018-08-07 19:42:25 -04:00
</ul>
<p>Determines what additional properties are available based on cloud
provider.</p>
2019-06-08 00:29:34 -04:00
</p></li>
<li><p><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.</p></li>
<li><p><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</p></li>
<li><p><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>
2018-08-07 19:42:25 -04:00
<ul>
2019-06-08 00:29:34 -04:00
<li><p><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></p></li>
<li><p><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></p></li>
2018-08-07 19:42:25 -04:00
</ul>
<p>Denotes if request is for a SingleAZ or a MultiAZ SDDC. Default is
SingleAZ.</p>
2019-06-08 00:29:34 -04:00
</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.SddcConfig.DEPLOYMENT_TYPE_MULTIAZ">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.SddcConfig.DEPLOYMENT_TYPE_SINGLEAZ">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.SddcConfig.PROVIDER_AWS">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.SddcConfig.PROVIDER_ZEROCLOUD">
<code class="sig-name descname">PROVIDER_ZEROCLOUD</code><em class="property"> = 'ZEROCLOUD'</em><a class="headerlink" href="#com.vmware.vmc.model_client.SddcConfig.PROVIDER_ZEROCLOUD" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
2019-06-08 00:29:34 -04:00
<dl class="method">
2019-05-29 06:01:09 -04:00
<dt id="com.vmware.vmc.model_client.SddcConfig.provider">
2019-06-08 00:29:34 -04:00
<em class="property">property </em><code class="sig-name descname">provider</code><a class="headerlink" href="#com.vmware.vmc.model_client.SddcConfig.provider" title="Permalink to this definition"></a></dt>
2019-05-29 06:01:09 -04:00
<dd><p>Return the discriminator value</p>
</dd></dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.SddcConfigSpec">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">SddcConfigSpec</code><span class="sig-paren">(</span><em class="sig-param">sddc_type_config_spec=None</em>, <em class="sig-param">region_display_names=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.SddcConfigSpec" title="Permalink to this definition"></a></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>Represents a configuration spec for a sddc</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>sddc_type_config_spec</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.ConfigSpec" title="com.vmware.vmc.model_client.ConfigSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigSpec</span></code></a>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Map of sddc type to config spec</p></li>
<li><p><strong>region_display_names</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>) The region name to display names mapping</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.SddcId">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">SddcId</code><span class="sig-paren">(</span><em class="sig-param">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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><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</p>
</dd>
</dl>
</dd></dl>
2018-08-07 19:42:25 -04:00
<dl class="class">
<dt id="com.vmware.vmc.model_client.SddcLinkConfig">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">SddcLinkConfig</code><span class="sig-paren">(</span><em class="sig-param">customer_subnet_ids=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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>) </p></li>
<li><p><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</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.SddcManifest">
2019-07-04 06:14:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">SddcManifest</code><span class="sig-paren">(</span><em class="sig-param">vmc_version=None</em>, <em class="sig-param">glcm_bundle=None</em>, <em class="sig-param">pop_info=None</em>, <em class="sig-param">vmc_internal_version=None</em>, <em class="sig-param">ebs_backed_vsan_config=None</em>, <em class="sig-param">vsan_witness_ami=None</em>, <em class="sig-param">esx_ami=None</em>, <em class="sig-param">esx_nsxt_ami=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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</p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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</p></li>
2019-07-04 06:14:34 -04:00
<li><p><strong>ebs_backed_vsan_config</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.EbsBackedVsanConfig" title="com.vmware.vmc.model_client.EbsBackedVsanConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">EbsBackedVsanConfig</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) </p></li>
<li><p><strong>vsan_witness_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>) </p></li>
2019-06-08 00:29:34 -04:00
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.SddcNetwork">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">SddcNetwork</code><span class="sig-paren">(</span><em class="sig-param">subnets=None</em>, <em class="sig-param">cgw_name=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">l2_extension=None</em>, <em class="sig-param">cgw_id=None</em>, <em class="sig-param">dhcp_configs=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.SddcNetworkAddressGroup">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">SddcNetworkAddressGroup</code><span class="sig-paren">(</span><em class="sig-param">prefix_length=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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.</p></li>
<li><p><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.</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.SddcNetworkAddressGroups">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">SddcNetworkAddressGroups</code><span class="sig-paren">(</span><em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><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.</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.SddcNetworkDhcpConfig">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">SddcNetworkDhcpConfig</code><span class="sig-paren">(</span><em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><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.</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.SddcNetworkDhcpIpPool">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">SddcNetworkDhcpIpPool</code><span class="sig-paren">(</span><em class="sig-param">ip_range=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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.</p></li>
<li><p><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.</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2019-05-29 06:01:09 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.SddcPatchRequest">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">SddcPatchRequest</code><span class="sig-paren">(</span><em class="sig-param">name=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.SddcPatchRequest" title="Permalink to this definition"></a></dt>
2019-05-29 06:01:09 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Patch request body for SDDC</p>
<div class="admonition tip">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2019-05-29 06:01:09 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The new name of the SDDC to be changed to.</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.SddcPublicIp">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">SddcPublicIp</code><span class="sig-paren">(</span><em class="sig-param">public_ip=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">allocation_id=None</em>, <em class="sig-param">dnat_rule_id=None</em>, <em class="sig-param">associated_private_ip=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>public_ip</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) </p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.SddcResourceConfig">
2019-07-10 02:17:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">SddcResourceConfig</code><span class="sig-paren">(</span><em class="sig-param">mgmt_appliance_network_name=None</em>, <em class="sig-param">nsxt=None</em>, <em class="sig-param">mgw_id=None</em>, <em class="sig-param">nsx_mgr_url=None</em>, <em class="sig-param">psc_management_ip=None</em>, <em class="sig-param">psc_url=None</em>, <em class="sig-param">cgws=None</em>, <em class="sig-param">availability_zones=None</em>, <em class="sig-param">management_ds=None</em>, <em class="sig-param">nsx_api_public_endpoint_url=None</em>, <em class="sig-param">custom_properties=None</em>, <em class="sig-param">cloud_password=None</em>, <em class="sig-param">provider='SddcResourceConfig'</em>, <em class="sig-param">clusters=None</em>, <em class="sig-param">vc_management_ip=None</em>, <em class="sig-param">sddc_networks=None</em>, <em class="sig-param">cloud_username=None</em>, <em class="sig-param">esx_hosts=None</em>, <em class="sig-param">nsx_mgr_management_ip=None</em>, <em class="sig-param">vc_instance_id=None</em>, <em class="sig-param">esx_cluster_id=None</em>, <em class="sig-param">vc_public_ip=None</em>, <em class="sig-param">skip_creating_vxlan=None</em>, <em class="sig-param">vc_url=None</em>, <em class="sig-param">sddc_manifest=None</em>, <em class="sig-param">vxlan_subnet=None</em>, <em class="sig-param">cloud_user_group=None</em>, <em class="sig-param">management_rp=None</em>, <em class="sig-param">region=None</em>, <em class="sig-param">witness_availability_zone=None</em>, <em class="sig-param">sddc_id=None</em>, <em class="sig-param">pop_agent_xeni_connection=None</em>, <em class="sig-param">nsx_controller_ips=None</em>, <em class="sig-param">esx_host_subnet=None</em>, <em class="sig-param">sso_domain=None</em>, <em class="sig-param">deployment_type=None</em>, <em class="sig-param">nsxt_addons=None</em>, <em class="sig-param">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>
2019-06-08 00:29:34 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>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.</p></li>
<li><p><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.</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><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>) </p></li>
<li><p><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
2018-08-07 19:42:25 -04:00
SDDCs will have hosts provisioned over two availability zones while
2019-06-08 00:29:34 -04:00
SingleAZ SDDCs will provision over one.</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><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>) </p></li>
<li><p><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</p></li>
<li><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) <p>Possible values are:</p>
2018-08-07 19:42:25 -04:00
<ul>
2019-06-08 00:29:34 -04:00
<li><p><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></p></li>
<li><p><a class="reference internal" href="#com.vmware.vmc.model_client.SddcResourceConfig.PROVIDER_ZEROCLOUD" title="com.vmware.vmc.model_client.SddcResourceConfig.PROVIDER_ZEROCLOUD"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SddcResourceConfig.PROVIDER_ZEROCLOUD</span></code></a></p></li>
2018-08-07 19:42:25 -04:00
</ul>
<blockquote>
2019-06-08 00:29:34 -04:00
<div><p>Discriminator for additional properties</p>
</div></blockquote>
</p></li>
<li><p><strong>clusters</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.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> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) List of clusters in the SDDC.</p></li>
<li><p><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</p></li>
<li><p><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>) </p></li>
<li><p><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</p></li>
<li><p><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>) </p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><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>) </p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><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>) </p></li>
2019-07-10 02:17:34 -04:00
<li><p><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>) region in which sddc is deployed</p></li>
2019-06-08 00:29:34 -04:00
<li><p><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.</p></li>
2019-07-10 02:17:34 -04:00
<li><p><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 identifier</p></li>
2019-06-08 00:29:34 -04:00
<li><p><strong>pop_agent_xeni_connection</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.PopAgentXeniConnection" title="com.vmware.vmc.model_client.PopAgentXeniConnection"><code class="xref py py-class docutils literal notranslate"><span class="pre">PopAgentXeniConnection</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) </p></li>
<li><p><strong>nsx_controller_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 Controller IPs</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><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>
2018-08-07 19:42:25 -04:00
<ul>
2019-06-08 00:29:34 -04:00
<li><p><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></p></li>
<li><p><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></p></li>
</ul>
<blockquote>
2019-06-08 00:29:34 -04:00
<div><p>Denotes if this is a SingleAZ SDDC or a MultiAZ SDDC.</p>
</div></blockquote>
</p></li>
<li><p><strong>nsxt_addons</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.NsxtAddons" title="com.vmware.vmc.model_client.NsxtAddons"><code class="xref py py-class docutils literal notranslate"><span class="pre">NsxtAddons</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) </p></li>
<li><p><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</p></li>
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.SddcResourceConfig.DEPLOYMENT_TYPE_MULTI_AZ">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.SddcResourceConfig.PROVIDER_ZEROCLOUD">
<code class="sig-name descname">PROVIDER_ZEROCLOUD</code><em class="property"> = 'ZEROCLOUD'</em><a class="headerlink" href="#com.vmware.vmc.model_client.SddcResourceConfig.PROVIDER_ZEROCLOUD" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
2019-06-08 00:29:34 -04:00
<dl class="method">
2019-05-29 06:01:09 -04:00
<dt id="com.vmware.vmc.model_client.SddcResourceConfig.provider">
2019-06-08 00:29:34 -04:00
<em class="property">property </em><code class="sig-name descname">provider</code><a class="headerlink" href="#com.vmware.vmc.model_client.SddcResourceConfig.provider" title="Permalink to this definition"></a></dt>
2019-05-29 06:01:09 -04:00
<dd><p>Return the discriminator value</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.SddcStateRequest">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">SddcStateRequest</code><span class="sig-paren">(</span><em class="sig-param">sddcs=None</em>, <em class="sig-param">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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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>) </p></li>
<li><p><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>
2019-06-08 00:29:34 -04:00
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.SddcStateRequest.STATES_CANCELED">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.SddcStateRequest.STATES_COMPLETED">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.SddcStateRequest.STATES_RUNNING">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.SddcTemplate">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">SddcTemplate</code><span class="sig-paren">(</span><em class="sig-param">updated=None</em>, <em class="sig-param">user_id=None</em>, <em class="sig-param">updated_by_user_id=None</em>, <em class="sig-param">created=None</em>, <em class="sig-param">version=None</em>, <em class="sig-param">updated_by_user_name=None</em>, <em class="sig-param">user_name=None</em>, <em class="sig-param">id=None</em>, <em class="sig-param">account_link_sddc_configs=None</em>, <em class="sig-param">state=None</em>, <em class="sig-param">network_template=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">source_sddc_id=None</em>, <em class="sig-param">org_id=None</em>, <em class="sig-param">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="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>updated</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) </p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><strong>created</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) </p></li>
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) Version of this entity format: int32</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Unique ID for this entity</p></li>
<li><p><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.</p></li>
<li><p><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>
2018-08-07 19:42:25 -04:00
<ul>
2019-06-08 00:29:34 -04:00
<li><p><a class="reference internal" href="#com.vmware.vmc.model_client.SddcTemplate.STATE_INITIALIZATION" title="com.vmware.vmc.model_client.SddcTemplate.STATE_INITIALIZATION"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SddcTemplate.STATE_INITIALIZATION</span></code></a></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
</ul>
</p></li>
<li><p><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>) </p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) name for SDDC configuration template</p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
</ul>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.SddcTemplate.STATE_APPLIED">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.SddcTemplate.STATE_AVAILABLE">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.SddcTemplate.STATE_DELETED">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.SddcTemplate.STATE_DELETING">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.SddcTemplate.STATE_FAILED">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
2019-05-29 06:01:09 -04:00
<dt id="com.vmware.vmc.model_client.SddcTemplate.STATE_INITIALIZATION">
2019-06-08 00:29:34 -04:00
<code class="sig-name descname">STATE_INITIALIZATION</code><em class="property"> = 'INITIALIZATION'</em><a class="headerlink" href="#com.vmware.vmc.model_client.SddcTemplate.STATE_INITIALIZATION" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
2018-08-07 19:42:25 -04:00
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.SddcTemplate.STATE_INUSE">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.SecondaryAddresses">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">SecondaryAddresses</code><span class="sig-paren">(</span><em class="sig-param">type=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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></li>
<li><p><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.</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.ServiceError">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">ServiceError</code><span class="sig-paren">(</span><em class="sig-param">default_message=None</em>, <em class="sig-param">original_service=None</em>, <em class="sig-param">localized_message=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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.</p></li>
<li><p><strong>original_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>) The original service name of the error.</p></li>
2019-06-08 00:29:34 -04:00
<li><p><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.</p></li>
<li><p><strong>original_service_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>) The original error code of the service.</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.Site">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">Site</code><span class="sig-paren">(</span><em class="sig-param">password=None</em>, <em class="sig-param">user_id=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">rx_bytes_on_local_subnet=None</em>, <em class="sig-param">secure_traffic=None</em>, <em class="sig-param">established_date=None</em>, <em class="sig-param">failure_message=None</em>, <em class="sig-param">dropped_tx_packets=None</em>, <em class="sig-param">dropped_rx_packets=None</em>, <em class="sig-param">tunnel_status=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Site password.</p></li>
<li><p><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.</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Unique name for the site getting configured.</p></li>
<li><p><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
2018-08-07 19:42:25 -04:00
This attribute may be present in responses from the server, but if
2019-06-08 00:29:34 -04:00
it is present in a request to server it will be ignored.</p></li>
<li><p><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.</p></li>
<li><p><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.
2018-08-07 19:42:25 -04:00
This attribute may be present in responses from the server, but if
2019-06-08 00:29:34 -04:00
it is present in a request to server it will be ignored.</p></li>
<li><p><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.
2018-08-07 19:42:25 -04:00
This attribute may be present in responses from the server, but if
2019-06-08 00:29:34 -04:00
it is present in a request to server it will be ignored.</p></li>
<li><p><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.
2018-08-07 19:42:25 -04:00
This attribute may be present in responses from the server, but if
2019-06-08 00:29:34 -04:00
it is present in a request to server it will be ignored.</p></li>
<li><p><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.
2018-08-07 19:42:25 -04:00
This attribute may be present in responses from the server, but if
2019-06-08 00:29:34 -04:00
it is present in a request to server it will be ignored.</p></li>
<li><p><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>
2018-08-07 19:42:25 -04:00
<ul>
2019-06-08 00:29:34 -04:00
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
2018-08-07 19:42:25 -04:00
</ul>
<blockquote>
2019-06-08 00:29:34 -04:00
<div><p>Site tunnel status.</p>
</div></blockquote>
2018-08-07 19:42:25 -04:00
<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>
2019-06-08 00:29:34 -04:00
</p></li>
<li><p><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
2018-08-07 19:42:25 -04:00
This attribute may be present in responses from the server, but if
2019-06-08 00:29:34 -04:00
it is present in a request to server it will be ignored.</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Site.TUNNEL_STATUS_CONNECTED">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Site.TUNNEL_STATUS_DISCONNECTED">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Site.TUNNEL_STATUS_UNKNOWN">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.Sites">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">Sites</code><span class="sig-paren">(</span><em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><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>) </p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.SslvpnDashboardStats">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">SslvpnDashboardStats</code><span class="sig-paren">(</span><em class="sig-param">active_clients=None</em>, <em class="sig-param">sslvpn_bytes_in=None</em>, <em class="sig-param">auth_failures=None</em>, <em class="sig-param">sessions_created=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.StoragePolicyReconfigInfo">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">StoragePolicyReconfigInfo</code><span class="sig-paren">(</span><em class="sig-param">reconfig_needed=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.StoragePolicyReconfigInfo" title="Permalink to this definition"></a></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>Information regarding storage policy reconfiguration.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>reconfig_needed</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, policy reconfiguration is required. Otherwise, policy
reconfiguration is not required.</p>
</dd>
</dl>
</dd></dl>
2018-08-07 19:42:25 -04:00
<dl class="class">
<dt id="com.vmware.vmc.model_client.StubFactory">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Stub config instance</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.SubInterface">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">SubInterface</code><span class="sig-paren">(</span><em class="sig-param">index=None</em>, <em class="sig-param">tunnel_id=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">address_groups=None</em>, <em class="sig-param">vlan_id=None</em>, <em class="sig-param">label=None</em>, <em class="sig-param">logical_switch_name=None</em>, <em class="sig-param">is_connected=None</em>, <em class="sig-param">mtu=None</em>, <em class="sig-param">logical_switch_id=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>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</p></li>
<li><p><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</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Name of the sub interface. Required.</p></li>
<li><p><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.</p></li>
<li><p><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</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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
2018-08-07 19:42:25 -04:00
for all the trunk interfaces of the NSX Edge. Default is 1500.
2019-06-08 00:29:34 -04:00
format: int32</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.SubInterfaces">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">SubInterfaces</code><span class="sig-paren">(</span><em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><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.</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.Subnet">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">Subnet</code><span class="sig-paren">(</span><em class="sig-param">subnet_id=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">route_tables=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.Subnet" title="Permalink to this definition"></a></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>(as theres already one SubnetInfo, use Subnet instead)</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>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>) subnet id</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) subnet name</p></li>
<li><p><strong>route_tables</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.SubnetRouteTableInfo" title="com.vmware.vmc.model_client.SubnetRouteTableInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">SubnetRouteTableInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.SubnetInfo">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">SubnetInfo</code><span class="sig-paren">(</span><em class="sig-param">compatible=None</em>, <em class="sig-param">connected_account_id=None</em>, <em class="sig-param">region_name=None</em>, <em class="sig-param">availability_zone=None</em>, <em class="sig-param">subnet_id=None</em>, <em class="sig-param">availability_zone_id=None</em>, <em class="sig-param">subnet_cidr_block=None</em>, <em class="sig-param">note=None</em>, <em class="sig-param">vpc_id=None</em>, <em class="sig-param">vpc_cidr_block=None</em>, <em class="sig-param">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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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?</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><strong>availability_zone_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 availability zone id (customer-centric) this subnet is in.</p></li>
2019-06-08 00:29:34 -04:00
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The name of the subnet. This is either the tagged name or the
default AWS id it was given.</p></li>
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.SubnetRouteTableInfo">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">SubnetRouteTableInfo</code><span class="sig-paren">(</span><em class="sig-param">subnet_id=None</em>, <em class="sig-param">association_id=None</em>, <em class="sig-param">routetable_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.SubnetRouteTableInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>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>) subnet id</p></li>
<li><p><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>) subnet - route table association id</p></li>
<li><p><strong>routetable_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 id</p></li>
</ul>
</dd>
</dl>
</dd></dl>
2018-08-07 19:42:25 -04:00
<dl class="class">
<dt id="com.vmware.vmc.model_client.Subnets">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">Subnets</code><span class="sig-paren">(</span><em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><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
2018-08-07 19:42:25 -04:00
be network address specified in CIDR format and can accept
2019-06-08 00:29:34 -04:00
0.0.0.0/0 (any)</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.SubscriptionDetails">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">SubscriptionDetails</code><span class="sig-paren">(</span><em class="sig-param">status=None</em>, <em class="sig-param">anniversary_billing_date=None</em>, <em class="sig-param">end_date=None</em>, <em class="sig-param">billing_frequency=None</em>, <em class="sig-param">auto_renewed_allowed=None</em>, <em class="sig-param">commitment_term=None</em>, <em class="sig-param">csp_subscription_id=None</em>, <em class="sig-param">billing_subscription_id=None</em>, <em class="sig-param">offer_version=None</em>, <em class="sig-param">offer_type=None</em>, <em class="sig-param">description=None</em>, <em class="sig-param">product_id=None</em>, <em class="sig-param">region=None</em>, <em class="sig-param">product_name=None</em>, <em class="sig-param">offer_name=None</em>, <em class="sig-param">commitment_term_uom=None</em>, <em class="sig-param">start_date=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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>
2018-08-07 19:42:25 -04:00
<ul>
2019-06-08 00:29:34 -04:00
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><a class="reference internal" href="#com.vmware.vmc.model_client.SubscriptionDetails.STATUS_SUSPENDED" title="com.vmware.vmc.model_client.SubscriptionDetails.STATUS_SUSPENDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SubscriptionDetails.STATUS_SUSPENDED</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.vmc.model_client.SubscriptionDetails.STATUS_TERMINATED" title="com.vmware.vmc.model_client.SubscriptionDetails.STATUS_TERMINATED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SubscriptionDetails.STATUS_TERMINATED</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.vmc.model_client.SubscriptionDetails.STATUS_UKNOWN" title="com.vmware.vmc.model_client.SubscriptionDetails.STATUS_UKNOWN"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SubscriptionDetails.STATUS_UKNOWN</span></code></a></p></li>
2019-06-08 00:29:34 -04:00
</ul>
</p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><strong>billing_frequency</strong> (<code class="xref 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 frequency at which the customer is billed. Currently supported
values are “Upfront” and “Monthly”</p></li>
2019-06-08 00:29:34 -04:00
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) </p></li>
<li><p><strong>product_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></li>
2019-06-08 00:29:34 -04:00
<li><p><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>) </p></li>
<li><p><strong>product_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>) </p></li>
2019-06-08 00:29:34 -04:00
<li><p><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>) </p></li>
<li><p><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</p></li>
2019-06-08 00:29:34 -04:00
<li><p><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>) </p></li>
<li><p><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>) </p></li>
</ul>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.SubscriptionDetails.STATUS_ACTIVATED">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.SubscriptionDetails.STATUS_CANCELLED">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.SubscriptionDetails.STATUS_CREATED">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.SubscriptionDetails.STATUS_EXPIRED">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.SubscriptionDetails.STATUS_FAILED">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.SubscriptionDetails.STATUS_ORDER_SUBMITTED">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.SubscriptionDetails.STATUS_PENDING_PROVISIONING">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.SubscriptionDetails.STATUS_SUSPENDED">
<code class="sig-name descname">STATUS_SUSPENDED</code><em class="property"> = 'SUSPENDED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.SubscriptionDetails.STATUS_SUSPENDED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.SubscriptionDetails.STATUS_TERMINATED">
<code class="sig-name descname">STATUS_TERMINATED</code><em class="property"> = 'TERMINATED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.SubscriptionDetails.STATUS_TERMINATED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.SubscriptionDetails.STATUS_UKNOWN">
<code class="sig-name descname">STATUS_UKNOWN</code><em class="property"> = 'UKNOWN'</em><a class="headerlink" href="#com.vmware.vmc.model_client.SubscriptionDetails.STATUS_UKNOWN" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
2019-01-16 05:37:32 -05:00
<dl class="class">
<dt id="com.vmware.vmc.model_client.SubscriptionProducts">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">SubscriptionProducts</code><span class="sig-paren">(</span><em class="sig-param">product=None</em>, <em class="sig-param">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>
2019-01-16 05:37:32 -05:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2019-01-16 05:37:32 -05:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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</p></li>
<li><p><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.</p></li>
2019-01-16 05:37:32 -05:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2019-01-16 05:37:32 -05:00
</dd></dl>
2018-08-07 19:42:25 -04:00
<dl class="class">
<dt id="com.vmware.vmc.model_client.SubscriptionRequest">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">SubscriptionRequest</code><span class="sig-paren">(</span><em class="sig-param">product=None</em>, <em class="sig-param">product_type=None</em>, <em class="sig-param">product_id=None</em>, <em class="sig-param">billing_frequency=None</em>, <em class="sig-param">region=None</em>, <em class="sig-param">commitment_term=None</em>, <em class="sig-param">offer_context_id=None</em>, <em class="sig-param">offer_version=None</em>, <em class="sig-param">offer_name=None</em>, <em class="sig-param">quantity=None</em>, <em class="sig-param">type=None</em>, <em class="sig-param">price=None</em>, <em class="sig-param">product_charge_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.SubscriptionRequest" title="Permalink to this definition"></a></dt>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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.</p></li>
<li><p><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</p></li>
<li><p><strong>product_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></li>
<li><p><strong>billing_frequency</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Frequency of the billing.</p></li>
2019-06-08 00:29:34 -04:00
<li><p><strong>region</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) </p></li>
<li><p><strong>commitment_term</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) </p></li>
<li><p><strong>offer_context_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></li>
<li><p><strong>offer_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) </p></li>
<li><p><strong>offer_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) </p></li>
<li><p><strong>quantity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) </p></li>
<li><p><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.</p></li>
<li><p><strong>price</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>) </p></li>
<li><p><strong>product_charge_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></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.SupportWindow">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">SupportWindow</code><span class="sig-paren">(</span><em class="sig-param">start_day=None</em>, <em class="sig-param">seats=None</em>, <em class="sig-param">sddcs=None</em>, <em class="sig-param">duration_hours=None</em>, <em class="sig-param">start_hour=None</em>, <em class="sig-param">support_window_id=None</em>, <em class="sig-param">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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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>
2019-06-08 00:29:34 -04:00
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
</ul>
</p></li>
<li><p><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>) </p></li>
<li><p><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</p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
</ul>
</dd>
</dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.SupportWindow.START_DAY_FRIDAY">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2019-01-16 05:37:32 -05:00
<dl class="class">
<dt id="com.vmware.vmc.model_client.SupportWindowId">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">SupportWindowId</code><span class="sig-paren">(</span><em class="sig-param">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>
2019-01-16 05:37:32 -05:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2019-01-16 05:37:32 -05:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><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</p>
</dd>
</dl>
2019-01-16 05:37:32 -05:00
</dd></dl>
2018-08-07 19:42:25 -04:00
<dl class="class">
<dt id="com.vmware.vmc.model_client.Task">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">Task</code><span class="sig-paren">(</span><em class="sig-param">updated=None</em>, <em class="sig-param">user_id=None</em>, <em class="sig-param">updated_by_user_id=None</em>, <em class="sig-param">created=None</em>, <em class="sig-param">version=None</em>, <em class="sig-param">updated_by_user_name=None</em>, <em class="sig-param">user_name=None</em>, <em class="sig-param">id=None</em>, <em class="sig-param">status=None</em>, <em class="sig-param">localized_error_message=None</em>, <em class="sig-param">resource_id=None</em>, <em class="sig-param">parent_task_id=None</em>, <em class="sig-param">task_version=None</em>, <em class="sig-param">correlation_id=None</em>, <em class="sig-param">start_resource_entity_version=None</em>, <em class="sig-param">sub_status=None</em>, <em class="sig-param">task_type=None</em>, <em class="sig-param">start_time=None</em>, <em class="sig-param">task_progress_phases=None</em>, <em class="sig-param">error_message=None</em>, <em class="sig-param">org_id=None</em>, <em class="sig-param">end_resource_entity_version=None</em>, <em class="sig-param">service_errors=None</em>, <em class="sig-param">org_type=None</em>, <em class="sig-param">estimated_remaining_minutes=None</em>, <em class="sig-param">params=None</em>, <em class="sig-param">progress_percent=None</em>, <em class="sig-param">phase_in_progress=None</em>, <em class="sig-param">resource_type=None</em>, <em class="sig-param">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="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>updated</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) </p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><strong>created</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) </p></li>
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) Version of this entity format: int32</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Unique ID for this entity</p></li>
<li><p><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>
2018-08-07 19:42:25 -04:00
<ul>
2019-06-08 00:29:34 -04:00
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
</ul>
</p></li>
<li><p><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>) </p></li>
<li><p><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</p></li>
<li><p><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.</p></li>
<li><p><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>) </p></li>
<li><p><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
2019-01-16 05:37:32 -05:00
idempotent. Be aware not all tasks support this. For tasks that do
- supplying the same correlation Id, for the same task type, within
2019-06-08 00:29:34 -04:00
a predefined window will ensure the operation happens at most once.</p></li>
<li><p><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</p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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</p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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</p></li>
<li><p><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.</p></li>
<li><p><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>) </p></li>
<li><p><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, &lt; 0 means
no estimation for the task. format: int32</p></li>
<li><p><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>) </p></li>
<li><p><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</p></li>
<li><p><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.</p></li>
<li><p><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</p></li>
<li><p><strong>end_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) </p></li>
</ul>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Task.STATUS_CANCELED">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Task.STATUS_CANCELING">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Task.STATUS_FAILED">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Task.STATUS_FINISHED">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Task.STATUS_STARTED">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.TaskProgressPhase">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">TaskProgressPhase</code><span class="sig-paren">(</span><em class="sig-param">id=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The identifier of the task progress phase</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.TermBillingOptions">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">TermBillingOptions</code><span class="sig-paren">(</span><em class="sig-param">unit_price=None</em>, <em class="sig-param">billing_frequency=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.TermBillingOptions" title="Permalink to this definition"></a></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 term billing options.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>unit_price</strong> (<code class="xref 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></li>
<li><p><strong>billing_frequency</strong> (<code class="xref 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></li>
</ul>
</dd>
</dl>
</dd></dl>
2018-08-07 19:42:25 -04:00
<dl class="class">
<dt id="com.vmware.vmc.model_client.TermOfferInstance">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">TermOfferInstance</code><span class="sig-paren">(</span><em class="sig-param">description=None</em>, <em class="sig-param">product=None</em>, <em class="sig-param">product_type=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">currency=None</em>, <em class="sig-param">region=None</em>, <em class="sig-param">commitment_term=None</em>, <em class="sig-param">unit_price=None</em>, <em class="sig-param">billing_options=None</em>, <em class="sig-param">version=None</em>, <em class="sig-param">offer_context_id=None</em>, <em class="sig-param">product_charge_id=None</em>, <em class="sig-param">type=None</em>, <em class="sig-param">product_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.TermOfferInstance" title="Permalink to this definition"></a></dt>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) </p></li>
<li><p><strong>product</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) </p></li>
<li><p><strong>product_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>) Deprecated. Please use product and type fields instead.</p></li>
2019-06-08 00:29:34 -04:00
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) </p></li>
<li><p><strong>currency</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) </p></li>
2019-06-08 00:29:34 -04:00
<li><p><strong>region</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) </p></li>
<li><p><strong>commitment_term</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) </p></li>
<li><p><strong>unit_price</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (deprecated. unit_price is moved into TermBillingOptions. For
backward compatibility, this field reflect “Prepaid” price at the
offer level.)</p></li>
<li><p><strong>billing_options</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.TermBillingOptions" title="com.vmware.vmc.model_client.TermBillingOptions"><code class="xref py py-class docutils literal notranslate"><span class="pre">TermBillingOptions</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) </p></li>
2019-06-08 00:29:34 -04:00
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) </p></li>
<li><p><strong>offer_context_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></li>
<li><p><strong>product_charge_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></li>
<li><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) </p></li>
<li><p><strong>product_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></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.TrafficShapingPolicy">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">TrafficShapingPolicy</code><span class="sig-paren">(</span><em class="sig-param">burst_size=None</em>, <em class="sig-param">average_bandwidth=None</em>, <em class="sig-param">peak_bandwidth=None</em>, <em class="sig-param">enabled=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) </p></li>
<li><p><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>) </p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2019-05-29 06:01:09 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.UpdateCredentials">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">UpdateCredentials</code><span class="sig-paren">(</span><em class="sig-param">username=None</em>, <em class="sig-param">password=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.UpdateCredentials" title="Permalink to this definition"></a></dt>
2019-05-29 06:01:09 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2019-05-29 06:01:09 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>username</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Username of the credentials</p></li>
<li><p><strong>password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Password associated with the credentials</p></li>
2019-05-29 06:01:09 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.VmcLocale">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">VmcLocale</code><span class="sig-paren">(</span><em class="sig-param">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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><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</p>
</dd>
</dl>
</dd></dl>
2018-08-07 19:42:25 -04:00
<dl class="class">
<dt id="com.vmware.vmc.model_client.Vnic">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">Vnic</code><span class="sig-paren">(</span><em class="sig-param">sub_interfaces=None</em>, <em class="sig-param">address_groups=None</em>, <em class="sig-param">is_connected=None</em>, <em class="sig-param">enable_send_redirects=None</em>, <em class="sig-param">in_shaping_policy=None</em>, <em class="sig-param">label=None</em>, <em class="sig-param">enable_proxy_arp=None</em>, <em class="sig-param">index=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">mtu=None</em>, <em class="sig-param">fence_parameters=None</em>, <em class="sig-param">mac_addresses=None</em>, <em class="sig-param">out_shaping_policy=None</em>, <em class="sig-param">portgroup_name=None</em>, <em class="sig-param">enable_bridge_mode=None</em>, <em class="sig-param">type=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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>) </p></li>
<li><p><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.</p></li>
<li><p><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
2018-08-07 19:42:25 -04:00
to allow the NSX Edge of type gatewayServices to answer ARP
2019-06-08 00:29:34 -04:00
requests intended for other machines.</p></li>
<li><p><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</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Name of the interface. Optional.</p></li>
<li><p><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</p></li>
<li><p><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>) </p></li>
<li><p><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.</p></li>
<li><p><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>) </p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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
2018-08-07 19:42:25 -04:00
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
2019-06-08 00:29:34 -04:00
portgroup) or virtualwire-2 (logical switch).</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.Vnics">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">Vnics</code><span class="sig-paren">(</span><em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><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.</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.VpcInfo">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">VpcInfo</code><span class="sig-paren">(</span><em class="sig-param">vpc_cidr=None</em>, <em class="sig-param">vgw_id=None</em>, <em class="sig-param">esx_public_security_group_id=None</em>, <em class="sig-param">vif_ids=None</em>, <em class="sig-param">vm_security_group_id=None</em>, <em class="sig-param">tgw_ips=None</em>, <em class="sig-param">route_table_id=None</em>, <em class="sig-param">edge_subnet_id=None</em>, <em class="sig-param">id=None</em>, <em class="sig-param">api_association_id=None</em>, <em class="sig-param">api_subnet_id=None</em>, <em class="sig-param">private_subnet_id=None</em>, <em class="sig-param">private_association_id=None</em>, <em class="sig-param">esx_security_group_id=None</em>, <em class="sig-param">subnet_id=None</em>, <em class="sig-param">internet_gateway_id=None</em>, <em class="sig-param">security_group_id=None</em>, <em class="sig-param">association_id=None</em>, <em class="sig-param">vgw_route_table_id=None</em>, <em class="sig-param">edge_association_id=None</em>, <em class="sig-param">provider=None</em>, <em class="sig-param">peering_connection_id=None</em>, <em class="sig-param">network_type=None</em>, <em class="sig-param">available_zones=None</em>, <em class="sig-param">routetables=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.VpcInfo" title="Permalink to this definition"></a></dt>
2019-06-08 00:29:34 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>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>) </p></li>
<li><p><strong>vgw_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></li>
<li><p><strong>esx_public_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>) </p></li>
<li><p><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>) set of virtual interfaces attached to the sddc</p></li>
2019-06-08 00:29:34 -04:00
<li><p><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>) </p></li>
<li><p><strong>tgw_ips</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">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>) Mapping from AZ to a list of IP addresses assigned to TGW ENI
thats connected with Vpc</p></li>
<li><p><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>) (deprecated)</p></li>
<li><p><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 (deprecated)</p></li>
<li><p><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>) vpc id</p></li>
<li><p><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 (deprecated)</p></li>
<li><p><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 (deprecated)</p></li>
<li><p><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>) (deprecated)</p></li>
<li><p><strong>private_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>) (deprecated)</p></li>
2019-06-08 00:29:34 -04:00
<li><p><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>) </p></li>
<li><p><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>) (deprecated)</p></li>
2019-06-08 00:29:34 -04:00
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) (deprecated)</p></li>
<li><p><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 (deprecated)</p></li>
<li><p><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
(deprecated)</p></li>
<li><p><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></li>
<li><p><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>) (deprecated)</p></li>
<li><p><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></li>
<li><p><strong>available_zones</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.AvailableZoneInfo" title="com.vmware.vmc.model_client.AvailableZoneInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">AvailableZoneInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) </p></li>
<li><p><strong>routetables</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.RouteTableInfo" title="com.vmware.vmc.model_client.RouteTableInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">RouteTableInfo</span></code></a>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) map from routeTableName to routeTableInfo</p></li>
2019-06-08 00:29:34 -04:00
</ul>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.VpcInfoSubnets">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">VpcInfoSubnets</code><span class="sig-paren">(</span><em class="sig-param">vpc_id=None</em>, <em class="sig-param">cidr_block=None</em>, <em class="sig-param">description=None</em>, <em class="sig-param">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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The description of the VPC; usually its name or id.</p></li>
<li><p><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>) </p></li>
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
</dd></dl>
2018-08-07 19:42:25 -04:00
<dl class="class">
<dt id="com.vmware.vmc.model_client.Vpn">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">Vpn</code><span class="sig-paren">(</span><em class="sig-param">version=None</em>, <em class="sig-param">on_prem_gateway_ip=None</em>, <em class="sig-param">on_prem_network_cidr=None</em>, <em class="sig-param">pfs_enabled=None</em>, <em class="sig-param">id=None</em>, <em class="sig-param">channel_status=None</em>, <em class="sig-param">on_prem_nat_ip=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">internal_network_ids=None</em>, <em class="sig-param">tunnel_statuses=None</em>, <em class="sig-param">encryption=None</em>, <em class="sig-param">enabled=None</em>, <em class="sig-param">state=None</em>, <em class="sig-param">dh_group=None</em>, <em class="sig-param">authentication=None</em>, <em class="sig-param">pre_shared_key=None</em>, <em class="sig-param">ike_option=None</em>, <em class="sig-param">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="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>
2018-08-07 19:42:25 -04:00
<ul>
2019-06-08 00:29:34 -04:00
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
</ul>
</p></li>
<li><p><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) </p></li>
<li><p><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>
2018-08-07 19:42:25 -04:00
<ul>
2019-06-08 00:29:34 -04:00
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</p></li>
<li><p><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>
2018-08-07 19:42:25 -04:00
<ul>
2019-06-08 00:29:34 -04:00
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
</ul>
</p></li>
<li><p><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>
2018-08-07 19:42:25 -04:00
<ul>
2019-06-08 00:29:34 -04:00
<li><p><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></p></li>
<li><p><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></p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</p></li>
<li><p><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>) </p></li>
<li><p><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>
2019-06-08 00:29:34 -04:00
<li><p><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></p></li>
<li><p><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></p></li>
</ul>
2019-06-08 00:29:34 -04:00
</p></li>
<li><p><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>
2019-06-08 00:29:34 -04:00
<li><p><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></p></li>
<li><p><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></p></li>
</ul>
2019-06-08 00:29:34 -04:00
</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Vpn.AUTHENTICATION_PSK">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Vpn.AUTHENTICATION_UNKNOWN">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Vpn.DH_GROUP_DH14">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Vpn.DH_GROUP_DH15">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Vpn.DH_GROUP_DH16">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Vpn.DH_GROUP_DH2">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Vpn.DH_GROUP_DH5">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Vpn.DH_GROUP_UNKNOWN">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Vpn.DIGEST_ALGORITHM_SHA1">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Vpn.ENCRYPTION_AES">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Vpn.ENCRYPTION_AES256">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Vpn.ENCRYPTION_AES_GCM">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Vpn.ENCRYPTION_TRIPLE_DES">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Vpn.ENCRYPTION_UNKNOWN">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Vpn.IKE_OPTION_IKEV1">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Vpn.STATE_CONNECTED">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Vpn.STATE_DISCONNECTED">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Vpn.STATE_PARTIALLY_CONNECTED">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.Vpn.STATE_UNKNOWN">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.VpnChannelStatus">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">VpnChannelStatus</code><span class="sig-paren">(</span><em class="sig-param">channel_status=None</em>, <em class="sig-param">channel_state=None</em>, <em class="sig-param">last_info_message=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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>
2018-08-07 19:42:25 -04:00
<ul>
2019-06-08 00:29:34 -04:00
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.VpnChannelStatus.CHANNEL_STATUS_CONNECTED">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.VpnChannelStatus.CHANNEL_STATUS_DISCONNECTED">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.VpnChannelStatus.CHANNEL_STATUS_UNKNOWN">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.VpnTunnelStatus">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">VpnTunnelStatus</code><span class="sig-paren">(</span><em class="sig-param">on_prem_subnet=None</em>, <em class="sig-param">traffic_stats=None</em>, <em class="sig-param">last_info_message=None</em>, <em class="sig-param">local_subnet=None</em>, <em class="sig-param">tunnel_state=None</em>, <em class="sig-param">failure_message=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>
2018-08-07 19:42:25 -04:00
<ul>
2019-06-08 00:29:34 -04:00
<li><p><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></p></li>
<li><p><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></p></li>
<li><p><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></p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.VpnTunnelStatus.TUNNEL_STATUS_CONNECTED">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.VpnTunnelStatus.TUNNEL_STATUS_DISCONNECTED">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.VpnTunnelStatus.TUNNEL_STATUS_UNKNOWN">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.VpnTunnelTrafficStats">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">VpnTunnelTrafficStats</code><span class="sig-paren">(</span><em class="sig-param">packets_out=None</em>, <em class="sig-param">packet_received_errors=None</em>, <em class="sig-param">rx_bytes_on_local_subnet=None</em>, <em class="sig-param">replay_errors=None</em>, <em class="sig-param">sequence_number_over_flow_errors=None</em>, <em class="sig-param">encryption_failures=None</em>, <em class="sig-param">integrity_errors=None</em>, <em class="sig-param">packet_sent_errors=None</em>, <em class="sig-param">decryption_failures=None</em>, <em class="sig-param">packets_in=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2018-08-07 19:42:25 -04:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
<li><p><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>) </p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.VsanAvailableCapacity">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">VsanAvailableCapacity</code><span class="sig-paren">(</span><em class="sig-param">cost=None</em>, <em class="sig-param">quality=None</em>, <em class="sig-param">size=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.VsanAvailableCapacity" title="Permalink to this definition"></a></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>Infomation about an available vSAN capacity in a cluster.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cost</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) </p></li>
<li><p><strong>quality</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) </p></li>
<li><p><strong>size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.VsanClusterReconfigBias">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">VsanClusterReconfigBias</code><span class="sig-paren">(</span><em class="sig-param">short_description=None</em>, <em class="sig-param">full_description=None</em>, <em class="sig-param">id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.VsanClusterReconfigBias" title="Permalink to this definition"></a></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>Bias for reconfiguring vSAN in a cluster.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>short_description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) </p></li>
<li><p><strong>full_description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) </p></li>
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.VsanClusterReconfigConstraints">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">VsanClusterReconfigConstraints</code><span class="sig-paren">(</span><em class="sig-param">reconfig_biases=None</em>, <em class="sig-param">available_capacities=None</em>, <em class="sig-param">default_capacities=None</em>, <em class="sig-param">hosts=None</em>, <em class="sig-param">default_reconfig_bias_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.VsanClusterReconfigConstraints" title="Permalink to this definition"></a></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>Storage constraint information for reconfiguring vSAN in existing cluster.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>reconfig_biases</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.VsanClusterReconfigBias" title="com.vmware.vmc.model_client.VsanClusterReconfigBias"><code class="xref py py-class docutils literal notranslate"><span class="pre">VsanClusterReconfigBias</span></code></a>) Biases to reconfigure vSAN in an existing cluster.</p></li>
<li><p><strong>available_capacities</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">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.VsanAvailableCapacity" title="com.vmware.vmc.model_client.VsanAvailableCapacity"><code class="xref py py-class docutils literal notranslate"><span class="pre">VsanAvailableCapacity</span></code></a>) A map of VsanClusterReconfigBias id to the list of
VsanAvailableCapacity. It gives all of available vSAN capacities
for each of reconfiguration biases.</p></li>
<li><p><strong>default_capacities</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.VsanAvailableCapacity" title="com.vmware.vmc.model_client.VsanAvailableCapacity"><code class="xref py py-class docutils literal notranslate"><span class="pre">VsanAvailableCapacity</span></code></a>) A map of VsanClusterReconfigBias id to a VsanAvailableCapacity. It
gives the default VsanAvailableCapacity for each of reconfiguration
biases.</p></li>
<li><p><strong>hosts</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) The number of hosts in a cluster for the constraints. format: int32</p></li>
<li><p><strong>default_reconfig_bias_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The id of default VsanClusterReconfigBias for this constraints.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
2019-01-16 05:37:32 -05:00
<dl class="class">
<dt id="com.vmware.vmc.model_client.VsanConfigConstraints">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">VsanConfigConstraints</code><span class="sig-paren">(</span><em class="sig-param">max_capacity=None</em>, <em class="sig-param">recommended_capacities=None</em>, <em class="sig-param">supported_capacity_increment=None</em>, <em class="sig-param">min_capacity=None</em>, <em class="sig-param">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>
2019-01-16 05:37:32 -05:00
<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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
2019-01-16 05:37:32 -05:00
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
<li><p><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</p></li>
2019-01-16 05:37:32 -05:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2019-01-16 05:37:32 -05:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.VsanEncryptionConfig">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">VsanEncryptionConfig</code><span class="sig-paren">(</span><em class="sig-param">port=None</em>, <em class="sig-param">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">
2019-06-08 00:29:34 -04:00
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>port</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Port to connect to AWS Key Management Service</p></li>
<li><p><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</p></li>
</ul>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
</dd></dl>
2018-08-07 19:42:25 -04:00
</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">
2019-01-16 05:37:32 -05:00
<dt id="com.vmware.vmc.orgs_client.AccountLink">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs_client.</code><code class="sig-name descname">AccountLink</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs_client.AccountLink" title="Permalink to this definition"></a></dt>
2018-08-07 19:42:25 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
<dl class="method">
2019-01-16 05:37:32 -05:00
<dt id="com.vmware.vmc.orgs_client.AccountLink.get">
2019-06-08 00:29:34 -04:00
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">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>
2019-01-16 05:37:32 -05:00
<dd><p>Gets a link that can be used on a customers account to start the
linking process.</p>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Organization identifier. (required)</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
Generic Error</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.orgs_client.PaymentMethods">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs_client.</code><code class="sig-name descname">PaymentMethods</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs_client.PaymentMethods" title="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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="method">
<dt id="com.vmware.vmc.orgs_client.PaymentMethods.get_org_payment_methods">
<code class="sig-name descname">get_org_payment_methods</code><span class="sig-paren">(</span><em class="sig-param">org</em>, <em class="sig-param">default_flag=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs_client.PaymentMethods.get_org_payment_methods" title="Permalink to this definition"></a></dt>
<dd><p>Get payment methods of organization</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Organization identifier. (required)</p></li>
<li><p><strong>default_flag</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>) When true, will only return default payment methods. (optional,
default to false)</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.PaymentMethodInfo" title="com.vmware.vmc.model_client.PaymentMethodInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.PaymentMethodInfo</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p></p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
Unauthorized</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Organization doesnt exist</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
2018-08-07 19:42:25 -04:00
<dl class="class">
<dt id="com.vmware.vmc.orgs_client.Providers">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs_client.</code><code class="sig-name descname">Providers</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs_client.Providers" title="Permalink to this definition"></a></dt>
2018-08-07 19:42:25 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
<dl class="method">
<dt id="com.vmware.vmc.orgs_client.Providers.list">
2019-06-08 00:29:34 -04:00
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">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><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Organization identifier. (required)</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><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></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p></p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
Unauthorized</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Organization doesnt exist</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.orgs_client.Reservations">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs_client.</code><code class="sig-name descname">Reservations</code><span class="sig-paren">(</span><em class="sig-param">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>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="method">
<dt id="com.vmware.vmc.orgs_client.Reservations.list">
2019-06-08 00:29:34 -04:00
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">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>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Organization identifier. (required)</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><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></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p></p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
Unauthorized</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><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>
</dd>
</dl>
</dd></dl>
</dd></dl>
2018-08-07 19:42:25 -04:00
<dl class="class">
<dt id="com.vmware.vmc.orgs_client.SddcTemplates">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs_client.</code><code class="sig-name descname">SddcTemplates</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs_client.SddcTemplates" title="Permalink to this definition"></a></dt>
2018-08-07 19:42:25 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
<dl class="method">
<dt id="com.vmware.vmc.orgs_client.SddcTemplates.delete">
2019-06-08 00:29:34 -04:00
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param">org</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<dd><p>Delete SDDC template identified by given id.</p>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Organization identifier. (required)</p></li>
<li><p><strong>template_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) SDDC Template identifier (required)</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><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>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.vmc.model.Task</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
2019-01-16 05:37:32 -05:00
Unauthorized</p>
2019-06-08 00:29:34 -04:00
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
2019-01-16 05:37:32 -05:00
Forbidden</p>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="method">
<dt id="com.vmware.vmc.orgs_client.SddcTemplates.get">
2019-06-08 00:29:34 -04:00
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">org</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<dd><p>Get configuration template by given template id.</p>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Organization identifier. (required)</p></li>
<li><p><strong>template_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) SDDC Template identifier (required)</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><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>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.vmc.model.SddcTemplate</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
2019-01-16 05:37:32 -05:00
Unauthorized</p>
2019-06-08 00:29:34 -04:00
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
2019-01-16 05:37:32 -05:00
Forbidden</p>
2019-06-08 00:29:34 -04:00
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
2019-01-16 05:37:32 -05:00
Cannot find the SDDC Template with given identifier</p>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="method">
<dt id="com.vmware.vmc.orgs_client.SddcTemplates.list">
2019-06-08 00:29:34 -04:00
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<dd><p>List all available SDDC configuration templates in an organization</p>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Organization identifier. (required)</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><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></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p></p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
Unauthorized</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.orgs_client.Sddcs">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs_client.</code><code class="sig-name descname">Sddcs</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs_client.Sddcs" title="Permalink to this definition"></a></dt>
2018-08-07 19:42:25 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
<dl class="method">
<dt id="com.vmware.vmc.orgs_client.Sddcs.create">
2019-07-15 08:32:15 -04:00
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param">org</em>, <em class="sig-param">sddc_config</em>, <em class="sig-param">validate_only=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs_client.Sddcs.create" title="Permalink to this definition"></a></dt>
2018-08-07 19:42:25 -04:00
<dd><p>Provision an SDDC in target cloud</p>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Organization identifier. (required)</p></li>
<li><p><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)</p></li>
2019-07-15 08:32:15 -04:00
<li><p><strong>validate_only</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>) When true, only validates the given sddc configuration without
provisioning. (optional)</p></li>
2019-06-08 00:29:34 -04:00
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><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>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.vmc.model.Task</p>
</dd>
2019-06-08 00:29:34 -04:00
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
2019-01-16 05:37:32 -05:00
Unauthorized</p>
2019-06-08 00:29:34 -04:00
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
2019-01-16 05:37:32 -05:00
Forbidden</p>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="method">
<dt id="com.vmware.vmc.orgs_client.Sddcs.delete">
2019-06-08 00:29:34 -04:00
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param">org</em>, <em class="sig-param">sddc</em>, <em class="sig-param">retain_configuration=None</em>, <em class="sig-param">template_name=None</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<dd><p>Delete SDDC</p>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Organization identifier. (required)</p></li>
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Sddc Identifier. (required)</p></li>
<li><p><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 SDDCs configuration is retained as a template for
2018-08-07 19:42:25 -04:00
later use. This flag is applicable only to SDDCs in ACTIVE state.
2019-06-08 00:29:34 -04:00
(optional)</p></li>
<li><p><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.
2018-08-07 19:42:25 -04:00
When set, this value will be used as the name of the SDDC
2019-06-08 00:29:34 -04:00
configuration template generated. (optional)</p></li>
<li><p><strong>force</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, will delete forcefully. Beware: do not use the force
flag if there is a chance an active provisioning or deleting task
2019-06-08 00:29:34 -04:00
is running against this SDDC. This option is restricted. (optional)</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><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>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.vmc.model.Task</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
2019-01-16 05:37:32 -05:00
Unauthorized</p>
2019-06-08 00:29:34 -04:00
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
2018-08-07 19:42:25 -04:00
The sddc is not in a state thats valid for deletion</p>
2019-06-08 00:29:34 -04:00
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
2018-08-07 19:42:25 -04:00
Access not allowed to the operation for the current user</p>
2019-06-08 00:29:34 -04:00
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
2018-08-07 19:42:25 -04:00
Cannot find the SDDC with given identifier</p>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="method">
<dt id="com.vmware.vmc.orgs_client.Sddcs.get">
2019-06-08 00:29:34 -04:00
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">org</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<dd><p>Get SDDC</p>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Organization identifier. (required)</p></li>
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Sddc Identifier. (required)</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><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>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.vmc.model.Sddc</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
2019-01-16 05:37:32 -05:00
Unauthorized</p>
2019-06-08 00:29:34 -04:00
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
2019-01-16 05:37:32 -05:00
Forbidden</p>
2019-06-08 00:29:34 -04:00
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
2019-01-16 05:37:32 -05:00
Cannot find the SDDC with given identifier</p>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="method">
<dt id="com.vmware.vmc.orgs_client.Sddcs.list">
2019-07-04 06:14:34 -04:00
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">org</em>, <em class="sig-param">include_deleted=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs_client.Sddcs.list" title="Permalink to this definition"></a></dt>
2018-08-07 19:42:25 -04:00
<dd><p>List all the SDDCs of an organization</p>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
2019-07-04 06:14:34 -04:00
<dd class="field-odd"><ul class="simple">
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Organization identifier. (required)</p></li>
<li><p><strong>include_deleted</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>) When true, forces the result to also include deleted SDDCs.
(optional)</p></li>
</ul>
2019-06-08 00:29:34 -04:00
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><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></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p></p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
Unauthorized</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
</dl>
2019-05-29 06:01:09 -04:00
</dd></dl>
<dl class="method">
<dt id="com.vmware.vmc.orgs_client.Sddcs.patch">
2019-06-08 00:29:34 -04:00
<code class="sig-name descname">patch</code><span class="sig-paren">(</span><em class="sig-param">org</em>, <em class="sig-param">sddc</em>, <em class="sig-param">sddc_patch_request</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs_client.Sddcs.patch" title="Permalink to this definition"></a></dt>
2019-05-29 06:01:09 -04:00
<dd><p>Patch SDDC</p>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Organization identifier. (required)</p></li>
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Sddc Identifier. (required)</p></li>
<li><p><strong>sddc_patch_request</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.SddcPatchRequest" title="com.vmware.vmc.model_client.SddcPatchRequest"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.SddcPatchRequest</span></code></a>) Patch request for the SDDC (required)</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><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>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.vmc.model.Sddc</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
2019-05-29 06:01:09 -04:00
Unauthorized</p>
2019-06-08 00:29:34 -04:00
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
2019-05-29 06:01:09 -04:00
SDDC cannot be patched</p>
2019-06-08 00:29:34 -04:00
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
2019-05-29 06:01:09 -04:00
Forbidden</p>
2019-06-08 00:29:34 -04:00
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
2019-05-29 06:01:09 -04:00
Cannot find the SDDC with given identifier</p>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.orgs_client.StubFactory">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Stub config instance</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.orgs_client.Subscriptions">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs_client.</code><code class="sig-name descname">Subscriptions</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs_client.Subscriptions" title="Permalink to this definition"></a></dt>
2018-08-07 19:42:25 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
<dl class="attribute">
<dt id="com.vmware.vmc.orgs_client.Subscriptions.GET_0_OFFER_TYPE_ON_DEMAND">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<code class="sig-name 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>
2018-08-07 19:42:25 -04:00
<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">
2019-06-08 00:29:34 -04:00
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param">org</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<dd><p>Initiates the creation of a subscription</p>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Organization identifier. (required)</p></li>
<li><p><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)</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><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>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.vmc.model.Task</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
2019-01-16 05:37:32 -05:00
Unauthorized</p>
2019-06-08 00:29:34 -04:00
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
2018-08-07 19:42:25 -04:00
Forbidden</p>
2019-06-08 00:29:34 -04:00
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
2019-01-16 05:37:32 -05:00
Server error. Check retryable flag to see if request should be
retried.</p>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="method">
<dt id="com.vmware.vmc.orgs_client.Subscriptions.get">
2019-06-08 00:29:34 -04:00
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">org</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<dd><p>Get subscription details for a given subscription id</p>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Organization identifier. (required)</p></li>
<li><p><strong>subscription</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) SubscriptionId for an sddc. (required)</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><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>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.vmc.model.SubscriptionDetails</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
2018-08-07 19:42:25 -04:00
Server error. Check retryable flag to see if request should be
retried.</p>
2019-06-08 00:29:34 -04:00
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
2018-08-07 19:42:25 -04:00
Not Found</p>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="method">
<dt id="com.vmware.vmc.orgs_client.Subscriptions.get_0">
2019-06-08 00:29:34 -04:00
<code class="sig-name descname">get_0</code><span class="sig-paren">(</span><em class="sig-param">org</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<dd><p>Returns all subscriptions for a given org id</p>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Organization identifier. (required)</p></li>
<li><p><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
2019-06-08 00:29:34 -04:00
specified (optional)</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">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>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p></p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
2019-01-16 05:37:32 -05:00
Unauthorized</p>
2019-06-08 00:29:34 -04:00
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
2018-08-07 19:42:25 -04:00
Server error. Check retryable flag to see if request should be
retried.</p>
2019-06-08 00:29:34 -04:00
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
2018-08-07 19:42:25 -04:00
Not Found</p>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.orgs_client.Tasks">
2019-06-08 00:29:34 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs_client.</code><code class="sig-name descname">Tasks</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs_client.Tasks" title="Permalink to this definition"></a></dt>
2018-08-07 19:42:25 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
<dl class="method">
<dt id="com.vmware.vmc.orgs_client.Tasks.get">
2019-06-08 00:29:34 -04:00
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">org</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<dd><p>Retrieve details of a task.</p>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Organization identifier. (required)</p></li>
<li><p><strong>task</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Task identifier (required)</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><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>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.vmc.model.Task</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
2019-01-16 05:37:32 -05:00
Unauthorized</p>
2019-06-08 00:29:34 -04:00
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
2019-01-16 05:37:32 -05:00
Forbidden</p>
2019-06-08 00:29:34 -04:00
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
2019-01-16 05:37:32 -05:00
Cannot find the task with given identifier</p>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="method">
<dt id="com.vmware.vmc.orgs_client.Tasks.list">
2019-06-08 00:29:34 -04:00
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">org</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<dd><p>List all tasks with optional filtering.</p>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Organization identifier. (required)</p></li>
<li><p><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
2019-01-16 05:37:32 -05:00
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)
2019-06-08 00:29:34 -04:00
and (sddc.status eq READY) (optional)</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><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>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p></p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
2019-01-16 05:37:32 -05:00
Unauthorized</p>
2019-06-08 00:29:34 -04:00
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
2019-01-16 05:37:32 -05:00
Forbidden</p>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="method">
<dt id="com.vmware.vmc.orgs_client.Tasks.update">
2019-06-08 00:29:34 -04:00
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">org</em>, <em class="sig-param">task</em>, <em class="sig-param">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>
2018-08-07 19:42:25 -04:00
<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>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Organization identifier. (required)</p></li>
<li><p><strong>task</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Task identifier (required)</p></li>
<li><p><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)</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><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>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.vmc.model.Task</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
2019-01-16 05:37:32 -05:00
Unauthorized</p>
2019-06-08 00:29:34 -04:00
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
2018-08-07 19:42:25 -04:00
Invalid action or bad argument</p>
2019-06-08 00:29:34 -04:00
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
2018-08-07 19:42:25 -04:00
Forbidden</p>
2019-06-08 00:29:34 -04:00
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
2018-08-07 19:42:25 -04:00
Cannot find the task with given identifier</p>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</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>
2019-05-29 06:01:09 -04:00
<a href="com.vmware.html" class="btn btn-neutral float-left" title="com.vmware package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
2018-08-07 19:42:25 -04:00
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2020, VMware, Inc.
2018-08-07 19:42:25 -04:00
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
2019-05-29 06:01:09 -04:00
</script>
2018-08-07 19:42:25 -04:00
</body>
</html>