Mirrors/vsphere-automation-sdk-python
1
0
Fork 0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-26 03:10:00 -05:00
Code
8ccc089bd0
vsphere-automation-sdk-python/nsx/nsx_vmc_aws_integration/com.vmware.nsx_vmc_app.html
Gordon Good 7e64cf84f1 Move nsx python API docs into correct directories. 
Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-23 20:28:40 -07:00

3940 lines
433 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com.vmware.nsx_vmc_app package &mdash; NSX VMC AWS Integration API 3.0.2.0.0 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="com.vmware.nsx_vmc_app.infra package" href="com.vmware.nsx_vmc_app.infra.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">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home" alt="Documentation Home"> NSX VMC AWS Integration API
</a>
<div class="version">
3.0.2.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.nsx_vmc_app_client">com.vmware.nsx_vmc_app_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-nsx-vmc-app-client-for-vmc-module">com.vmware.nsx_vmc_app_client_for_vmc module</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">NSX VMC AWS Integration API</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></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.nsx_vmc_app package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/com.vmware.nsx_vmc_app.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.nsx_vmc_app">
<span id="com-vmware-nsx-vmc-app-package"></span><h1>com.vmware.nsx_vmc_app package<a class="headerlink" href="#module-com.vmware.nsx_vmc_app" 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.nsx_vmc_app.infra.html">com.vmware.nsx_vmc_app.infra package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.nsx_vmc_app.infra.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.nsx_vmc_app.infra.direct_connect.html">com.vmware.nsx_vmc_app.infra.direct_connect package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.nsx_vmc_app.infra.direct_connect.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.nsx_vmc_app.infra.direct_connect.html#module-com.vmware.nsx_vmc_app.infra.direct_connect.routes_client">com.vmware.nsx_vmc_app.infra.direct_connect.routes_client module</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.nsx_vmc_app.infra.external.html">com.vmware.nsx_vmc_app.infra.external package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.nsx_vmc_app.infra.external.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.nsx_vmc_app.infra.external.html#module-com.vmware.nsx_vmc_app.infra.external.routes_client">com.vmware.nsx_vmc_app.infra.external.routes_client module</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.nsx_vmc_app.infra.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.nsx_vmc_app.infra.html#module-com.vmware.nsx_vmc_app.infra.direct_connect_client">com.vmware.nsx_vmc_app.infra.direct_connect_client module</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.nsx_vmc_app.infra.html#module-com.vmware.nsx_vmc_app.infra.external_client">com.vmware.nsx_vmc_app.infra.external_client module</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.nsx_vmc_app.infra.html#module-com.vmware.nsx_vmc_app.infra.linked_vpcs_client">com.vmware.nsx_vmc_app.infra.linked_vpcs_client module</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.nsx_vmc_app.infra.html#module-com.vmware.nsx_vmc_app.infra.realized_state_client">com.vmware.nsx_vmc_app.infra.realized_state_client module</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.nsx_vmc_app.infra.html#module-com.vmware.nsx_vmc_app.infra.traffic_groups_client">com.vmware.nsx_vmc_app.infra.traffic_groups_client module</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="module-com.vmware.nsx_vmc_app.infra_client">
<span id="com-vmware-nsx-vmc-app-infra-client-module"></span><h2>com.vmware.nsx_vmc_app.infra_client module<a class="headerlink" href="#module-com.vmware.nsx_vmc_app.infra_client" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.infra_client.Accounts">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.infra_client.</code><code class="sig-name descname">Accounts</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.infra_client.Accounts" title="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="py method">
<dt id="com.vmware.nsx_vmc_app.infra_client.Accounts.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.infra_client.Accounts.get" title="Permalink to this definition"></a></dt>
<dd><p>Retrieve the shadow account and linked VPC account information from VMC
provider. This API is a live query to VMC provider.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.VMCAccounts" title="com.vmware.nsx_vmc_app.model_client.VMCAccounts"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_vmc_app.model_client.VMCAccounts</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>com.vmware.nsx_vmc_app.model.VMCAccounts</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.ServiceUnavailable</span></code>
Service Unavailable</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.InvalidRequest</span></code>
Bad Request, Precondition Failed</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.InternalServerError</span></code>
Internal Server Error</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.Unauthorized</span></code>
Forbidden</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.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.infra_client.AssociatedGroups">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.infra_client.</code><code class="sig-name descname">AssociatedGroups</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.infra_client.AssociatedGroups" title="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="py method">
<dt id="com.vmware.nsx_vmc_app.infra_client.AssociatedGroups.delete">
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">sddc_group_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.infra_client.AssociatedGroups.delete" title="Permalink to this definition"></a></dt>
<dd><p>Delete the associated Group connection info for the local SDDC before
removing the SDDC from the Group.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>sddc_group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (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.ServiceUnavailable</span></code>
Service Unavailable</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.InvalidRequest</span></code>
Bad Request, Precondition Failed</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>
Internal Server Error</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>
Not Found</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.nsx_vmc_app.infra_client.AssociatedGroups.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">sddc_group_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.infra_client.AssociatedGroups.get" title="Permalink to this definition"></a></dt>
<dd><p>The API is used to get the associated Group connection info for the
local SDDC. It returns the run time attachment state for the local
SDDC, others infomations are from DB.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>sddc_group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_vmc_app.model.AssociatedBaseGroupConnectionInfo
The return value will contain all the attributes defined in
<a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.AssociatedBaseGroupConnectionInfo" title="com.vmware.nsx_vmc_app.model_client.AssociatedBaseGroupConnectionInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_vmc_app.model_client.AssociatedBaseGroupConnectionInfo</span></code></a>.</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.ServiceUnavailable</span></code>
Service Unavailable</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.InvalidRequest</span></code>
Bad Request, Precondition Failed</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>
Internal Server Error</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>
Not Found</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.nsx_vmc_app.infra_client.AssociatedGroups.list">
<code class="sig-name descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.infra_client.AssociatedGroups.list" title="Permalink to this definition"></a></dt>
<dd><p>This API is used to list all associated Group connection infos for the
local SDDC. It returns the run time attachment state for the local
SDDC, others infomations are from DB.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.AssociatedGroupConnectionInfosListResult" title="com.vmware.nsx_vmc_app.model_client.AssociatedGroupConnectionInfosListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_vmc_app.model_client.AssociatedGroupConnectionInfosListResult</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>com.vmware.nsx_vmc_app.model.AssociatedGroupConnectionInfosListResult</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.ServiceUnavailable</span></code>
Service Unavailable</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.InvalidRequest</span></code>
Bad Request, Precondition Failed</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.InternalServerError</span></code>
Internal Server Error</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.Unauthorized</span></code>
Forbidden</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.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.nsx_vmc_app.infra_client.AssociatedGroups.update">
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">sddc_group_id</span></em>, <em class="sig-param"><span class="n">associated_base_group_connection_info</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.infra_client.AssociatedGroups.update" title="Permalink to this definition"></a></dt>
<dd><p>Create or update the associated Group connection info for reflecting
the SDDC’s association state with SDDC group.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>sddc_group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>associated_base_group_connection_info</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code>) – (required)
The parameter must contain all the attributes defined in
<a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.AssociatedBaseGroupConnectionInfo" title="com.vmware.nsx_vmc_app.model_client.AssociatedBaseGroupConnectionInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_vmc_app.model_client.AssociatedBaseGroupConnectionInfo</span></code></a>.</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">vmware.vapi.struct.VapiStruct</span></code></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_vmc_app.model.AssociatedBaseGroupConnectionInfo
The return value will contain all the attributes defined in
<a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.AssociatedBaseGroupConnectionInfo" title="com.vmware.nsx_vmc_app.model_client.AssociatedBaseGroupConnectionInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_vmc_app.model_client.AssociatedBaseGroupConnectionInfo</span></code></a>.</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.ServiceUnavailable</span></code>
Service Unavailable</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.InvalidRequest</span></code>
Bad Request, Precondition Failed</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>
Internal Server Error</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>
Not Found</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.infra_client.FeatureFlags">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.infra_client.</code><code class="sig-name descname">FeatureFlags</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.infra_client.FeatureFlags" title="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="py method">
<dt id="com.vmware.nsx_vmc_app.infra_client.FeatureFlags.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">internal_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.infra_client.FeatureFlags.get" title="Permalink to this definition"></a></dt>
<dd><p>Get vmc environment feature flags</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>internal_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>) – internal feature name (optional)</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>) – feature name (optional)</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.VmcFeatureFlags" title="com.vmware.nsx_vmc_app.model_client.VmcFeatureFlags"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_vmc_app.model_client.VmcFeatureFlags</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_vmc_app.model.VmcFeatureFlags</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.ServiceUnavailable</span></code>
Service Unavailable</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.InvalidRequest</span></code>
Bad Request, Precondition Failed</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>
Internal Server Error</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>
Not Found</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.infra_client.LinkedVpcs">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.infra_client.</code><code class="sig-name descname">LinkedVpcs</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.infra_client.LinkedVpcs" title="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="py method">
<dt id="com.vmware.nsx_vmc_app.infra_client.LinkedVpcs.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">linked_vpc_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.infra_client.LinkedVpcs.get" title="Permalink to this definition"></a></dt>
<dd><p>Get linked VPC information associated with given ID.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>linked_vpc_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.LinkedVpcInfo" title="com.vmware.nsx_vmc_app.model_client.LinkedVpcInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_vmc_app.model_client.LinkedVpcInfo</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_vmc_app.model.LinkedVpcInfo</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.ServiceUnavailable</span></code>
Service Unavailable</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.InvalidRequest</span></code>
Bad Request, Precondition Failed</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>
Internal Server Error</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>
Not Found</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.nsx_vmc_app.infra_client.LinkedVpcs.list">
<code class="sig-name descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.infra_client.LinkedVpcs.list" title="Permalink to this definition"></a></dt>
<dd><p>List all linked VPC information.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.LinkedVpcsListResult" title="com.vmware.nsx_vmc_app.model_client.LinkedVpcsListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_vmc_app.model_client.LinkedVpcsListResult</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>com.vmware.nsx_vmc_app.model.LinkedVpcsListResult</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.ServiceUnavailable</span></code>
Service Unavailable</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.InvalidRequest</span></code>
Bad Request, Precondition Failed</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.InternalServerError</span></code>
Internal Server Error</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.Unauthorized</span></code>
Forbidden</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.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.infra_client.MgmtVms">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.infra_client.</code><code class="sig-name descname">MgmtVms</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.infra_client.MgmtVms" title="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="py method">
<dt id="com.vmware.nsx_vmc_app.infra_client.MgmtVms.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.infra_client.MgmtVms.get" title="Permalink to this definition"></a></dt>
<dd><p>Get management VM access information.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>vm_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.MgmtVmInfo" title="com.vmware.nsx_vmc_app.model_client.MgmtVmInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_vmc_app.model_client.MgmtVmInfo</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_vmc_app.model.MgmtVmInfo</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.ServiceUnavailable</span></code>
Service Unavailable</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.InvalidRequest</span></code>
Bad Request, Precondition Failed</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>
Internal Server Error</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>
Not Found</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.nsx_vmc_app.infra_client.MgmtVms.list">
<code class="sig-name descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.infra_client.MgmtVms.list" title="Permalink to this definition"></a></dt>
<dd><p>List Management VM information.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.MgmtVmsListResult" title="com.vmware.nsx_vmc_app.model_client.MgmtVmsListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_vmc_app.model_client.MgmtVmsListResult</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>com.vmware.nsx_vmc_app.model.MgmtVmsListResult</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.ServiceUnavailable</span></code>
Service Unavailable</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.InvalidRequest</span></code>
Bad Request, Precondition Failed</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.InternalServerError</span></code>
Internal Server Error</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.Unauthorized</span></code>
Forbidden</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.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.infra_client.PublicIps">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.infra_client.</code><code class="sig-name descname">PublicIps</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.infra_client.PublicIps" title="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="py method">
<dt id="com.vmware.nsx_vmc_app.infra_client.PublicIps.delete">
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">public_ip_id</span></em>, <em class="sig-param"><span class="n">force</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.infra_client.PublicIps.delete" title="Permalink to this definition"></a></dt>
<dd><p>Delete a public IP. The IP will be released in VMC provider.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>public_ip_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</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>) – Force delete the resource even if it is being used somewhere
(optional, default to false)</p></li>
</ul>
</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.ServiceUnavailable</span></code>
Service Unavailable</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.InvalidRequest</span></code>
Bad Request, Precondition Failed</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>
Internal Server Error</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>
Not Found</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.nsx_vmc_app.infra_client.PublicIps.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">public_ip_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.infra_client.PublicIps.get" title="Permalink to this definition"></a></dt>
<dd><p>Get public IP information associated with given ID.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>public_ip_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.PublicIp" title="com.vmware.nsx_vmc_app.model_client.PublicIp"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_vmc_app.model_client.PublicIp</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_vmc_app.model.PublicIp</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.ServiceUnavailable</span></code>
Service Unavailable</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.InvalidRequest</span></code>
Bad Request, Precondition Failed</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>
Internal Server Error</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>
Not Found</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.nsx_vmc_app.infra_client.PublicIps.list">
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cursor</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">included_fields</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">page_size</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_ascending</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_by</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.infra_client.PublicIps.list" title="Permalink to this definition"></a></dt>
<dd><p>List all public IPs obtained in the SDDC.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
by current result page) (optional)</p></li>
<li><p><strong>included_fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Comma separated list of fields that should be included in query
result (optional)</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>) – Maximum number of results to return in this page (server may return
fewer) (optional, default to 1000)</p></li>
<li><p><strong>sort_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>) – (optional)</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>) – Field by which records are sorted (optional)</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.PublicIpsListResult" title="com.vmware.nsx_vmc_app.model_client.PublicIpsListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_vmc_app.model_client.PublicIpsListResult</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_vmc_app.model.PublicIpsListResult</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.ServiceUnavailable</span></code>
Service Unavailable</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.InvalidRequest</span></code>
Bad Request, Precondition Failed</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>
Internal Server Error</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>
Not Found</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.nsx_vmc_app.infra_client.PublicIps.update">
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">public_ip_id</span></em>, <em class="sig-param"><span class="n">public_ip</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.infra_client.PublicIps.update" title="Permalink to this definition"></a></dt>
<dd><p>This API is used to create or update a public IP. In creating, the API
allocates a new public IP from VMC provider. In updating, only the
display name can be modified, the IP is read-only.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>public_ip_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>public_ip</strong> (<a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.PublicIp" title="com.vmware.nsx_vmc_app.model_client.PublicIp"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_vmc_app.model_client.PublicIp</span></code></a>) – (required)</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.PublicIp" title="com.vmware.nsx_vmc_app.model_client.PublicIp"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_vmc_app.model_client.PublicIp</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_vmc_app.model.PublicIp</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.ServiceUnavailable</span></code>
Service Unavailable</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.InvalidRequest</span></code>
Bad Request, Precondition Failed</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>
Internal Server Error</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>
Not Found</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.infra_client.SddcUserConfig">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.infra_client.</code><code class="sig-name descname">SddcUserConfig</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.infra_client.SddcUserConfig" title="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="py method">
<dt id="com.vmware.nsx_vmc_app.infra_client.SddcUserConfig.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.infra_client.SddcUserConfig.get" title="Permalink to this definition"></a></dt>
<dd><p>Get the user-level SDDC configuration parameters</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.SddcUserConfiguration" title="com.vmware.nsx_vmc_app.model_client.SddcUserConfiguration"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_vmc_app.model_client.SddcUserConfiguration</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>com.vmware.nsx_vmc_app.model.SddcUserConfiguration</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.ServiceUnavailable</span></code>
Service Unavailable</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.InvalidRequest</span></code>
Bad Request, Precondition Failed</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.InternalServerError</span></code>
Internal Server Error</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.Unauthorized</span></code>
Forbidden</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.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.infra_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.infra_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.infra_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.infra_client.TrafficGroups">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.infra_client.</code><code class="sig-name descname">TrafficGroups</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.infra_client.TrafficGroups" title="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="py attribute">
<dt id="com.vmware.nsx_vmc_app.infra_client.TrafficGroups.CREATE_ACTION_END_RESTORE">
<code class="sig-name descname">CREATE_ACTION_END_RESTORE</code><em class="property"> = 'END_RESTORE'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.infra_client.TrafficGroups.CREATE_ACTION_END_RESTORE" title="Permalink to this definition"></a></dt>
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">action</span></code> of method <a class="reference internal" href="#com.vmware.nsx_vmc_app.infra_client.TrafficGroups.create" title="com.vmware.nsx_vmc_app.infra_client.TrafficGroups.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">TrafficGroups.create()</span></code></a>.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.infra_client.TrafficGroups.CREATE_ACTION_SET_RESOURCE_STATUS_FAILURE">
<code class="sig-name descname">CREATE_ACTION_SET_RESOURCE_STATUS_FAILURE</code><em class="property"> = 'SET_RESOURCE_STATUS_FAILURE'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.infra_client.TrafficGroups.CREATE_ACTION_SET_RESOURCE_STATUS_FAILURE" title="Permalink to this definition"></a></dt>
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">action</span></code> of method <a class="reference internal" href="#com.vmware.nsx_vmc_app.infra_client.TrafficGroups.create" title="com.vmware.nsx_vmc_app.infra_client.TrafficGroups.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">TrafficGroups.create()</span></code></a>.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.infra_client.TrafficGroups.CREATE_ACTION_SET_RESOURCE_STATUS_SUCCESS">
<code class="sig-name descname">CREATE_ACTION_SET_RESOURCE_STATUS_SUCCESS</code><em class="property"> = 'SET_RESOURCE_STATUS_SUCCESS'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.infra_client.TrafficGroups.CREATE_ACTION_SET_RESOURCE_STATUS_SUCCESS" title="Permalink to this definition"></a></dt>
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">action</span></code> of method <a class="reference internal" href="#com.vmware.nsx_vmc_app.infra_client.TrafficGroups.create" title="com.vmware.nsx_vmc_app.infra_client.TrafficGroups.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">TrafficGroups.create()</span></code></a>.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.infra_client.TrafficGroups.CREATE_ACTION_START_RESTORE">
<code class="sig-name descname">CREATE_ACTION_START_RESTORE</code><em class="property"> = 'START_RESTORE'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.infra_client.TrafficGroups.CREATE_ACTION_START_RESTORE" title="Permalink to this definition"></a></dt>
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">action</span></code> of method <a class="reference internal" href="#com.vmware.nsx_vmc_app.infra_client.TrafficGroups.create" title="com.vmware.nsx_vmc_app.infra_client.TrafficGroups.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">TrafficGroups.create()</span></code></a>.</p>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.nsx_vmc_app.infra_client.TrafficGroups.create">
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">traffic_group_id</span></em>, <em class="sig-param"><span class="n">action_message</span></em>, <em class="sig-param"><span class="n">action</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.infra_client.TrafficGroups.create" title="Permalink to this definition"></a></dt>
<dd><p>Perform an action on a Traffic Group</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>traffic_group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>action_message</strong> (<a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ActionMessage" title="com.vmware.nsx_vmc_app.model_client.ActionMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_vmc_app.model_client.ActionMessage</span></code></a>) – (required)</p></li>
<li><p><strong>action</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Action performed on the Traffic Group (required)</p></li>
</ul>
</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.ServiceUnavailable</span></code>
Service Unavailable</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.InvalidRequest</span></code>
Bad Request, Precondition Failed</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>
Internal Server Error</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>
Not Found</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.nsx_vmc_app.infra_client.TrafficGroups.delete">
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">traffic_group_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.infra_client.TrafficGroups.delete" title="Permalink to this definition"></a></dt>
<dd><p>Delete the Traffic Group, disassociate the prefix list with the traffic
group.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>traffic_group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (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.ServiceUnavailable</span></code>
Service Unavailable</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.InvalidRequest</span></code>
Bad Request, Precondition Failed</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>
Internal Server Error</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>
Not Found</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.nsx_vmc_app.infra_client.TrafficGroups.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">traffic_group_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.infra_client.TrafficGroups.get" title="Permalink to this definition"></a></dt>
<dd><p>Get the traffic group information by traffic group ID.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>traffic_group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.TrafficGroup" title="com.vmware.nsx_vmc_app.model_client.TrafficGroup"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_vmc_app.model_client.TrafficGroup</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_vmc_app.model.TrafficGroup</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.ServiceUnavailable</span></code>
Service Unavailable</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.InvalidRequest</span></code>
Bad Request, Precondition Failed</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>
Internal Server Error</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>
Not Found</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.nsx_vmc_app.infra_client.TrafficGroups.list">
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">verbose</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.infra_client.TrafficGroups.list" title="Permalink to this definition"></a></dt>
<dd><p>A list of all traffic groups, which are associated with prefix lists.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>verbose</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>) – Verbose info requested (optional, default to false)</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.TrafficGroupsListResult" title="com.vmware.nsx_vmc_app.model_client.TrafficGroupsListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_vmc_app.model_client.TrafficGroupsListResult</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_vmc_app.model.TrafficGroupsListResult</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.ServiceUnavailable</span></code>
Service Unavailable</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.InvalidRequest</span></code>
Bad Request, Precondition Failed</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>
Internal Server Error</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>
Not Found</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.nsx_vmc_app.infra_client.TrafficGroups.update">
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">traffic_group_id</span></em>, <em class="sig-param"><span class="n">traffic_group</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.infra_client.TrafficGroups.update" title="Permalink to this definition"></a></dt>
<dd><p>This API is used to create or update a traffic group, a Prefix List is
associated to the traffic group.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>traffic_group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – traffic group id (required)</p></li>
<li><p><strong>traffic_group</strong> (<a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.TrafficGroup" title="com.vmware.nsx_vmc_app.model_client.TrafficGroup"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_vmc_app.model_client.TrafficGroup</span></code></a>) – (required)</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.TrafficGroup" title="com.vmware.nsx_vmc_app.model_client.TrafficGroup"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_vmc_app.model_client.TrafficGroup</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_vmc_app.model.TrafficGroup</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.ServiceUnavailable</span></code>
Service Unavailable</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.InvalidRequest</span></code>
Bad Request, Precondition Failed</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>
Internal Server Error</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>
Not Found</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.nsx_vmc_app.model_client">
<span id="com-vmware-nsx-vmc-app-model-client-module"></span><h2>com.vmware.nsx_vmc_app.model_client module<a class="headerlink" href="#module-com.vmware.nsx_vmc_app.model_client" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.ActionMessage">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">ActionMessage</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">message</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.ActionMessage" title="Permalink to this definition"></a></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>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>) – Optional message for action</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.AdvertisedRoute">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">AdvertisedRoute</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">advertisement_state</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">ipv4_cidr</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.AdvertisedRoute" title="Permalink to this definition"></a></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>Advertised BGP route</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>advertisement_state</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Possible values are:</p>
<ul>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.AdvertisedRoute.ADVERTISEMENT_STATE_SUCCESS" title="com.vmware.nsx_vmc_app.model_client.AdvertisedRoute.ADVERTISEMENT_STATE_SUCCESS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">AdvertisedRoute.ADVERTISEMENT_STATE_SUCCESS</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.AdvertisedRoute.ADVERTISEMENT_STATE_FAILED" title="com.vmware.nsx_vmc_app.model_client.AdvertisedRoute.ADVERTISEMENT_STATE_FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">AdvertisedRoute.ADVERTISEMENT_STATE_FAILED</span></code></a></p></li>
</ul>
<blockquote>
<div><p>State of advertisement</p>
</div></blockquote>
</p></li>
<li><p><strong>ipv4_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 route that is advertised to on-premise datacenter via Direct
Connect format: ipv4-cidr-block</p></li>
</ul>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.AdvertisedRoute.ADVERTISEMENT_STATE_FAILED">
<code class="sig-name descname">ADVERTISEMENT_STATE_FAILED</code><em class="property"> = 'FAILED'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.AdvertisedRoute.ADVERTISEMENT_STATE_FAILED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.AdvertisedRoute.ADVERTISEMENT_STATE_SUCCESS">
<code class="sig-name descname">ADVERTISEMENT_STATE_SUCCESS</code><em class="property"> = 'SUCCESS'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.AdvertisedRoute.ADVERTISEMENT_STATE_SUCCESS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.ApiError">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">ApiError</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">details</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">error_code</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">error_data</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">error_message</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">module_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">related_errors</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.ApiError" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Detailed information about an API Error</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>details</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Further details about the error</p></li>
<li><p><strong>error_code</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>) – A numeric error code format: int64</p></li>
<li><p><strong>error_data</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>) – Additional data about the error</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>) – A description of the error</p></li>
<li><p><strong>module_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 module name where the error occurred</p></li>
<li><p><strong>related_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.nsx_vmc_app.model_client.RelatedApiError" title="com.vmware.nsx_vmc_app.model_client.RelatedApiError"><code class="xref py py-class docutils literal notranslate"><span class="pre">RelatedApiError</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Other errors related to this error</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.AssociatedBaseGroupConnectionInfo">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">AssociatedBaseGroupConnectionInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">links</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">schema</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">self_</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">revision</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">create_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">create_user</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">last_modified_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">last_modified_user</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">protection</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">system_owned</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">description</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">display_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">resource_type</span><span class="o">=</span><span class="default_value">'AssociatedBaseGroupConnectionInfo'</span></em>, <em class="sig-param"><span class="n">tags</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">marked_for_delete</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">parent_path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">relative_path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.AssociatedBaseGroupConnectionInfo" title="Permalink to this definition"></a></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>Base abstract associated Group connection infomation for the local 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>links</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ResourceLink" title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>schema</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Schema for this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>self</strong> (<a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.SelfResourceLink" title="com.vmware.nsx_vmc_app.model_client.SelfResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">SelfResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Link to this resource</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>) – The _revision property describes the current revision of the
resource. To prevent clients from overwriting each other’s changes,
PUT operations must include the current _revision of the resource,
which clients should obtain by issuing a GET operation. If the
_revision provided in a PUT request is missing or stale, the
operation will be rejected. format: int32</p></li>
<li><p><strong>create_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>) – Timestamp of resource creation format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>create_user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – ID of the user who created this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>last_modified_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>) – Timestamp of last modification format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>last_modified_user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – ID of the user who last modified this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>protection</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Protection status is one of the following: PROTECTED - the client
who retrieved the entity is not allowed to modify it. NOT_PROTECTED
- the client who retrieved the entity is allowed to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing the request header
X-Allow-Overwrite=true. UNKNOWN - the _protection field could not
be determined for this entity.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>system_owned</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 system owned resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><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>) – SDDC Group description</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>) – Defaults to ID if not set</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>) – SDDC Group ID</p></li>
<li><p><strong>resource_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>Possible values are:</p>
<ul>
<li><blockquote>
<div><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.AssociatedBaseGroupConnectionInfo.RESOURCE_TYPE_ASSOCIATEDTGWGROUPCONNECTIONINFO" title="com.vmware.nsx_vmc_app.model_client.AssociatedBaseGroupConnectionInfo.RESOURCE_TYPE_ASSOCIATEDTGWGROUPCONNECTIONINFO"><code class="xref py py-attr docutils literal notranslate"><span class="pre">AssociatedBaseGroupConnectionInfo.RESOURCE_TYPE_ASSOCIATEDTGWGROUPCONNECTIONINFO</span></code></a></p>
</div></blockquote>
<p>Group connection type</p>
</li>
</ul>
</p></li>
<li><p><strong>tags</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.Tag" title="com.vmware.nsx_vmc_app.model_client.Tag"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tag</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque identifiers meaningful to the API user</p></li>
<li><p><strong>marked_for_delete</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>) – marked for delete identifier
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>parent_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>) – Path of its parent
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><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>) – Absolute path of this object
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>relative_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>) – Path relative from its parent
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><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>) – SDDC Group name</p></li>
</ul>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.AssociatedBaseGroupConnectionInfo.RESOURCE_TYPE_ASSOCIATEDTGWGROUPCONNECTIONINFO">
<code class="sig-name descname">RESOURCE_TYPE_ASSOCIATEDTGWGROUPCONNECTIONINFO</code><em class="property"> = 'AssociatedTgwGroupConnectionInfo'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.AssociatedBaseGroupConnectionInfo.RESOURCE_TYPE_ASSOCIATEDTGWGROUPCONNECTIONINFO" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="com.vmware.nsx_vmc_app.model_client.AssociatedBaseGroupConnectionInfo.resource_type">
<em class="property">property </em><code class="sig-name descname">resource_type</code><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.AssociatedBaseGroupConnectionInfo.resource_type" title="Permalink to this definition"></a></dt>
<dd><p>Return the discriminator value</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.AssociatedGroupConnectionInfosListResult">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">AssociatedGroupConnectionInfosListResult</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">links</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">schema</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">self_</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cursor</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">result_count</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_ascending</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_by</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">results</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.AssociatedGroupConnectionInfosListResult" title="Permalink to this definition"></a></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>Associated Group connection list result</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>links</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ResourceLink" title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>schema</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Schema for this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>self</strong> (<a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.SelfResourceLink" title="com.vmware.nsx_vmc_app.model_client.SelfResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">SelfResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Link to this resource</p></li>
<li><p><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
by current result page)
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>result_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>) – Count of results found (across all pages), set only on first page
format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>sort_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>) – If true, results are sorted in ascending order
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><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>) – Field by which records are sorted
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>results</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – When clients pass a value of this class as a parameter, the
attribute must contain all the attributes defined in
<a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.AssociatedBaseGroupConnectionInfo" title="com.vmware.nsx_vmc_app.model_client.AssociatedBaseGroupConnectionInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">AssociatedBaseGroupConnectionInfo</span></code></a>. When methods return a
value of this class as a return value, the attribute will contain
all the attributes defined in
<a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.AssociatedBaseGroupConnectionInfo" title="com.vmware.nsx_vmc_app.model_client.AssociatedBaseGroupConnectionInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">AssociatedBaseGroupConnectionInfo</span></code></a>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.AssociatedTgwGroupConnectionInfo">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">AssociatedTgwGroupConnectionInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">external_route_table_id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sddcs_route_table_id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">state</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">tgw_attachment_id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">tgw_id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">links</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">schema</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">self_</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">revision</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">create_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">create_user</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">last_modified_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">last_modified_user</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">protection</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">system_owned</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">description</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">display_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">resource_type</span><span class="o">=</span><span class="default_value">'AssociatedTgwGroupConnectionInfo'</span></em>, <em class="sig-param"><span class="n">tags</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">marked_for_delete</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">parent_path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">relative_path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.AssociatedTgwGroupConnectionInfo" title="Permalink to this definition"></a></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>Associated Group connection infomation for the local SDDC by using AWS TGW
as a connector.</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>external_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>) – TGW external route table ID used for external customers VPCs
association</p></li>
<li><p><strong>sddcs_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>) – TGW SDDCs route table ID used for SDDCs association</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>
<ul>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.AssociatedTgwGroupConnectionInfo.STATE_CONNECTED" title="com.vmware.nsx_vmc_app.model_client.AssociatedTgwGroupConnectionInfo.STATE_CONNECTED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">AssociatedTgwGroupConnectionInfo.STATE_CONNECTED</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.AssociatedTgwGroupConnectionInfo.STATE_DISCONNECTED" title="com.vmware.nsx_vmc_app.model_client.AssociatedTgwGroupConnectionInfo.STATE_DISCONNECTED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">AssociatedTgwGroupConnectionInfo.STATE_DISCONNECTED</span></code></a></p></li>
</ul>
<blockquote>
<div><p>The TGW attachment state of the SDDC in the Group</p>
</div></blockquote>
</p></li>
<li><p><strong>tgw_attachment_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>) – TGW attachment ID for the local SDDC in the Group</p></li>
<li><p><strong>tgw_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>) – TGW ID for the local SDDC in the Group</p></li>
<li><p><strong>links</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ResourceLink" title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>schema</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Schema for this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>self</strong> (<a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.SelfResourceLink" title="com.vmware.nsx_vmc_app.model_client.SelfResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">SelfResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Link to this resource</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>) – The _revision property describes the current revision of the
resource. To prevent clients from overwriting each other’s changes,
PUT operations must include the current _revision of the resource,
which clients should obtain by issuing a GET operation. If the
_revision provided in a PUT request is missing or stale, the
operation will be rejected. format: int32</p></li>
<li><p><strong>create_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>) – Timestamp of resource creation format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>create_user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – ID of the user who created this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>last_modified_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>) – Timestamp of last modification format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>last_modified_user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – ID of the user who last modified this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>protection</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Protection status is one of the following: PROTECTED - the client
who retrieved the entity is not allowed to modify it. NOT_PROTECTED
- the client who retrieved the entity is allowed to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing the request header
X-Allow-Overwrite=true. UNKNOWN - the _protection field could not
be determined for this entity.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>system_owned</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 system owned resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><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>) – SDDC Group description</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>) – Defaults to ID if not set</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>) – SDDC Group ID</p></li>
<li><p><strong>resource_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>Possible values are:</p>
<ul>
<li><blockquote>
<div><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.AssociatedBaseGroupConnectionInfo.RESOURCE_TYPE_ASSOCIATEDTGWGROUPCONNECTIONINFO" title="com.vmware.nsx_vmc_app.model_client.AssociatedBaseGroupConnectionInfo.RESOURCE_TYPE_ASSOCIATEDTGWGROUPCONNECTIONINFO"><code class="xref py py-attr docutils literal notranslate"><span class="pre">AssociatedBaseGroupConnectionInfo.RESOURCE_TYPE_ASSOCIATEDTGWGROUPCONNECTIONINFO</span></code></a></p>
</div></blockquote>
<p>Group connection type</p>
</li>
</ul>
</p></li>
<li><p><strong>tags</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.Tag" title="com.vmware.nsx_vmc_app.model_client.Tag"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tag</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque identifiers meaningful to the API user</p></li>
<li><p><strong>marked_for_delete</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>) – marked for delete identifier
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>parent_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>) – Path of its parent
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><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>) – Absolute path of this object
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>relative_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>) – Path relative from its parent
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><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>) – SDDC Group name</p></li>
</ul>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.AssociatedTgwGroupConnectionInfo.STATE_CONNECTED">
<code class="sig-name descname">STATE_CONNECTED</code><em class="property"> = 'CONNECTED'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.AssociatedTgwGroupConnectionInfo.STATE_CONNECTED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.AssociatedTgwGroupConnectionInfo.STATE_DISCONNECTED">
<code class="sig-name descname">STATE_DISCONNECTED</code><em class="property"> = 'DISCONNECTED'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.AssociatedTgwGroupConnectionInfo.STATE_DISCONNECTED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="com.vmware.nsx_vmc_app.model_client.AssociatedTgwGroupConnectionInfo.resource_type">
<em class="property">property </em><code class="sig-name descname">resource_type</code><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.AssociatedTgwGroupConnectionInfo.resource_type" title="Permalink to this definition"></a></dt>
<dd><p>Return the discriminator value</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.BGPAdvertisedRoutes">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">BGPAdvertisedRoutes</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">advertised_routes</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">failed_advertised_routes</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.BGPAdvertisedRoutes" title="Permalink to this definition"></a></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>Advertised bgp routes</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>advertised_routes</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.AdvertisedRoute" title="com.vmware.nsx_vmc_app.model_client.AdvertisedRoute"><code class="xref py py-class docutils literal notranslate"><span class="pre">AdvertisedRoute</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Routes advertised to on-premise datacenter via Direct Connect</p></li>
<li><p><strong>failed_advertised_routes</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 routes failed to advertise format: int32</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.BGPLearnedRoutes">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">BGPLearnedRoutes</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">ipv4_cidr</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.BGPLearnedRoutes" title="Permalink to this definition"></a></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>Learned bgp routes</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>ipv4_cidr</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>) – The route that is learned from BGP via Direct Connect format:
ipv4-cidr-block</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.ConnectedServiceListResult">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">ConnectedServiceListResult</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">links</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">schema</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">self_</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cursor</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">result_count</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_ascending</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_by</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">results</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.ConnectedServiceListResult" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>A list of status of ‘Enabled/Disabled’ for a service connected to a linked
vpc</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>links</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ResourceLink" title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>schema</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Schema for this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>self</strong> (<a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.SelfResourceLink" title="com.vmware.nsx_vmc_app.model_client.SelfResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">SelfResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Link to this resource</p></li>
<li><p><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
by current result page)
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>result_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>) – Count of results found (across all pages), set only on first page
format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>sort_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>) – If true, results are sorted in ascending order
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><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>) – Field by which records are sorted
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>results</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ConnectedServiceStatus" title="com.vmware.nsx_vmc_app.model_client.ConnectedServiceStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConnectedServiceStatus</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Connected service status list</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.ConnectedServiceStatus">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">ConnectedServiceStatus</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">links</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">schema</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">self_</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">revision</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">create_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">create_user</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">last_modified_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">last_modified_user</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">protection</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">system_owned</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">description</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">display_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">resource_type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">tags</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">marked_for_delete</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">parent_path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">relative_path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">enabled</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.ConnectedServiceStatus" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Status of ‘Enabled/Disabled’ for a service connected to a linked vpc</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>links</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ResourceLink" title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>schema</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Schema for this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>self</strong> (<a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.SelfResourceLink" title="com.vmware.nsx_vmc_app.model_client.SelfResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">SelfResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Link to this resource</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>) – The _revision property describes the current revision of the
resource. To prevent clients from overwriting each other’s changes,
PUT operations must include the current _revision of the resource,
which clients should obtain by issuing a GET operation. If the
_revision provided in a PUT request is missing or stale, the
operation will be rejected. format: int32</p></li>
<li><p><strong>create_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>) – Timestamp of resource creation format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>create_user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – ID of the user who created this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>last_modified_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>) – Timestamp of last modification format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>last_modified_user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – ID of the user who last modified this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>protection</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Protection status is one of the following: PROTECTED - the client
who retrieved the entity is not allowed to modify it. NOT_PROTECTED
- the client who retrieved the entity is allowed to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing the request header
X-Allow-Overwrite=true. UNKNOWN - the _protection field could not
be determined for this entity.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>system_owned</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 system owned resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><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 this resource</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>) – Defaults to ID if not set</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>) – Unique identifier of this resource</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>) – The type of this resource.</p></li>
<li><p><strong>tags</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.Tag" title="com.vmware.nsx_vmc_app.model_client.Tag"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tag</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque identifiers meaningful to the API user</p></li>
<li><p><strong>marked_for_delete</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>) – marked for delete identifier
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>parent_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>) – Path of its parent
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><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>) – Absolute path of this object
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>relative_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>) – Path relative from its parent
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><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>) – status of service
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><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>) – service name
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.CsvListResult">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">CsvListResult</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">file_name</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.CsvListResult" title="Permalink to this definition"></a></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>Base type for CSV result.</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>file_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>) – File name set by HTTP server if API returns CSV result as a file.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.CsvRecord">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">CsvRecord</code><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.CsvRecord" title="Permalink to this definition"></a></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>Base type for CSV records.</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>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.DirectConnectBgpInfo">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">DirectConnectBgpInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">links</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">schema</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">self_</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">revision</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">create_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">create_user</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">last_modified_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">last_modified_user</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">protection</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">system_owned</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">description</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">display_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">resource_type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">tags</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">marked_for_delete</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">parent_path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">relative_path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">local_as_num</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">mtu</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">route_preference</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.DirectConnectBgpInfo" title="Permalink to this definition"></a></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>Direct Connect BGP related information</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>links</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ResourceLink" title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>schema</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Schema for this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>self</strong> (<a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.SelfResourceLink" title="com.vmware.nsx_vmc_app.model_client.SelfResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">SelfResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Link to this resource</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>) – The _revision property describes the current revision of the
resource. To prevent clients from overwriting each other’s changes,
PUT operations must include the current _revision of the resource,
which clients should obtain by issuing a GET operation. If the
_revision provided in a PUT request is missing or stale, the
operation will be rejected. format: int32</p></li>
<li><p><strong>create_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>) – Timestamp of resource creation format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>create_user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – ID of the user who created this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>last_modified_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>) – Timestamp of last modification format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>last_modified_user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – ID of the user who last modified this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>protection</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Protection status is one of the following: PROTECTED - the client
who retrieved the entity is not allowed to modify it. NOT_PROTECTED
- the client who retrieved the entity is allowed to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing the request header
X-Allow-Overwrite=true. UNKNOWN - the _protection field could not
be determined for this entity.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>system_owned</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 system owned resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><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 this resource</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>) – Defaults to ID if not set</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>) – Unique identifier of this resource</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>) – The type of this resource.</p></li>
<li><p><strong>tags</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.Tag" title="com.vmware.nsx_vmc_app.model_client.Tag"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tag</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque identifiers meaningful to the API user</p></li>
<li><p><strong>marked_for_delete</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>) – marked for delete identifier
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>parent_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>) – Path of its parent
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><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>) – Absolute path of this object
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>relative_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>) – Path relative from its parent
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>local_as_num</strong> (<code class="xref 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 ASN paired with the VGW attached to the VPC. AWS allowed
private BGP ASN range - [64512, 65534] and [4200000000,
4294967294]. If omitted in the payload, BGP ASN will not be
modified.</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>) – Maximum transmission unit allowed by the VIF format: int32
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>route_preference</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Possible values are:</p>
<ul>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.DirectConnectBgpInfo.ROUTE_PREFERENCE_DIRECT_CONNECT_PREFERRED_OVER_VPN" title="com.vmware.nsx_vmc_app.model_client.DirectConnectBgpInfo.ROUTE_PREFERENCE_DIRECT_CONNECT_PREFERRED_OVER_VPN"><code class="xref py py-attr docutils literal notranslate"><span class="pre">DirectConnectBgpInfo.ROUTE_PREFERENCE_DIRECT_CONNECT_PREFERRED_OVER_VPN</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.DirectConnectBgpInfo.ROUTE_PREFERENCE_VPN_PREFERRED_OVER_DIRECT_CONNECT" title="com.vmware.nsx_vmc_app.model_client.DirectConnectBgpInfo.ROUTE_PREFERENCE_VPN_PREFERRED_OVER_DIRECT_CONNECT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">DirectConnectBgpInfo.ROUTE_PREFERENCE_VPN_PREFERRED_OVER_DIRECT_CONNECT</span></code></a></p></li>
</ul>
<p>Direct connect route preference over VPN routes. If omitted in the
payload, route preference will not be modified.</p>
</p></li>
</ul>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.DirectConnectBgpInfo.ROUTE_PREFERENCE_DIRECT_CONNECT_PREFERRED_OVER_VPN">
<code class="sig-name descname">ROUTE_PREFERENCE_DIRECT_CONNECT_PREFERRED_OVER_VPN</code><em class="property"> = 'DIRECT_CONNECT_PREFERRED_OVER_VPN'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.DirectConnectBgpInfo.ROUTE_PREFERENCE_DIRECT_CONNECT_PREFERRED_OVER_VPN" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.DirectConnectBgpInfo.ROUTE_PREFERENCE_VPN_PREFERRED_OVER_DIRECT_CONNECT">
<code class="sig-name descname">ROUTE_PREFERENCE_VPN_PREFERRED_OVER_DIRECT_CONNECT</code><em class="property"> = 'VPN_PREFERRED_OVER_DIRECT_CONNECT'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.DirectConnectBgpInfo.ROUTE_PREFERENCE_VPN_PREFERRED_OVER_DIRECT_CONNECT" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.ExternalConnectivityConfig">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">ExternalConnectivityConfig</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">links</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">schema</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">self_</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">revision</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">create_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">create_user</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">last_modified_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">last_modified_user</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">protection</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">system_owned</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">description</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">display_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">resource_type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">tags</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">marked_for_delete</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">parent_path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">relative_path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">internet_mtu</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">intranet_mtu</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">services_mtu</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.ExternalConnectivityConfig" title="Permalink to this definition"></a></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>External Connectivity configuration for north-south traffic. For eg., in
AWS case, this would refer to Direct Connect config. For Dimension, this
would refer to the config at Upstream Intranet interface to Tor.</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>links</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ResourceLink" title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>schema</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Schema for this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>self</strong> (<a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.SelfResourceLink" title="com.vmware.nsx_vmc_app.model_client.SelfResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">SelfResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Link to this resource</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>) – The _revision property describes the current revision of the
resource. To prevent clients from overwriting each other’s changes,
PUT operations must include the current _revision of the resource,
which clients should obtain by issuing a GET operation. If the
_revision provided in a PUT request is missing or stale, the
operation will be rejected. format: int32</p></li>
<li><p><strong>create_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>) – Timestamp of resource creation format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>create_user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – ID of the user who created this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>last_modified_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>) – Timestamp of last modification format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>last_modified_user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – ID of the user who last modified this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>protection</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Protection status is one of the following: PROTECTED - the client
who retrieved the entity is not allowed to modify it. NOT_PROTECTED
- the client who retrieved the entity is allowed to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing the request header
X-Allow-Overwrite=true. UNKNOWN - the _protection field could not
be determined for this entity.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>system_owned</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 system owned resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><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 this resource</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>) – Defaults to ID if not set</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>) – Unique identifier of this resource</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>) – The type of this resource.</p></li>
<li><p><strong>tags</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.Tag" title="com.vmware.nsx_vmc_app.model_client.Tag"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tag</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque identifiers meaningful to the API user</p></li>
<li><p><strong>marked_for_delete</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>) – marked for delete identifier
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>parent_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>) – Path of its parent
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><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>) – Absolute path of this object
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>relative_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>) – Path relative from its parent
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>internet_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>) – Uplink MTU of internet traffic in edge tier-0 router port. format:
int32
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>intranet_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>) – Uplink MTU of direct connect, sddc-grouping and outposts traffic in
edge tier-0 router port. format: int32</p></li>
<li><p><strong>services_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>) – Uplink MTU of connected VPC traffic in edge tier-0 router port.
format: int32
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.ExternalSddcConnectivity">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">ExternalSddcConnectivity</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">connectivity_type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">route_type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">source</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">status</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">status_message</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.ExternalSddcConnectivity" title="Permalink to this definition"></a></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>External SDDC connectivity</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>connectivity_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Possible values are:</p>
<ul>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ExternalSddcConnectivity.CONNECTIVITY_TYPE_DIRECT_CONNECT" title="com.vmware.nsx_vmc_app.model_client.ExternalSddcConnectivity.CONNECTIVITY_TYPE_DIRECT_CONNECT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ExternalSddcConnectivity.CONNECTIVITY_TYPE_DIRECT_CONNECT</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ExternalSddcConnectivity.CONNECTIVITY_TYPE_DEPLOYMENT_CONNECTIVITY_GROUP" title="com.vmware.nsx_vmc_app.model_client.ExternalSddcConnectivity.CONNECTIVITY_TYPE_DEPLOYMENT_CONNECTIVITY_GROUP"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ExternalSddcConnectivity.CONNECTIVITY_TYPE_DEPLOYMENT_CONNECTIVITY_GROUP</span></code></a></p></li>
</ul>
<p>The external SDDC connectivity type is used by the SDDC for the L3
connectivity. DIRECT_CONNECT means that the external SDDC
connectivity is through AWS Direct Connect.
DEPLOYMENT_CONNECTIVITY_GROUP means that the external SDDC
connectivity is through AWS TGW.</p>
</p></li>
<li><p><strong>route_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Possible values are:</p>
<ul>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ExternalSddcConnectivity.ROUTE_TYPE_PROPAGATED" title="com.vmware.nsx_vmc_app.model_client.ExternalSddcConnectivity.ROUTE_TYPE_PROPAGATED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ExternalSddcConnectivity.ROUTE_TYPE_PROPAGATED</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ExternalSddcConnectivity.ROUTE_TYPE_STATIC" title="com.vmware.nsx_vmc_app.model_client.ExternalSddcConnectivity.ROUTE_TYPE_STATIC"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ExternalSddcConnectivity.ROUTE_TYPE_STATIC</span></code></a></p></li>
</ul>
<blockquote>
<div><p>The type of the route for the connectivity</p>
</div></blockquote>
</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>) – The source of the route for the connectivity</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>
<ul>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ExternalSddcConnectivity.STATUS_SUCCEEDED" title="com.vmware.nsx_vmc_app.model_client.ExternalSddcConnectivity.STATUS_SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ExternalSddcConnectivity.STATUS_SUCCEEDED</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ExternalSddcConnectivity.STATUS_FAILED" title="com.vmware.nsx_vmc_app.model_client.ExternalSddcConnectivity.STATUS_FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ExternalSddcConnectivity.STATUS_FAILED</span></code></a></p></li>
</ul>
<blockquote>
<div><p>The status of the route for the connectivity</p>
</div></blockquote>
</p></li>
<li><p><strong>status_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 error message if the status is FAILED, the optional warning
message if the status is SUCCEEDED.</p></li>
</ul>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.ExternalSddcConnectivity.CONNECTIVITY_TYPE_DEPLOYMENT_CONNECTIVITY_GROUP">
<code class="sig-name descname">CONNECTIVITY_TYPE_DEPLOYMENT_CONNECTIVITY_GROUP</code><em class="property"> = 'DEPLOYMENT_CONNECTIVITY_GROUP'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.ExternalSddcConnectivity.CONNECTIVITY_TYPE_DEPLOYMENT_CONNECTIVITY_GROUP" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.ExternalSddcConnectivity.CONNECTIVITY_TYPE_DIRECT_CONNECT">
<code class="sig-name descname">CONNECTIVITY_TYPE_DIRECT_CONNECT</code><em class="property"> = 'DIRECT_CONNECT'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.ExternalSddcConnectivity.CONNECTIVITY_TYPE_DIRECT_CONNECT" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.ExternalSddcConnectivity.ROUTE_TYPE_PROPAGATED">
<code class="sig-name descname">ROUTE_TYPE_PROPAGATED</code><em class="property"> = 'PROPAGATED'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.ExternalSddcConnectivity.ROUTE_TYPE_PROPAGATED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.ExternalSddcConnectivity.ROUTE_TYPE_STATIC">
<code class="sig-name descname">ROUTE_TYPE_STATIC</code><em class="property"> = 'STATIC'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.ExternalSddcConnectivity.ROUTE_TYPE_STATIC" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.ExternalSddcConnectivity.STATUS_FAILED">
<code class="sig-name descname">STATUS_FAILED</code><em class="property"> = 'FAILED'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.ExternalSddcConnectivity.STATUS_FAILED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.ExternalSddcConnectivity.STATUS_SUCCEEDED">
<code class="sig-name descname">STATUS_SUCCEEDED</code><em class="property"> = 'SUCCEEDED'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.ExternalSddcConnectivity.STATUS_SUCCEEDED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.ExternalSddcRoute">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">ExternalSddcRoute</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">links</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">schema</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">self_</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">revision</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">create_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">create_user</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">last_modified_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">last_modified_user</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">protection</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">system_owned</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">description</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">display_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">resource_type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">tags</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">marked_for_delete</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">parent_path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">relative_path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">connectivities</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">destination</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.ExternalSddcRoute" title="Permalink to this definition"></a></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>External SDDC route</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>links</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ResourceLink" title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>schema</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Schema for this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>self</strong> (<a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.SelfResourceLink" title="com.vmware.nsx_vmc_app.model_client.SelfResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">SelfResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Link to this resource</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>) – The _revision property describes the current revision of the
resource. To prevent clients from overwriting each other’s changes,
PUT operations must include the current _revision of the resource,
which clients should obtain by issuing a GET operation. If the
_revision provided in a PUT request is missing or stale, the
operation will be rejected. format: int32</p></li>
<li><p><strong>create_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>) – Timestamp of resource creation format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>create_user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – ID of the user who created this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>last_modified_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>) – Timestamp of last modification format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>last_modified_user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – ID of the user who last modified this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>protection</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Protection status is one of the following: PROTECTED - the client
who retrieved the entity is not allowed to modify it. NOT_PROTECTED
- the client who retrieved the entity is allowed to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing the request header
X-Allow-Overwrite=true. UNKNOWN - the _protection field could not
be determined for this entity.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>system_owned</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 system owned resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><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 this resource</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>) – Defaults to ID if not set</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>) – Unique identifier of this resource</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>) – The type of this resource.</p></li>
<li><p><strong>tags</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.Tag" title="com.vmware.nsx_vmc_app.model_client.Tag"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tag</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque identifiers meaningful to the API user</p></li>
<li><p><strong>marked_for_delete</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>) – marked for delete identifier
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>parent_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>) – Path of its parent
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><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>) – Absolute path of this object
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>relative_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>) – Path relative from its parent
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>connectivities</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ExternalSddcConnectivity" title="com.vmware.nsx_vmc_app.model_client.ExternalSddcConnectivity"><code class="xref py py-class docutils literal notranslate"><span class="pre">ExternalSddcConnectivity</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The route used for what kind of connectivities</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>) – Destination IP CIDR Block format: ipv4-cidr-block</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.ExternalSddcRouteCsvRecord">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">ExternalSddcRouteCsvRecord</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">connectivity_details</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">destination</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.ExternalSddcRouteCsvRecord" title="Permalink to this definition"></a></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>CSV record for External SDDC route</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>connectivity_details</strong> (<code class="xref 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 connectivity datails contains status of route, source of the
route, connectivity type</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>) – Destination IP CIDR Block format: ipv4-cidr-block</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.ExternalSddcRoutesListResult">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">ExternalSddcRoutesListResult</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">links</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">schema</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">self_</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cursor</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">result_count</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_ascending</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_by</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">routes</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.ExternalSddcRoutesListResult" title="Permalink to this definition"></a></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>External SDDC routes list result</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>links</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ResourceLink" title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>schema</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Schema for this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>self</strong> (<a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.SelfResourceLink" title="com.vmware.nsx_vmc_app.model_client.SelfResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">SelfResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Link to this resource</p></li>
<li><p><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
by current result page)
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>result_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>) – Count of results found (across all pages), set only on first page
format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>sort_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>) – If true, results are sorted in ascending order
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><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>) – Field by which records are sorted
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>routes</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ExternalSddcRoute" title="com.vmware.nsx_vmc_app.model_client.ExternalSddcRoute"><code class="xref py py-class docutils literal notranslate"><span class="pre">ExternalSddcRoute</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.ExternalSddcRoutesListResultInCsvFormat">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">ExternalSddcRoutesListResultInCsvFormat</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">file_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">results</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.ExternalSddcRoutesListResultInCsvFormat" title="Permalink to this definition"></a></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>External SDDC routes list result in CSV format</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>file_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>) – File name set by HTTP server if API returns CSV result as a file.</p></li>
<li><p><strong>results</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ExternalSddcRouteCsvRecord" title="com.vmware.nsx_vmc_app.model_client.ExternalSddcRouteCsvRecord"><code class="xref py py-class docutils literal notranslate"><span class="pre">ExternalSddcRouteCsvRecord</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.IncludedFieldsParameters">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">IncludedFieldsParameters</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">included_fields</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.IncludedFieldsParameters" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>A list of fields to include in query results</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>included_fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Comma separated list of fields that should be included in query
result</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.IpAttachmentPair">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">IpAttachmentPair</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">attachment_id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">ip</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.IpAttachmentPair" title="Permalink to this definition"></a></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>attachment_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>) – Attachment id which maps to management VM IP</p></li>
<li><p><strong>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>) – Management VM IP Address format: ipv4</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.LinkedSubnetInfo">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">LinkedSubnetInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">availability_zone</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cidr</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">id</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.LinkedSubnetInfo" title="Permalink to this definition"></a></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>Infromation related to a subnet where linked ENIs were created.</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>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>) – Linked subnet availability zone</p></li>
<li><p><strong>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>) – Linked subnet CIDR format: ipv4-cidr-block</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>) – Linked subnet identifier</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.LinkedVpcInfo">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">LinkedVpcInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">links</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">schema</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">self_</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">revision</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">create_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">create_user</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">last_modified_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">last_modified_user</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">protection</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">system_owned</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">description</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">display_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">resource_type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">tags</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">marked_for_delete</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">parent_path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">relative_path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">active_eni</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">arn_role</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">external_id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">linked_account</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">linked_vpc_addresses</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">linked_vpc_id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">linked_vpc_nat_ips</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">linked_vpc_subnets</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">route_table_ids</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">service_arn_role</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.LinkedVpcInfo" title="Permalink to this definition"></a></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>Linked VPC info</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>links</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ResourceLink" title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>schema</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Schema for this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>self</strong> (<a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.SelfResourceLink" title="com.vmware.nsx_vmc_app.model_client.SelfResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">SelfResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Link to this resource</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>) – The _revision property describes the current revision of the
resource. To prevent clients from overwriting each other’s changes,
PUT operations must include the current _revision of the resource,
which clients should obtain by issuing a GET operation. If the
_revision provided in a PUT request is missing or stale, the
operation will be rejected. format: int32</p></li>
<li><p><strong>create_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>) – Timestamp of resource creation format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>create_user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – ID of the user who created this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>last_modified_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>) – Timestamp of last modification format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>last_modified_user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – ID of the user who last modified this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>protection</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Protection status is one of the following: PROTECTED - the client
who retrieved the entity is not allowed to modify it. NOT_PROTECTED
- the client who retrieved the entity is allowed to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing the request header
X-Allow-Overwrite=true. UNKNOWN - the _protection field could not
be determined for this entity.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>system_owned</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 system owned resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><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 this resource</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>) – Defaults to ID if not set</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>) – Unique identifier of this resource</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>) – The type of this resource.</p></li>
<li><p><strong>tags</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.Tag" title="com.vmware.nsx_vmc_app.model_client.Tag"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tag</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque identifiers meaningful to the API user</p></li>
<li><p><strong>marked_for_delete</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>) – marked for delete identifier
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>parent_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>) – Path of its parent
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><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>) – Absolute path of this object
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>relative_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>) – Path relative from its parent
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>active_eni</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Active network interface used for linked vpc traffic</p></li>
<li><p><strong>arn_role</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – ARN role for linked VPC operations</p></li>
<li><p><strong>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>) – External identifier for ARN role</p></li>
<li><p><strong>linked_account</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Linked VPC account number</p></li>
<li><p><strong>linked_vpc_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>) – Linked VPC CIDRs format: ipv4-cidr-block</p></li>
<li><p><strong>linked_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>) – Linked VPC identifier</p></li>
<li><p><strong>linked_vpc_nat_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>) – The IPs of linked VPC NAT rule for service access. format: ipv4</p></li>
<li><p><strong>linked_vpc_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.nsx_vmc_app.model_client.LinkedSubnetInfo" title="com.vmware.nsx_vmc_app.model_client.LinkedSubnetInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">LinkedSubnetInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Infromation related to the subnets where linked ENIs were created.</p></li>
<li><p><strong>route_table_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>) – The identifiers of route tables to be dynamically updated with SDDC
networks</p></li>
<li><p><strong>service_arn_role</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – service ARN role</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.LinkedVpcsListResult">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">LinkedVpcsListResult</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">links</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">schema</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">self_</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cursor</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">result_count</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_ascending</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_by</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">results</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.LinkedVpcsListResult" title="Permalink to this definition"></a></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>Linked VPC list query result</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>links</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ResourceLink" title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>schema</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Schema for this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>self</strong> (<a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.SelfResourceLink" title="com.vmware.nsx_vmc_app.model_client.SelfResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">SelfResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Link to this resource</p></li>
<li><p><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
by current result page)
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>result_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>) – Count of results found (across all pages), set only on first page
format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>sort_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>) – If true, results are sorted in ascending order
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><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>) – Field by which records are sorted
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>results</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.LinkedVpcInfo" title="com.vmware.nsx_vmc_app.model_client.LinkedVpcInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">LinkedVpcInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Linked VPCs list</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.ListResult">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">ListResult</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">links</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">schema</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">self_</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cursor</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">result_count</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_ascending</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_by</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.ListResult" title="Permalink to this definition"></a></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>Base class for list results from collections</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>links</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ResourceLink" title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>schema</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Schema for this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>self</strong> (<a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.SelfResourceLink" title="com.vmware.nsx_vmc_app.model_client.SelfResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">SelfResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Link to this resource</p></li>
<li><p><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
by current result page)
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>result_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>) – Count of results found (across all pages), set only on first page
format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>sort_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>) – If true, results are sorted in ascending order
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><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>) – Field by which records are sorted
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.ManagedResource">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">ManagedResource</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">links</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">schema</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">self_</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">revision</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">create_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">create_user</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">last_modified_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">last_modified_user</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">protection</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">system_owned</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">description</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">display_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">resource_type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">tags</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.ManagedResource" title="Permalink to this definition"></a></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>Base type for resources that are managed by API clients</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>links</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ResourceLink" title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>schema</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Schema for this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>self</strong> (<a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.SelfResourceLink" title="com.vmware.nsx_vmc_app.model_client.SelfResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">SelfResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Link to this resource</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>) – The _revision property describes the current revision of the
resource. To prevent clients from overwriting each other’s changes,
PUT operations must include the current _revision of the resource,
which clients should obtain by issuing a GET operation. If the
_revision provided in a PUT request is missing or stale, the
operation will be rejected. format: int32</p></li>
<li><p><strong>create_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>) – Timestamp of resource creation format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>create_user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – ID of the user who created this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>last_modified_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>) – Timestamp of last modification format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>last_modified_user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – ID of the user who last modified this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>protection</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Protection status is one of the following: PROTECTED - the client
who retrieved the entity is not allowed to modify it. NOT_PROTECTED
- the client who retrieved the entity is allowed to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing the request header
X-Allow-Overwrite=true. UNKNOWN - the _protection field could not
be determined for this entity.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>system_owned</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 system owned resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><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 this resource</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>) – Defaults to ID if not set</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>) – Unique identifier of this resource</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>) – The type of this resource.</p></li>
<li><p><strong>tags</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.Tag" title="com.vmware.nsx_vmc_app.model_client.Tag"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tag</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque identifiers meaningful to the API user</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.MgmtServiceEntry">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">MgmtServiceEntry</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">display_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">path</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.MgmtServiceEntry" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>A service entry describes the detail of a network service.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>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 for this service</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>) – Service path should refer to a valid service in the system. Service
can be system defined or user defined.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.MgmtVmInfo">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">MgmtVmInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">links</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">schema</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">self_</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">revision</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">create_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">create_user</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">last_modified_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">last_modified_user</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">protection</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">system_owned</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">description</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">display_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">resource_type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">tags</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">marked_for_delete</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">parent_path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">relative_path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">group_path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">ip_attachment_pairs</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">ips</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">services</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.MgmtVmInfo" title="Permalink to this definition"></a></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>Management VM access information</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>links</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ResourceLink" title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>schema</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Schema for this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>self</strong> (<a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.SelfResourceLink" title="com.vmware.nsx_vmc_app.model_client.SelfResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">SelfResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Link to this resource</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>) – The _revision property describes the current revision of the
resource. To prevent clients from overwriting each other’s changes,
PUT operations must include the current _revision of the resource,
which clients should obtain by issuing a GET operation. If the
_revision provided in a PUT request is missing or stale, the
operation will be rejected. format: int32</p></li>
<li><p><strong>create_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>) – Timestamp of resource creation format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>create_user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – ID of the user who created this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>last_modified_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>) – Timestamp of last modification format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>last_modified_user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – ID of the user who last modified this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>protection</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Protection status is one of the following: PROTECTED - the client
who retrieved the entity is not allowed to modify it. NOT_PROTECTED
- the client who retrieved the entity is allowed to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing the request header
X-Allow-Overwrite=true. UNKNOWN - the _protection field could not
be determined for this entity.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>system_owned</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 system owned resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><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 this resource</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>) – Management VM 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>) – Management VM identifier
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><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>) – The type of this resource.</p></li>
<li><p><strong>tags</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.Tag" title="com.vmware.nsx_vmc_app.model_client.Tag"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tag</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque identifiers meaningful to the API user</p></li>
<li><p><strong>marked_for_delete</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>) – marked for delete identifier
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>parent_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>) – Path of its parent
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><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>) – Absolute path of this object
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>relative_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>) – Path relative from its parent
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>group_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>) – For each management VM, a dedicated policy group will be created.
This property will reflect its group path.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>ip_attachment_pairs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.IpAttachmentPair" title="com.vmware.nsx_vmc_app.model_client.IpAttachmentPair"><code class="xref py py-class docutils literal notranslate"><span class="pre">IpAttachmentPair</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – IP address and attachment id pairs for tagging managment VM</p></li>
<li><p><strong>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>) – Local IPs of a management VM format: address-or-block-or-range</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.nsx_vmc_app.model_client.MgmtServiceEntry" title="com.vmware.nsx_vmc_app.model_client.MgmtServiceEntry"><code class="xref py py-class docutils literal notranslate"><span class="pre">MgmtServiceEntry</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Details services path and display name.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.MgmtVmsListResult">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">MgmtVmsListResult</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">links</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">schema</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">self_</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cursor</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">result_count</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_ascending</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_by</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">results</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.MgmtVmsListResult" title="Permalink to this definition"></a></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>Management VM list query result</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>links</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ResourceLink" title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>schema</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Schema for this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>self</strong> (<a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.SelfResourceLink" title="com.vmware.nsx_vmc_app.model_client.SelfResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">SelfResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Link to this resource</p></li>
<li><p><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
by current result page)
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>result_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>) – Count of results found (across all pages), set only on first page
format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>sort_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>) – If true, results are sorted in ascending order
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><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>) – Field by which records are sorted
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>results</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.MgmtVmInfo" title="com.vmware.nsx_vmc_app.model_client.MgmtVmInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">MgmtVmInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Management VMs list</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.ModelInterface">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">ModelInterface</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.ModelInterface" title="Permalink to this definition"></a></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>Interface information (Label)</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifier of the Interface label</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 label</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.PrefixListInfo">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">PrefixListInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">url</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.PrefixListInfo" title="Permalink to this definition"></a></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>Prefix lists used by certain features, like Intranet NAT.</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>) – Prefix List name</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>) – Relative Prefix List path</p></li>
<li><p><strong>url</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Prefix List URL</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.ProviderGatewayKeyValuePairs">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">ProviderGatewayKeyValuePairs</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">value</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.ProviderGatewayKeyValuePairs" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>A list for provider gateways</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>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</p></li>
<li><p><strong>value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ProviderObject" title="com.vmware.nsx_vmc_app.model_client.ProviderObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">ProviderObject</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Value</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.ProviderObject">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">ProviderObject</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">display_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">url</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.ProviderObject" title="Permalink to this definition"></a></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>Basic properties of SDDC User 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>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
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><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
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><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>) – Path
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><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>) – Optional field, used to identify the object.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>url</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Should start with “/policy/api/v1/”.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.PublicIp">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">PublicIp</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">links</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">schema</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">self_</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">revision</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">create_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">create_user</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">last_modified_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">last_modified_user</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">protection</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">system_owned</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">description</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">display_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">resource_type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">tags</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">marked_for_delete</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">parent_path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">relative_path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">ip</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.PublicIp" title="Permalink to this definition"></a></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>links</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ResourceLink" title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>schema</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Schema for this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>self</strong> (<a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.SelfResourceLink" title="com.vmware.nsx_vmc_app.model_client.SelfResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">SelfResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Link to this resource</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>) – The _revision property describes the current revision of the
resource. To prevent clients from overwriting each other’s changes,
PUT operations must include the current _revision of the resource,
which clients should obtain by issuing a GET operation. If the
_revision provided in a PUT request is missing or stale, the
operation will be rejected. format: int32</p></li>
<li><p><strong>create_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>) – Timestamp of resource creation format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>create_user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – ID of the user who created this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>last_modified_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>) – Timestamp of last modification format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>last_modified_user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – ID of the user who last modified this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>protection</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Protection status is one of the following: PROTECTED - the client
who retrieved the entity is not allowed to modify it. NOT_PROTECTED
- the client who retrieved the entity is allowed to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing the request header
X-Allow-Overwrite=true. UNKNOWN - the _protection field could not
be determined for this entity.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>system_owned</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 system owned resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><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 this resource</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>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>) – Public IP identifier
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><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>) – The type of this resource.</p></li>
<li><p><strong>tags</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.Tag" title="com.vmware.nsx_vmc_app.model_client.Tag"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tag</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque identifiers meaningful to the API user</p></li>
<li><p><strong>marked_for_delete</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>) – marked for delete identifier
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>parent_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>) – Path of its parent
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><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>) – Absolute path of this object
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>relative_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>) – Path relative from its parent
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>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>) – IPv4 address format: ipv4
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.PublicIpsListResult">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">PublicIpsListResult</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">links</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">schema</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">self_</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cursor</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">result_count</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_ascending</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_by</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">results</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.PublicIpsListResult" title="Permalink to this definition"></a></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>Public IP list</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>links</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ResourceLink" title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>schema</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Schema for this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>self</strong> (<a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.SelfResourceLink" title="com.vmware.nsx_vmc_app.model_client.SelfResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">SelfResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Link to this resource</p></li>
<li><p><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
by current result page)
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>result_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>) – Count of results found (across all pages), set only on first page
format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>sort_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>) – If true, results are sorted in ascending order
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><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>) – Field by which records are sorted
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>results</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.PublicIp" title="com.vmware.nsx_vmc_app.model_client.PublicIp"><code class="xref py py-class docutils literal notranslate"><span class="pre">PublicIp</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Public IP list</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.RelatedApiError">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">RelatedApiError</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">details</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">error_code</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">error_data</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">error_message</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">module_name</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.RelatedApiError" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Detailed information about a related API error</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>details</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Further details about the error</p></li>
<li><p><strong>error_code</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>) – A numeric error code format: int64</p></li>
<li><p><strong>error_data</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>) – Additional data about the error</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>) – A description of the error</p></li>
<li><p><strong>module_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 module name where the error occurred</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.Resource">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">Resource</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">links</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">schema</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">self_</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.Resource" title="Permalink to this definition"></a></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>Base class for resources</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>links</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ResourceLink" title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>schema</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Schema for this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>self</strong> (<a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.SelfResourceLink" title="com.vmware.nsx_vmc_app.model_client.SelfResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">SelfResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Link to this resource</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.ResourceLink">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">ResourceLink</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">action</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">href</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">rel</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.ResourceLink" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>A link to a related resource</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>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>) – Optional action
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>href</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Link to resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>rel</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Custom relation type (follows RFC 5988 where appropriate
definitions exist)
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.RevisionedResource">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">RevisionedResource</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">links</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">schema</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">self_</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">revision</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.RevisionedResource" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>A base class for types that track revisions</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>links</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ResourceLink" title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>schema</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Schema for this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>self</strong> (<a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.SelfResourceLink" title="com.vmware.nsx_vmc_app.model_client.SelfResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">SelfResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Link to this resource</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>) – The _revision property describes the current revision of the
resource. To prevent clients from overwriting each other’s changes,
PUT operations must include the current _revision of the resource,
which clients should obtain by issuing a GET operation. If the
_revision provided in a PUT request is missing or stale, the
operation will be rejected. format: int32</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.SddcUserConfiguration">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">SddcUserConfiguration</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">all_uplink_interface_label</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">all_vpn_interface_label</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cgw_snat_ip</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">compute_domain</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">compute_gateway</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">domains</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">dx_interface_label</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">enforcement_points</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">gateways</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">infra_subnets</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">interfaces</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">labels</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">linked_vpc_interface_label</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">management_domain</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">management_gateway</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">management_gateway_default_dns_zone</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">management_gateway_label</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">mgmt_subnet</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">mgmt_subnets</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">mgw_snat_ip</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">provider_gateways</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">provider_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">provider_prefix_lists</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">public_interface_label</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sddc_infra_subnet</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">vpn_dx_ips</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">vpn_endpoints</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">vpn_internet_ips</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.SddcUserConfiguration" title="Permalink to this definition"></a></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>SDDC configuration parameters for users. User-level addresses/CIDRs are
provided.</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>all_uplink_interface_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>) – All uplink interfaces label name. Deprecated, please use labels.</p></li>
<li><p><strong>all_vpn_interface_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>) – All VPN interfaces label name. Deprecated, please use labels.</p></li>
<li><p><strong>cgw_snat_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>) – Compute gateway SNAT IP address. format: ipv4</p></li>
<li><p><strong>compute_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>) – Compute domain ID. Deprecated, please use domains.</p></li>
<li><p><strong>compute_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>) – Compute gateway name. Deprecated, please use gateways.</p></li>
<li><p><strong>domains</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ProviderObject" title="com.vmware.nsx_vmc_app.model_client.ProviderObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">ProviderObject</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Domain information for management gateway and compute gateway.</p></li>
<li><p><strong>dx_interface_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>) – DirectConnect interface label name. Deprecated, please use labels.</p></li>
<li><p><strong>enforcement_points</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ProviderObject" title="com.vmware.nsx_vmc_app.model_client.ProviderObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">ProviderObject</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Policy enforcement point object paths.</p></li>
<li><p><strong>gateways</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ProviderGatewayKeyValuePairs" title="com.vmware.nsx_vmc_app.model_client.ProviderGatewayKeyValuePairs"><code class="xref py py-class docutils literal notranslate"><span class="pre">ProviderGatewayKeyValuePairs</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Provider gateway list. Including both tier-0 gateways and tier-1
gateways.</p></li>
<li><p><strong>infra_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>) – SDDC infra subnet CIDRs. format: ipv4-cidr-block</p></li>
<li><p><strong>interfaces</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ModelInterface" title="com.vmware.nsx_vmc_app.model_client.ModelInterface"><code class="xref py py-class docutils literal notranslate"><span class="pre">ModelInterface</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Interfaces (labels) including public interface, direct connect
interface, linked vpc interface, etc. Deprecated, please use
labels.</p></li>
<li><p><strong>labels</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ProviderObject" title="com.vmware.nsx_vmc_app.model_client.ProviderObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">ProviderObject</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Interfaces (labels) including internet, intranet and services.</p></li>
<li><p><strong>linked_vpc_interface_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>) – Linked VPC interface label name. Deprecated, please use labels.</p></li>
<li><p><strong>management_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>) – Management domain ID. Deprecated, please use domains.</p></li>
<li><p><strong>management_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>) – Management gateway name. Deprecated, please use gateways.</p></li>
<li><p><strong>management_gateway_default_dns_zone</strong> (<a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ProviderObject" title="com.vmware.nsx_vmc_app.model_client.ProviderObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">ProviderObject</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Management gateway default DNS zone</p></li>
<li><p><strong>management_gateway_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>) – Management gateway label name. Deprecated, please use labels.</p></li>
<li><p><strong>mgmt_subnet</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>) – Management subnet CIDRs. Deprecated, please use mgmt_subnets.
format: ipv4-cidr-block</p></li>
<li><p><strong>mgmt_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>) – Management subnet CIDRs. format: ipv4-cidr-block</p></li>
<li><p><strong>mgw_snat_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>) – Management gateway SNAT IP address. format: ipv4</p></li>
<li><p><strong>provider_gateways</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ProviderGatewayKeyValuePairs" title="com.vmware.nsx_vmc_app.model_client.ProviderGatewayKeyValuePairs"><code class="xref py py-class docutils literal notranslate"><span class="pre">ProviderGatewayKeyValuePairs</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Provider gateway list. Including both tier-0 gateways and tier-1
gateways. Deprecated, please use gateways.</p></li>
<li><p><strong>provider_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>) – Service provider name. Deprecated, please use gateways.</p></li>
<li><p><strong>provider_prefix_lists</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.PrefixListInfo" title="com.vmware.nsx_vmc_app.model_client.PrefixListInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">PrefixListInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Prefix lists used by certain features, like Intranet NAT.</p></li>
<li><p><strong>public_interface_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>) – Public interface label name. Deprecated, please use labels.</p></li>
<li><p><strong>sddc_infra_subnet</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>) – SDDC infra subnet CIDRs. Deprecated, please use infra_subnets.
format: ipv4-cidr-block</p></li>
<li><p><strong>vpn_dx_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>) – Local IPs for VPN tunnel over Direct Connect. Deprecated. Please
use vpn_endpoints instead of vpn_dx_ips. format: ipv4</p></li>
<li><p><strong>vpn_endpoints</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.VpnEndpoint" title="com.vmware.nsx_vmc_app.model_client.VpnEndpoint"><code class="xref py py-class docutils literal notranslate"><span class="pre">VpnEndpoint</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – VPN tunnel endpoints. Currently containing public IPs for VPN over
internet and local IPs for VPN over intranet.</p></li>
<li><p><strong>vpn_internet_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>) – Public IPs for VPN tunnel over internet. Deprecated. Please use
vpn_endpoints instead of vpn_internet_ips. format: ipv4</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.SelfResourceLink">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">SelfResourceLink</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">action</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">href</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">rel</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.SelfResourceLink" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The server will populate this field when returing the resource. Ignored on
PUT and POST.</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>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>) – Optional action
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>href</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Link to resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>rel</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Custom relation type (follows RFC 5988 where appropriate
definitions exist)
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.Tag">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">Tag</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">scope</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">tag</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.Tag" title="Permalink to this definition"></a></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>Arbitrary key-value pairs that may be attached to an 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>scope</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Tag searches may optionally be restricted by scope</p></li>
<li><p><strong>tag</strong> (<code class="xref 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 meaningful to user with maximum length of 256 characters</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.TrafficGroup">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">TrafficGroup</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">links</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">schema</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">self_</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">revision</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">create_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">create_user</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">last_modified_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">last_modified_user</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">protection</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">system_owned</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">description</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">display_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">resource_type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">tags</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">marked_for_delete</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">parent_path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">relative_path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">association_maps</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">resource_id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">state</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">state_message</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.TrafficGroup" title="Permalink to this definition"></a></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>Traffic group configuration. A traffic group indicates dedicated bandwidth
and computation for a given list of subnets. Creating a traffic group will
reserve resources and associating it with desired prefix lists will use the
resources for the traffic of the prefix lists. Besides traffic group ID and
name, realized state and detailed association maps info of this traffic
group are included if verbose info is requested.</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>links</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ResourceLink" title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>schema</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Schema for this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>self</strong> (<a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.SelfResourceLink" title="com.vmware.nsx_vmc_app.model_client.SelfResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">SelfResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Link to this resource</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>) – The _revision property describes the current revision of the
resource. To prevent clients from overwriting each other’s changes,
PUT operations must include the current _revision of the resource,
which clients should obtain by issuing a GET operation. If the
_revision provided in a PUT request is missing or stale, the
operation will be rejected. format: int32</p></li>
<li><p><strong>create_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>) – Timestamp of resource creation format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>create_user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – ID of the user who created this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>last_modified_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>) – Timestamp of last modification format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>last_modified_user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – ID of the user who last modified this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>protection</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Protection status is one of the following: PROTECTED - the client
who retrieved the entity is not allowed to modify it. NOT_PROTECTED
- the client who retrieved the entity is allowed to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing the request header
X-Allow-Overwrite=true. UNKNOWN - the _protection field could not
be determined for this entity.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>system_owned</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 system owned resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><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 this resource</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>) – A description field for the traffic group.</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>) – Unique identifier for a traffic group.</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>) – The type of this resource.</p></li>
<li><p><strong>tags</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.Tag" title="com.vmware.nsx_vmc_app.model_client.Tag"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tag</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque identifiers meaningful to the API user</p></li>
<li><p><strong>marked_for_delete</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>) – marked for delete identifier
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>parent_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>) – Path of its parent
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><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>) – Absolute path of this object
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>relative_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>) – Path relative from its parent
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>association_maps</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.TrafficGroupAssociationMap" title="com.vmware.nsx_vmc_app.model_client.TrafficGroupAssociationMap"><code class="xref py py-class docutils literal notranslate"><span class="pre">TrafficGroupAssociationMap</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Association maps in the traffic group.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>resource_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>) – Unique resource identifier for a traffic group. This identifier is
used in the traffic group’s related resource allocation and naming.
format: int32
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</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>
<ul>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.TrafficGroup.STATE_IN_PROGRESS" title="com.vmware.nsx_vmc_app.model_client.TrafficGroup.STATE_IN_PROGRESS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">TrafficGroup.STATE_IN_PROGRESS</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.TrafficGroup.STATE_SUCCESS" title="com.vmware.nsx_vmc_app.model_client.TrafficGroup.STATE_SUCCESS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">TrafficGroup.STATE_SUCCESS</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.TrafficGroup.STATE_FAILURE" title="com.vmware.nsx_vmc_app.model_client.TrafficGroup.STATE_FAILURE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">TrafficGroup.STATE_FAILURE</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.TrafficGroup.STATE_UNAVAILABLE" title="com.vmware.nsx_vmc_app.model_client.TrafficGroup.STATE_UNAVAILABLE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">TrafficGroup.STATE_UNAVAILABLE</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.TrafficGroup.STATE_PENDING" title="com.vmware.nsx_vmc_app.model_client.TrafficGroup.STATE_PENDING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">TrafficGroup.STATE_PENDING</span></code></a></p></li>
</ul>
<p>Realized state of the traffic group. This matches the realized
state (VmcConsolidatedStatus) of the traffic group.
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>
</p></li>
<li><p><strong>state_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>) – Information on the current state. Mostly error messages on failure
states.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
</ul>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.TrafficGroup.STATE_FAILURE">
<code class="sig-name descname">STATE_FAILURE</code><em class="property"> = 'FAILURE'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.TrafficGroup.STATE_FAILURE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.TrafficGroup.STATE_IN_PROGRESS">
<code class="sig-name descname">STATE_IN_PROGRESS</code><em class="property"> = 'IN_PROGRESS'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.TrafficGroup.STATE_IN_PROGRESS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.TrafficGroup.STATE_PENDING">
<code class="sig-name descname">STATE_PENDING</code><em class="property"> = 'PENDING'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.TrafficGroup.STATE_PENDING" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.TrafficGroup.STATE_SUCCESS">
<code class="sig-name descname">STATE_SUCCESS</code><em class="property"> = 'SUCCESS'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.TrafficGroup.STATE_SUCCESS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.TrafficGroup.STATE_UNAVAILABLE">
<code class="sig-name descname">STATE_UNAVAILABLE</code><em class="property"> = 'UNAVAILABLE'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.TrafficGroup.STATE_UNAVAILABLE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.TrafficGroupAssociationMap">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">TrafficGroupAssociationMap</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">links</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">schema</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">self_</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">revision</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">create_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">create_user</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">last_modified_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">last_modified_user</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">protection</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">system_owned</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">description</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">display_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">resource_type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">tags</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">marked_for_delete</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">parent_path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">relative_path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">prefix_lists</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">scope</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">state</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">state_message</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.TrafficGroupAssociationMap" title="Permalink to this definition"></a></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>An association map of a traffic group. It describes the association of
prefix lists and logical routers with the traffic group. To make use of
dedicated traffic resources through traffic groups, prefix lists need to be
linked to the desired traffic group and an association with the target
logical router (scope) is required. The scope is for declaring which
logical router the prefix lists are associated under a particular traffic
group. The scope is not required input.</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>links</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ResourceLink" title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>schema</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Schema for this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>self</strong> (<a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.SelfResourceLink" title="com.vmware.nsx_vmc_app.model_client.SelfResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">SelfResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Link to this resource</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>) – The _revision property describes the current revision of the
resource. To prevent clients from overwriting each other’s changes,
PUT operations must include the current _revision of the resource,
which clients should obtain by issuing a GET operation. If the
_revision provided in a PUT request is missing or stale, the
operation will be rejected. format: int32</p></li>
<li><p><strong>create_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>) – Timestamp of resource creation format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>create_user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – ID of the user who created this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>last_modified_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>) – Timestamp of last modification format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>last_modified_user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – ID of the user who last modified this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>protection</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Protection status is one of the following: PROTECTED - the client
who retrieved the entity is not allowed to modify it. NOT_PROTECTED
- the client who retrieved the entity is allowed to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing the request header
X-Allow-Overwrite=true. UNKNOWN - the _protection field could not
be determined for this entity.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>system_owned</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 system owned resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><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 this resource</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>) – A description field for Traffic group association map。</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 association map id.</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>) – The type of this resource.</p></li>
<li><p><strong>tags</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.Tag" title="com.vmware.nsx_vmc_app.model_client.Tag"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tag</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque identifiers meaningful to the API user</p></li>
<li><p><strong>marked_for_delete</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>) – marked for delete identifier
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>parent_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>) – Path of its parent
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><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>) – Absolute path of this object
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>relative_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>) – Path relative from its parent
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>prefix_lists</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>) – The list of prefix lists to be associated.</p></li>
<li><p><strong>scope</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Possible values are:</p>
<ul>
<li><p><code class="xref py py-attr docutils literal notranslate"><span class="pre">TrafficGroupAssociationMap.SCOPE__1S_CGW</span></code></p></li>
<li><p><code class="xref py py-attr docutils literal notranslate"><span class="pre">TrafficGroupAssociationMap.SCOPE__0S_VMC</span></code></p></li>
</ul>
<p>The targeted logical router (scope) of prefix lists. Non admin
users are not allowed to create, update, delete an association map
with scope as /infra/tier-0s/vmc.</p>
</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>
<ul>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.TrafficGroupAssociationMap.STATE_IN_PROGRESS" title="com.vmware.nsx_vmc_app.model_client.TrafficGroupAssociationMap.STATE_IN_PROGRESS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">TrafficGroupAssociationMap.STATE_IN_PROGRESS</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.TrafficGroupAssociationMap.STATE_SUCCESS" title="com.vmware.nsx_vmc_app.model_client.TrafficGroupAssociationMap.STATE_SUCCESS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">TrafficGroupAssociationMap.STATE_SUCCESS</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.TrafficGroupAssociationMap.STATE_FAILURE" title="com.vmware.nsx_vmc_app.model_client.TrafficGroupAssociationMap.STATE_FAILURE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">TrafficGroupAssociationMap.STATE_FAILURE</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.TrafficGroupAssociationMap.STATE_UNAVAILABLE" title="com.vmware.nsx_vmc_app.model_client.TrafficGroupAssociationMap.STATE_UNAVAILABLE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">TrafficGroupAssociationMap.STATE_UNAVAILABLE</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.TrafficGroupAssociationMap.STATE_PENDING" title="com.vmware.nsx_vmc_app.model_client.TrafficGroupAssociationMap.STATE_PENDING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">TrafficGroupAssociationMap.STATE_PENDING</span></code></a></p></li>
</ul>
<p>Realized state of the traffic group. This matches the realized
state (VmcConsolidatedStatus) of the traffic group.
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>
</p></li>
<li><p><strong>state_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>) – Information on the current state. Mostly error messages on failure
states.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
</ul>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.TrafficGroupAssociationMap.SCOPE_0S_VMC">
<code class="sig-name descname">SCOPE_0S_VMC</code><em class="property"> = '/infra/tier-0s/vmc'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.TrafficGroupAssociationMap.SCOPE_0S_VMC" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.TrafficGroupAssociationMap.SCOPE_1S_CGW">
<code class="sig-name descname">SCOPE_1S_CGW</code><em class="property"> = '/infra/tier-1s/cgw'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.TrafficGroupAssociationMap.SCOPE_1S_CGW" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.TrafficGroupAssociationMap.STATE_FAILURE">
<code class="sig-name descname">STATE_FAILURE</code><em class="property"> = 'FAILURE'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.TrafficGroupAssociationMap.STATE_FAILURE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.TrafficGroupAssociationMap.STATE_IN_PROGRESS">
<code class="sig-name descname">STATE_IN_PROGRESS</code><em class="property"> = 'IN_PROGRESS'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.TrafficGroupAssociationMap.STATE_IN_PROGRESS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.TrafficGroupAssociationMap.STATE_PENDING">
<code class="sig-name descname">STATE_PENDING</code><em class="property"> = 'PENDING'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.TrafficGroupAssociationMap.STATE_PENDING" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.TrafficGroupAssociationMap.STATE_SUCCESS">
<code class="sig-name descname">STATE_SUCCESS</code><em class="property"> = 'SUCCESS'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.TrafficGroupAssociationMap.STATE_SUCCESS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.TrafficGroupAssociationMap.STATE_UNAVAILABLE">
<code class="sig-name descname">STATE_UNAVAILABLE</code><em class="property"> = 'UNAVAILABLE'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.TrafficGroupAssociationMap.STATE_UNAVAILABLE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.TrafficGroupAssociationMapsListResult">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">TrafficGroupAssociationMapsListResult</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">links</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">schema</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">self_</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cursor</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">result_count</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_ascending</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_by</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">results</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.TrafficGroupAssociationMapsListResult" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>List result for traffic group association maps.</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>links</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ResourceLink" title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>schema</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Schema for this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>self</strong> (<a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.SelfResourceLink" title="com.vmware.nsx_vmc_app.model_client.SelfResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">SelfResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Link to this resource</p></li>
<li><p><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
by current result page)
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>result_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>) – Count of results found (across all pages), set only on first page
format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>sort_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>) – If true, results are sorted in ascending order
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><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>) – Field by which records are sorted
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>results</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.TrafficGroupAssociationMap" title="com.vmware.nsx_vmc_app.model_client.TrafficGroupAssociationMap"><code class="xref py py-class docutils literal notranslate"><span class="pre">TrafficGroupAssociationMap</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Traffic group association map list</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.TrafficGroupsListResult">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">TrafficGroupsListResult</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">links</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">schema</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">self_</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cursor</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">result_count</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_ascending</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_by</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">results</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.TrafficGroupsListResult" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>List result for traffic groups.</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>links</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ResourceLink" title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>schema</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Schema for this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>self</strong> (<a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.SelfResourceLink" title="com.vmware.nsx_vmc_app.model_client.SelfResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">SelfResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Link to this resource</p></li>
<li><p><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
by current result page)
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>result_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>) – Count of results found (across all pages), set only on first page
format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>sort_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>) – If true, results are sorted in ascending order
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><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>) – Field by which records are sorted
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>results</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.TrafficGroup" title="com.vmware.nsx_vmc_app.model_client.TrafficGroup"><code class="xref py py-class docutils literal notranslate"><span class="pre">TrafficGroup</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Traffic group list</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.VMCAccounts">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">VMCAccounts</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">linked_vpc_account</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">shadow_account</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.VMCAccounts" title="Permalink to this definition"></a></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>Shadow account and linked VPC account</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>linked_vpc_account</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – linked VPC account number</p></li>
<li><p><strong>shadow_account</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Shadow VPC account number</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.VifsListResult">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">VifsListResult</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">links</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">schema</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">self_</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cursor</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">result_count</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_ascending</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_by</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">results</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.VifsListResult" title="Permalink to this definition"></a></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>Direct Connect VIFs (Virtual Interface) list query result</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>links</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ResourceLink" title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>schema</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Schema for this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>self</strong> (<a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.SelfResourceLink" title="com.vmware.nsx_vmc_app.model_client.SelfResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">SelfResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Link to this resource</p></li>
<li><p><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
by current result page)
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>result_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>) – Count of results found (across all pages), set only on first page
format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>sort_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>) – If true, results are sorted in ascending order
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><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>) – Field by which records are sorted
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>results</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.VirtualInterface" title="com.vmware.nsx_vmc_app.model_client.VirtualInterface"><code class="xref py py-class docutils literal notranslate"><span class="pre">VirtualInterface</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – VIFs list</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.VirtualInterface">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">VirtualInterface</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">bgp_status</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">direct_connect_id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">local_ip</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">mtu</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">remote_asn</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">remote_ip</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">state</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.VirtualInterface" title="Permalink to this definition"></a></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>bgp_status</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Possible values are:</p>
<ul>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.VirtualInterface.BGP_STATUS_UP" title="com.vmware.nsx_vmc_app.model_client.VirtualInterface.BGP_STATUS_UP"><code class="xref py py-attr docutils literal notranslate"><span class="pre">VirtualInterface.BGP_STATUS_UP</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.VirtualInterface.BGP_STATUS_DOWN" title="com.vmware.nsx_vmc_app.model_client.VirtualInterface.BGP_STATUS_DOWN"><code class="xref py py-attr docutils literal notranslate"><span class="pre">VirtualInterface.BGP_STATUS_DOWN</span></code></a></p></li>
</ul>
<blockquote>
<div><p>BGP status</p>
</div></blockquote>
</p></li>
<li><p><strong>direct_connect_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 Direct Connect</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>) – Identifier for the virtual interface</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>) – amazon side address format: ipv4
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><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>) – Maximum transmission unit allowed by the VIF format: int32
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</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>) – VIF name</p></li>
<li><p><strong>remote_asn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Remote autonomous system number of vif
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>remote_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>) – customer address format: ipv4
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><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>
<ul>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_CONFIRMING" title="com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_CONFIRMING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">VirtualInterface.STATE_CONFIRMING</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_VERIFYING" title="com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_VERIFYING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">VirtualInterface.STATE_VERIFYING</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_PENDING" title="com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_PENDING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">VirtualInterface.STATE_PENDING</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_AVAILABLE" title="com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_AVAILABLE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">VirtualInterface.STATE_AVAILABLE</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_DOWN" title="com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_DOWN"><code class="xref py py-attr docutils literal notranslate"><span class="pre">VirtualInterface.STATE_DOWN</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_DELETING" title="com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_DELETING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">VirtualInterface.STATE_DELETING</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_DELETED" title="com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_DELETED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">VirtualInterface.STATE_DELETED</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_REJECTED" title="com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_REJECTED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">VirtualInterface.STATE_REJECTED</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_ATTACHED" title="com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_ATTACHED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">VirtualInterface.STATE_ATTACHED</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_ATTACHING" title="com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_ATTACHING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">VirtualInterface.STATE_ATTACHING</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_ERROR" title="com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_ERROR"><code class="xref py py-attr docutils literal notranslate"><span class="pre">VirtualInterface.STATE_ERROR</span></code></a></p></li>
</ul>
<blockquote>
<div><p>VIF State</p>
</div></blockquote>
</p></li>
</ul>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.VirtualInterface.BGP_STATUS_DOWN">
<code class="sig-name descname">BGP_STATUS_DOWN</code><em class="property"> = 'DOWN'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.VirtualInterface.BGP_STATUS_DOWN" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.VirtualInterface.BGP_STATUS_UP">
<code class="sig-name descname">BGP_STATUS_UP</code><em class="property"> = 'UP'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.VirtualInterface.BGP_STATUS_UP" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_ATTACHED">
<code class="sig-name descname">STATE_ATTACHED</code><em class="property"> = 'ATTACHED'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_ATTACHED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_ATTACHING">
<code class="sig-name descname">STATE_ATTACHING</code><em class="property"> = 'ATTACHING'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_ATTACHING" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_AVAILABLE">
<code class="sig-name descname">STATE_AVAILABLE</code><em class="property"> = 'AVAILABLE'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_AVAILABLE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_CONFIRMING">
<code class="sig-name descname">STATE_CONFIRMING</code><em class="property"> = 'CONFIRMING'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_CONFIRMING" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_DELETED">
<code class="sig-name descname">STATE_DELETED</code><em class="property"> = 'DELETED'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_DELETED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_DELETING">
<code class="sig-name descname">STATE_DELETING</code><em class="property"> = 'DELETING'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_DELETING" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_DOWN">
<code class="sig-name descname">STATE_DOWN</code><em class="property"> = 'DOWN'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_DOWN" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_ERROR">
<code class="sig-name descname">STATE_ERROR</code><em class="property"> = 'ERROR'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_ERROR" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_PENDING">
<code class="sig-name descname">STATE_PENDING</code><em class="property"> = 'PENDING'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_PENDING" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_REJECTED">
<code class="sig-name descname">STATE_REJECTED</code><em class="property"> = 'REJECTED'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_REJECTED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_VERIFYING">
<code class="sig-name descname">STATE_VERIFYING</code><em class="property"> = 'VERIFYING'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_VERIFYING" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.VmcAppBaseInfo">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">VmcAppBaseInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">links</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">schema</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">self_</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">revision</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">create_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">create_user</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">last_modified_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">last_modified_user</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">protection</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">system_owned</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">description</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">display_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">resource_type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">tags</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">marked_for_delete</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">parent_path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">relative_path</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.VmcAppBaseInfo" title="Permalink to this definition"></a></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>Abstract base class for all the VmcApp objects.</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>links</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ResourceLink" title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>schema</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Schema for this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>self</strong> (<a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.SelfResourceLink" title="com.vmware.nsx_vmc_app.model_client.SelfResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">SelfResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Link to this resource</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>) – The _revision property describes the current revision of the
resource. To prevent clients from overwriting each other’s changes,
PUT operations must include the current _revision of the resource,
which clients should obtain by issuing a GET operation. If the
_revision provided in a PUT request is missing or stale, the
operation will be rejected. format: int32</p></li>
<li><p><strong>create_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>) – Timestamp of resource creation format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>create_user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – ID of the user who created this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>last_modified_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>) – Timestamp of last modification format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>last_modified_user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – ID of the user who last modified this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>protection</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Protection status is one of the following: PROTECTED - the client
who retrieved the entity is not allowed to modify it. NOT_PROTECTED
- the client who retrieved the entity is allowed to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing the request header
X-Allow-Overwrite=true. UNKNOWN - the _protection field could not
be determined for this entity.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>system_owned</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 system owned resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><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 this resource</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>) – Defaults to ID if not set</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>) – Unique identifier of this resource</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>) – The type of this resource.</p></li>
<li><p><strong>tags</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.Tag" title="com.vmware.nsx_vmc_app.model_client.Tag"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tag</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque identifiers meaningful to the API user</p></li>
<li><p><strong>marked_for_delete</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>) – marked for delete identifier
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>parent_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>) – Path of its parent
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><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>) – Absolute path of this object
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>relative_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>) – Path relative from its parent
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.VmcConsolidatedRealizedStatus">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">VmcConsolidatedRealizedStatus</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">consolidated_status</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">consolidated_status_per_object</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">intent_path</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.VmcConsolidatedRealizedStatus" title="Permalink to this definition"></a></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 aggregated realized status for intent entity across associated
realized entities.</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>consolidated_status</strong> (<a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatus" title="com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">VmcConsolidatedStatus</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Consolidated state of objects for a given intent entity.</p></li>
<li><p><strong>consolidated_status_per_object</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatusPerObject" title="com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatusPerObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">VmcConsolidatedStatusPerObject</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Aggregated consolidated status by enforcement point.</p></li>
<li><p><strong>intent_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>) – Intent path of the object representing this consolidated state.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatus">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">VmcConsolidatedStatus</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">consolidated_status</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">status_message</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatus" title="Permalink to this definition"></a></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>Consolidated status of an object.</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>consolidated_status</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Possible values are:</p>
<ul>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatus.CONSOLIDATED_STATUS_IN_PROGRESS" title="com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatus.CONSOLIDATED_STATUS_IN_PROGRESS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">VmcConsolidatedStatus.CONSOLIDATED_STATUS_IN_PROGRESS</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatus.CONSOLIDATED_STATUS_SUCCESS" title="com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatus.CONSOLIDATED_STATUS_SUCCESS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">VmcConsolidatedStatus.CONSOLIDATED_STATUS_SUCCESS</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatus.CONSOLIDATED_STATUS_FAILURE" title="com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatus.CONSOLIDATED_STATUS_FAILURE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">VmcConsolidatedStatus.CONSOLIDATED_STATUS_FAILURE</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatus.CONSOLIDATED_STATUS_UNAVAILABLE" title="com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatus.CONSOLIDATED_STATUS_UNAVAILABLE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">VmcConsolidatedStatus.CONSOLIDATED_STATUS_UNAVAILABLE</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatus.CONSOLIDATED_STATUS_PENDING" title="com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatus.CONSOLIDATED_STATUS_PENDING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">VmcConsolidatedStatus.CONSOLIDATED_STATUS_PENDING</span></code></a></p></li>
</ul>
<blockquote>
<div><p>Realized state of consolidation.</p>
</div></blockquote>
</p></li>
<li><p><strong>status_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>) – Help message for the current status regarding an object, providing
information for each state.</p></li>
</ul>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatus.CONSOLIDATED_STATUS_FAILURE">
<code class="sig-name descname">CONSOLIDATED_STATUS_FAILURE</code><em class="property"> = 'FAILURE'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatus.CONSOLIDATED_STATUS_FAILURE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatus.CONSOLIDATED_STATUS_IN_PROGRESS">
<code class="sig-name descname">CONSOLIDATED_STATUS_IN_PROGRESS</code><em class="property"> = 'IN_PROGRESS'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatus.CONSOLIDATED_STATUS_IN_PROGRESS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatus.CONSOLIDATED_STATUS_PENDING">
<code class="sig-name descname">CONSOLIDATED_STATUS_PENDING</code><em class="property"> = 'PENDING'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatus.CONSOLIDATED_STATUS_PENDING" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatus.CONSOLIDATED_STATUS_SUCCESS">
<code class="sig-name descname">CONSOLIDATED_STATUS_SUCCESS</code><em class="property"> = 'SUCCESS'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatus.CONSOLIDATED_STATUS_SUCCESS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatus.CONSOLIDATED_STATUS_UNAVAILABLE">
<code class="sig-name descname">CONSOLIDATED_STATUS_UNAVAILABLE</code><em class="property"> = 'UNAVAILABLE'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatus.CONSOLIDATED_STATUS_UNAVAILABLE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatusPerObject">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">VmcConsolidatedStatusPerObject</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">consolidated_status</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">object_id</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatusPerObject" title="Permalink to this definition"></a></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>Realized status consolidated by individual objects.</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>consolidated_status</strong> (<a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatus" title="com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">VmcConsolidatedStatus</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Detailed consolidated realized status for an intent object.</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>) – Object id used to consolidate state. This can be a particular
backend task/job, etc.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.VmcFeatureFlagInfo">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">VmcFeatureFlagInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">links</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">schema</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">self_</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">revision</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">create_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">create_user</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">last_modified_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">last_modified_user</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">protection</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">system_owned</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">description</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">display_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">resource_type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">tags</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">marked_for_delete</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">parent_path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">relative_path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">internal_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">message</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">state</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.VmcFeatureFlagInfo" title="Permalink to this definition"></a></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>VMC Feature Flag</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>links</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ResourceLink" title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>schema</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Schema for this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>self</strong> (<a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.SelfResourceLink" title="com.vmware.nsx_vmc_app.model_client.SelfResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">SelfResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Link to this resource</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>) – The _revision property describes the current revision of the
resource. To prevent clients from overwriting each other’s changes,
PUT operations must include the current _revision of the resource,
which clients should obtain by issuing a GET operation. If the
_revision provided in a PUT request is missing or stale, the
operation will be rejected. format: int32</p></li>
<li><p><strong>create_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>) – Timestamp of resource creation format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>create_user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – ID of the user who created this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>last_modified_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>) – Timestamp of last modification format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>last_modified_user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – ID of the user who last modified this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>protection</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Protection status is one of the following: PROTECTED - the client
who retrieved the entity is not allowed to modify it. NOT_PROTECTED
- the client who retrieved the entity is allowed to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing the request header
X-Allow-Overwrite=true. UNKNOWN - the _protection field could not
be determined for this entity.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>system_owned</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 system owned resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><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 this resource</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>) – Defaults to ID if not set</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>) – Unique identifier of this resource</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>) – The type of this resource.</p></li>
<li><p><strong>tags</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.Tag" title="com.vmware.nsx_vmc_app.model_client.Tag"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tag</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque identifiers meaningful to the API user</p></li>
<li><p><strong>marked_for_delete</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>) – marked for delete identifier
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>parent_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>) – Path of its parent
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><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>) – Absolute path of this object
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>relative_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>) – Path relative from its parent
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>internal_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>) – Internal Name
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Message</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>) – Feature Name</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>
<ul>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.VmcFeatureFlagInfo.STATE_ENABLED" title="com.vmware.nsx_vmc_app.model_client.VmcFeatureFlagInfo.STATE_ENABLED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">VmcFeatureFlagInfo.STATE_ENABLED</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.VmcFeatureFlagInfo.STATE_DISABLED" title="com.vmware.nsx_vmc_app.model_client.VmcFeatureFlagInfo.STATE_DISABLED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">VmcFeatureFlagInfo.STATE_DISABLED</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.VmcFeatureFlagInfo.STATE_INACTIVE" title="com.vmware.nsx_vmc_app.model_client.VmcFeatureFlagInfo.STATE_INACTIVE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">VmcFeatureFlagInfo.STATE_INACTIVE</span></code></a></p></li>
</ul>
<blockquote>
<div><p>state</p>
</div></blockquote>
</p></li>
</ul>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.VmcFeatureFlagInfo.STATE_DISABLED">
<code class="sig-name descname">STATE_DISABLED</code><em class="property"> = 'disabled'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.VmcFeatureFlagInfo.STATE_DISABLED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.VmcFeatureFlagInfo.STATE_ENABLED">
<code class="sig-name descname">STATE_ENABLED</code><em class="property"> = 'enabled'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.VmcFeatureFlagInfo.STATE_ENABLED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.VmcFeatureFlagInfo.STATE_INACTIVE">
<code class="sig-name descname">STATE_INACTIVE</code><em class="property"> = 'inactive'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.VmcFeatureFlagInfo.STATE_INACTIVE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.VmcFeatureFlags">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">VmcFeatureFlags</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">features</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.VmcFeatureFlags" title="Permalink to this definition"></a></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>VMC Feature flags</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>features</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.VmcFeatureFlagInfo" title="com.vmware.nsx_vmc_app.model_client.VmcFeatureFlagInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">VmcFeatureFlagInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.VmcRealizedEntities">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">VmcRealizedEntities</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">intent_path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">realized_entities</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">realized_entities_id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">realized_state</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.VmcRealizedEntities" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>A consolidated object of realized entities given an intent path. This
accounts for resources / entities which are realized under the intent path.</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>intent_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>) – Intent path
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>realized_entities</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.VmcRealizedEntity" title="com.vmware.nsx_vmc_app.model_client.VmcRealizedEntity"><code class="xref py py-class docutils literal notranslate"><span class="pre">VmcRealizedEntity</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Detailed realized entities list.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>realized_entities_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>) – Realized entities id
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>realized_state</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Possible values are:</p>
<ul>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.VmcRealizedEntities.REALIZED_STATE_IN_PROGRESS" title="com.vmware.nsx_vmc_app.model_client.VmcRealizedEntities.REALIZED_STATE_IN_PROGRESS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">VmcRealizedEntities.REALIZED_STATE_IN_PROGRESS</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.VmcRealizedEntities.REALIZED_STATE_SUCCESS" title="com.vmware.nsx_vmc_app.model_client.VmcRealizedEntities.REALIZED_STATE_SUCCESS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">VmcRealizedEntities.REALIZED_STATE_SUCCESS</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.VmcRealizedEntities.REALIZED_STATE_FAILURE" title="com.vmware.nsx_vmc_app.model_client.VmcRealizedEntities.REALIZED_STATE_FAILURE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">VmcRealizedEntities.REALIZED_STATE_FAILURE</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.VmcRealizedEntities.REALIZED_STATE_UNAVAILABLE" title="com.vmware.nsx_vmc_app.model_client.VmcRealizedEntities.REALIZED_STATE_UNAVAILABLE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">VmcRealizedEntities.REALIZED_STATE_UNAVAILABLE</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.VmcRealizedEntities.REALIZED_STATE_PENDING" title="com.vmware.nsx_vmc_app.model_client.VmcRealizedEntities.REALIZED_STATE_PENDING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">VmcRealizedEntities.REALIZED_STATE_PENDING</span></code></a></p></li>
</ul>
<blockquote>
<div><p>Realized state</p>
</div></blockquote>
<p>This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p>
</p></li>
</ul>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.VmcRealizedEntities.REALIZED_STATE_FAILURE">
<code class="sig-name descname">REALIZED_STATE_FAILURE</code><em class="property"> = 'FAILURE'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.VmcRealizedEntities.REALIZED_STATE_FAILURE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.VmcRealizedEntities.REALIZED_STATE_IN_PROGRESS">
<code class="sig-name descname">REALIZED_STATE_IN_PROGRESS</code><em class="property"> = 'IN_PROGRESS'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.VmcRealizedEntities.REALIZED_STATE_IN_PROGRESS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.VmcRealizedEntities.REALIZED_STATE_PENDING">
<code class="sig-name descname">REALIZED_STATE_PENDING</code><em class="property"> = 'PENDING'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.VmcRealizedEntities.REALIZED_STATE_PENDING" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.VmcRealizedEntities.REALIZED_STATE_SUCCESS">
<code class="sig-name descname">REALIZED_STATE_SUCCESS</code><em class="property"> = 'SUCCESS'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.VmcRealizedEntities.REALIZED_STATE_SUCCESS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.VmcRealizedEntities.REALIZED_STATE_UNAVAILABLE">
<code class="sig-name descname">REALIZED_STATE_UNAVAILABLE</code><em class="property"> = 'UNAVAILABLE'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.VmcRealizedEntities.REALIZED_STATE_UNAVAILABLE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.VmcRealizedEntity">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">VmcRealizedEntity</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">realization_api</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">realization_id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">realization_path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">realized_entity_id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">realized_entity_type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">realized_state</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.VmcRealizedEntity" title="Permalink to this definition"></a></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>Realized entity object. This accounts for an resource / entity which is
realized within cloud service.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>realization_api</strong> (<code class="xref 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 realization API path
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>realization_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>) – Resource realization id. This can differ from realized_entity_id as
this can be an external id.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>realization_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>) – The path for the realization of an entity. This can be an URI, etc.
Some resources are identified by their paths.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>realized_entity_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>) – Realized entity id
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>realized_entity_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>) – Realized entity type
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>realized_state</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Possible values are:</p>
<ul>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.VmcRealizedEntity.REALIZED_STATE_IN_PROGRESS" title="com.vmware.nsx_vmc_app.model_client.VmcRealizedEntity.REALIZED_STATE_IN_PROGRESS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">VmcRealizedEntity.REALIZED_STATE_IN_PROGRESS</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.VmcRealizedEntity.REALIZED_STATE_SUCCESS" title="com.vmware.nsx_vmc_app.model_client.VmcRealizedEntity.REALIZED_STATE_SUCCESS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">VmcRealizedEntity.REALIZED_STATE_SUCCESS</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.VmcRealizedEntity.REALIZED_STATE_FAILURE" title="com.vmware.nsx_vmc_app.model_client.VmcRealizedEntity.REALIZED_STATE_FAILURE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">VmcRealizedEntity.REALIZED_STATE_FAILURE</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.VmcRealizedEntity.REALIZED_STATE_UNAVAILABLE" title="com.vmware.nsx_vmc_app.model_client.VmcRealizedEntity.REALIZED_STATE_UNAVAILABLE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">VmcRealizedEntity.REALIZED_STATE_UNAVAILABLE</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.VmcRealizedEntity.REALIZED_STATE_PENDING" title="com.vmware.nsx_vmc_app.model_client.VmcRealizedEntity.REALIZED_STATE_PENDING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">VmcRealizedEntity.REALIZED_STATE_PENDING</span></code></a></p></li>
</ul>
<blockquote>
<div><p>Realized state</p>
</div></blockquote>
<p>This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p>
</p></li>
</ul>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.VmcRealizedEntity.REALIZED_STATE_FAILURE">
<code class="sig-name descname">REALIZED_STATE_FAILURE</code><em class="property"> = 'FAILURE'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.VmcRealizedEntity.REALIZED_STATE_FAILURE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.VmcRealizedEntity.REALIZED_STATE_IN_PROGRESS">
<code class="sig-name descname">REALIZED_STATE_IN_PROGRESS</code><em class="property"> = 'IN_PROGRESS'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.VmcRealizedEntity.REALIZED_STATE_IN_PROGRESS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.VmcRealizedEntity.REALIZED_STATE_PENDING">
<code class="sig-name descname">REALIZED_STATE_PENDING</code><em class="property"> = 'PENDING'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.VmcRealizedEntity.REALIZED_STATE_PENDING" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.VmcRealizedEntity.REALIZED_STATE_SUCCESS">
<code class="sig-name descname">REALIZED_STATE_SUCCESS</code><em class="property"> = 'SUCCESS'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.VmcRealizedEntity.REALIZED_STATE_SUCCESS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.VmcRealizedEntity.REALIZED_STATE_UNAVAILABLE">
<code class="sig-name descname">REALIZED_STATE_UNAVAILABLE</code><em class="property"> = 'UNAVAILABLE'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.VmcRealizedEntity.REALIZED_STATE_UNAVAILABLE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_vmc_app.model_client.VpnEndpoint">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="sig-name descname">VpnEndpoint</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">interface_label</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">ip</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">type</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.VpnEndpoint" title="Permalink to this definition"></a></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>VPN endpoint information</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>interface_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 the VPN endpoint</p></li>
<li><p><strong>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 address of the VPN endpoint format: ipv4</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 VPN endpoint</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 VPN endpoint</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="com.vmware.nsx_vmc_app.infra.html" class="btn btn-neutral float-right" title="com.vmware.nsx_vmc_app.infra package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<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>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2020, VMware, Inc.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
View Git Blame Copy Permalink