Mirrors/vsphere-automation-sdk-python
1
0
Fork 0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-22 17:39:59 -05:00
Code
99cae3a8aa
vsphere-automation-sdk-python/nsx/nsx_vmc_aws_integration/com.vmware.nsx_vmc_app.html

4249 lines
400 KiB
HTML
Raw Normal View History

Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<!DOCTYPE html>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<html class="writer-html4" lang="en" >
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<head>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<meta charset="utf-8" />
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<title>com.vmware.nsx_vmc_app package &mdash; NSX VMC AWS Integration API 3.0.3.0.0 documentation</title>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<!--[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>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<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" >
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<a href="index.html" class="icon icon-home"> NSX VMC AWS Integration API
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</a>
<div class="version">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
3.0.3.0.0
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.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">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<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">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<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>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.infra_client.Accounts">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.infra_client.</code><code class="descname">Accounts</code><span class="sig-paren">(</span><em>config</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
</tr>
</tbody>
</table>
<dl class="method">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.infra_client.Accounts.get">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Retrieve the shadow account and linked VPC account information from VMC
provider. This API is a live query to VMC provider.</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><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></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">com.vmware.nsx_vmc_app.model.VMCAccounts</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.infra_client.AssociatedGroups">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.infra_client.</code><code class="descname">AssociatedGroups</code><span class="sig-paren">(</span><em>config</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
</tr>
</tbody>
</table>
<dl class="method">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.infra_client.AssociatedGroups.delete">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="descname">delete</code><span class="sig-paren">(</span><em>sddc_group_id</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Delete the associated Group connection info for the local SDDC before
removing the SDDC from the Group.</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>sddc_group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="method">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.infra_client.AssociatedGroups.get">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="descname">get</code><span class="sig-paren">(</span><em>sddc_group_id</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<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>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>sddc_group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code></td>
</tr>
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">com.vmware.nsx_vmc_app.model.AssociatedBaseGroupConnectionInfo
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
The return value will contain all the attributes defined in
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<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>.</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="method">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.infra_client.AssociatedGroups.list">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<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>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><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></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">com.vmware.nsx_vmc_app.model.AssociatedGroupConnectionInfosListResult</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="method">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.infra_client.AssociatedGroups.update">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="descname">update</code><span class="sig-paren">(</span><em>sddc_group_id</em>, <em>associated_base_group_connection_info</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Create or update the associated Group connection info for reflecting
the SDDC’s association state with SDDC group.</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>sddc_group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
<li><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)
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
The parameter must contain all the attributes defined in
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<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>.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code></p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx_vmc_app.model.AssociatedBaseGroupConnectionInfo
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
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>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Service Unavailable</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Bad Request, Precondition Failed</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Internal Server Error</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Forbidden</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Not Found</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.infra_client.FeatureFlags">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.infra_client.</code><code class="descname">FeatureFlags</code><span class="sig-paren">(</span><em>config</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
</tr>
</tbody>
</table>
<dl class="method">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.infra_client.FeatureFlags.get">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="descname">get</code><span class="sig-paren">(</span><em>internal_name=None</em>, <em>name=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Get vmc environment feature flags</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>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)</li>
<li><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – feature name (optional)</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.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>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx_vmc_app.model.VmcFeatureFlags</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Service Unavailable</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Bad Request, Precondition Failed</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Internal Server Error</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Forbidden</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Not Found</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.infra_client.LinkedVpcs">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.infra_client.</code><code class="descname">LinkedVpcs</code><span class="sig-paren">(</span><em>config</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
</tr>
</tbody>
</table>
<dl class="method">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.infra_client.LinkedVpcs.get">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="descname">get</code><span class="sig-paren">(</span><em>linked_vpc_id</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Get linked VPC information associated with given ID.</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>linked_vpc_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.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></td>
</tr>
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">com.vmware.nsx_vmc_app.model.LinkedVpcInfo</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="method">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.infra_client.LinkedVpcs.list">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>List all linked VPC information.</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><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></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">com.vmware.nsx_vmc_app.model.LinkedVpcsListResult</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.infra_client.MgmtVms">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.infra_client.</code><code class="descname">MgmtVms</code><span class="sig-paren">(</span><em>config</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
</tr>
</tbody>
</table>
<dl class="method">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.infra_client.MgmtVms.get">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="descname">get</code><span class="sig-paren">(</span><em>vm_id</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Get management VM access information.</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>vm_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.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></td>
</tr>
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">com.vmware.nsx_vmc_app.model.MgmtVmInfo</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="method">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.infra_client.MgmtVms.list">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>List Management VM information.</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><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></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">com.vmware.nsx_vmc_app.model.MgmtVmsListResult</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.infra_client.PublicIps">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.infra_client.</code><code class="descname">PublicIps</code><span class="sig-paren">(</span><em>config</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
</tr>
</tbody>
</table>
<dl class="method">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.infra_client.PublicIps.delete">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="descname">delete</code><span class="sig-paren">(</span><em>public_ip_id</em>, <em>force=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Delete a public IP. The IP will be released in VMC provider.</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>public_ip_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
<li><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)</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Service Unavailable</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Bad Request, Precondition Failed</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Internal Server Error</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Forbidden</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Not Found</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="method">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.infra_client.PublicIps.get">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="descname">get</code><span class="sig-paren">(</span><em>public_ip_id</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Get public IP information associated with given ID.</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>public_ip_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.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></td>
</tr>
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">com.vmware.nsx_vmc_app.model.PublicIp</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="method">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.infra_client.PublicIps.list">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="descname">list</code><span class="sig-paren">(</span><em>cursor=None</em>, <em>included_fields=None</em>, <em>page_size=None</em>, <em>sort_ascending=None</em>, <em>sort_by=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>List all public IPs obtained in the SDDC.</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>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)</li>
<li><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)</li>
<li><strong>page_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of results to return in this page (server may return
fewer) (optional, default to 1000)</li>
<li><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)</li>
<li><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted (optional)</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.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>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx_vmc_app.model.PublicIpsListResult</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Service Unavailable</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Bad Request, Precondition Failed</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Internal Server Error</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Forbidden</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Not Found</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="method">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.infra_client.PublicIps.update">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="descname">update</code><span class="sig-paren">(</span><em>public_ip_id</em>, <em>public_ip</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<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>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>public_ip_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
<li><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)</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.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>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx_vmc_app.model.PublicIp</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Service Unavailable</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Bad Request, Precondition Failed</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Internal Server Error</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Forbidden</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Not Found</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
<dt id="com.vmware.nsx_vmc_app.infra_client.SddcNetworkConfig">
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.infra_client.</code><code class="descname">SddcNetworkConfig</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.infra_client.SddcNetworkConfig" title="Permalink to this definition"></a></dt>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="com.vmware.nsx_vmc_app.infra_client.SddcNetworkConfig.CREATE_ACTION_UPGRADE">
<code class="descname">CREATE_ACTION_UPGRADE</code><em class="property"> = 'UPGRADE'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.infra_client.SddcNetworkConfig.CREATE_ACTION_UPGRADE" 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.SddcNetworkConfig.create" title="com.vmware.nsx_vmc_app.infra_client.SddcNetworkConfig.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">SddcNetworkConfig.create()</span></code></a>.</p>
</dd></dl>
<dl class="method">
<dt id="com.vmware.nsx_vmc_app.infra_client.SddcNetworkConfig.create">
<code class="descname">create</code><span class="sig-paren">(</span><em>upgrade_version_info</em>, <em>action</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.infra_client.SddcNetworkConfig.create" title="Permalink to this definition"></a></dt>
<dd><p>This API is used to update the Vmc app data during upgrade.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>upgrade_version_info</strong> (<a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.UpgradeVersionInfo" title="com.vmware.nsx_vmc_app.model_client.UpgradeVersionInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_vmc_app.model_client.UpgradeVersionInfo</span></code></a>) – (required)</li>
<li><strong>action</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Action performed on the Vmc app upgrade (required)</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Service Unavailable</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Bad Request, Precondition Failed</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Internal Server Error</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Forbidden</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Not Found</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
</dd></dl>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
<dt id="com.vmware.nsx_vmc_app.infra_client.SddcUserConfig">
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.infra_client.</code><code class="descname">SddcUserConfig</code><span class="sig-paren">(</span><em>config</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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="com.vmware.nsx_vmc_app.infra_client.SddcUserConfig.get">
<code class="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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><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></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">com.vmware.nsx_vmc_app.model.SddcUserConfiguration</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</dd></dl>
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.infra_client.StubFactory">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.infra_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.infra_client.StubFactory" title="Permalink to this definition"></a></dt>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.infra_client.TrafficGroups">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.infra_client.</code><code class="descname">TrafficGroups</code><span class="sig-paren">(</span><em>config</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
</tr>
</tbody>
</table>
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.infra_client.TrafficGroups.CREATE_ACTION_END_RESTORE">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<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>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.infra_client.TrafficGroups.CREATE_ACTION_SET_RESOURCE_STATUS_FAILURE">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<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>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.infra_client.TrafficGroups.CREATE_ACTION_SET_RESOURCE_STATUS_SUCCESS">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<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>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.infra_client.TrafficGroups.CREATE_ACTION_START_RESTORE">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<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>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="method">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.infra_client.TrafficGroups.create">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="descname">create</code><span class="sig-paren">(</span><em>traffic_group_id</em>, <em>action_message</em>, <em>action</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Perform an action on a Traffic Group</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>traffic_group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
<li><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)</li>
<li><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)</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Service Unavailable</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Bad Request, Precondition Failed</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Internal Server Error</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Forbidden</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Not Found</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="method">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.infra_client.TrafficGroups.delete">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="descname">delete</code><span class="sig-paren">(</span><em>traffic_group_id</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Delete the Traffic Group, disassociate the prefix list with the traffic
group.</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>traffic_group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="method">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.infra_client.TrafficGroups.get">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="descname">get</code><span class="sig-paren">(</span><em>traffic_group_id</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Get the traffic group information by traffic group ID.</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>traffic_group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.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></td>
</tr>
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">com.vmware.nsx_vmc_app.model.TrafficGroup</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="method">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.infra_client.TrafficGroups.list">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="descname">list</code><span class="sig-paren">(</span><em>verbose=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>A list of all traffic groups, which are associated with prefix lists.</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>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)</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.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></td>
</tr>
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">com.vmware.nsx_vmc_app.model.TrafficGroupsListResult</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="method">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.infra_client.TrafficGroups.update">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="descname">update</code><span class="sig-paren">(</span><em>traffic_group_id</em>, <em>traffic_group</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>This API is used to create or update a traffic group, a Prefix List is
associated to the traffic group.</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>traffic_group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – traffic group id (required)</li>
<li><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)</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.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>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx_vmc_app.model.TrafficGroup</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Service Unavailable</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Bad Request, Precondition Failed</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Internal Server Error</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Forbidden</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Not Found</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</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>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.ActionMessage">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">ActionMessage</code><span class="sig-paren">(</span><em>message=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>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</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.AdvertisedRoute">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">AdvertisedRoute</code><span class="sig-paren">(</span><em>advertisement_state=None</em>, <em>ipv4_cidr=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Advertised BGP route</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<li><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></li>
<li><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></li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
<blockquote>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<div>State of advertisement</div></blockquote>
</li>
<li><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</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.AdvertisedRoute.ADVERTISEMENT_STATE_FAILED">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.AdvertisedRoute.ADVERTISEMENT_STATE_SUCCESS">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.ApiError">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">ApiError</code><span class="sig-paren">(</span><em>details=None</em>, <em>error_code=None</em>, <em>error_data=None</em>, <em>error_message=None</em>, <em>module_name=None</em>, <em>related_errors=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Detailed information about an API Error</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>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</li>
<li><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</li>
<li><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</li>
<li><strong>error_message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – A description of the error</li>
<li><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</li>
<li><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</li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.AssociatedBaseGroupConnectionInfo">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">AssociatedBaseGroupConnectionInfo</code><span class="sig-paren">(</span><em>links=None</em>, <em>schema=None</em>, <em>self_=None</em>, <em>revision=None</em>, <em>create_time=None</em>, <em>create_user=None</em>, <em>last_modified_time=None</em>, <em>last_modified_user=None</em>, <em>protection=None</em>, <em>system_owned=None</em>, <em>description=None</em>, <em>display_name=None</em>, <em>id=None</em>, <em>resource_type='AssociatedBaseGroupConnectionInfo'</em>, <em>tags=None</em>, <em>marked_for_delete=None</em>, <em>parent_path=None</em>, <em>path=None</em>, <em>relative_path=None</em>, <em>name=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Base abstract associated Group connection infomation for the local SDDC.</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>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.
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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</li>
<li><strong>revision</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The _revision property describes the current revision of the
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
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
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
operation will be rejected. format: int32</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
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
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – SDDC Group description</li>
<li><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Defaults to ID if not set</li>
<li><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – SDDC Group ID</li>
<li><strong>resource_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>Possible values are:</p>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<li><blockquote class="first">
<div><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></div></blockquote>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<p>Group connection type</p>
</li>
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</li>
<li><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</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Absolute path of this object
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – SDDC Group name</li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.AssociatedBaseGroupConnectionInfo.RESOURCE_TYPE_ASSOCIATEDTGWGROUPCONNECTIONINFO">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.AssociatedBaseGroupConnectionInfo.resource_type">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Return the discriminator value</p>
</dd></dl>
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.AssociatedGroupConnectionInfosListResult">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">AssociatedGroupConnectionInfosListResult</code><span class="sig-paren">(</span><em>links=None</em>, <em>schema=None</em>, <em>self_=None</em>, <em>cursor=None</em>, <em>result_count=None</em>, <em>sort_ascending=None</em>, <em>sort_by=None</em>, <em>results=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Associated Group connection list result</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>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.
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
by current result page)
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
format: int64
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
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
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<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>.</li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.AssociatedTgwGroupConnectionInfo">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">AssociatedTgwGroupConnectionInfo</code><span class="sig-paren">(</span><em>external_route_table_id=None</em>, <em>sddcs_route_table_id=None</em>, <em>state=None</em>, <em>tgw_attachment_id=None</em>, <em>tgw_id=None</em>, <em>links=None</em>, <em>schema=None</em>, <em>self_=None</em>, <em>revision=None</em>, <em>create_time=None</em>, <em>create_user=None</em>, <em>last_modified_time=None</em>, <em>last_modified_user=None</em>, <em>protection=None</em>, <em>system_owned=None</em>, <em>description=None</em>, <em>display_name=None</em>, <em>id=None</em>, <em>resource_type='AssociatedTgwGroupConnectionInfo'</em>, <em>tags=None</em>, <em>marked_for_delete=None</em>, <em>parent_path=None</em>, <em>path=None</em>, <em>relative_path=None</em>, <em>name=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Associated Group connection infomation for the local SDDC by using AWS TGW
as a connector.</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>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</li>
<li><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</li>
<li><strong>state</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Possible values are:</p>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<li><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></li>
<li><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></li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
<blockquote>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<div>The TGW attachment state of the SDDC in the Group</div></blockquote>
</li>
<li><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</li>
<li><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</li>
<li><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.
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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</li>
<li><strong>revision</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The _revision property describes the current revision of the
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
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
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
operation will be rejected. format: int32</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
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
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – SDDC Group description</li>
<li><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Defaults to ID if not set</li>
<li><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – SDDC Group ID</li>
<li><strong>resource_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>Possible values are:</p>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<li><blockquote class="first">
<div><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></div></blockquote>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<p>Group connection type</p>
</li>
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</li>
<li><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</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Absolute path of this object
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – SDDC Group name</li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.AssociatedTgwGroupConnectionInfo.STATE_CONNECTED">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.AssociatedTgwGroupConnectionInfo.STATE_DISCONNECTED">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.AssociatedTgwGroupConnectionInfo.resource_type">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Return the discriminator value</p>
</dd></dl>
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.BGPAdvertisedRoutes">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">BGPAdvertisedRoutes</code><span class="sig-paren">(</span><em>advertised_routes=None</em>, <em>failed_advertised_routes=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Advertised bgp routes</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>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</li>
<li><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</li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.BGPLearnedRoutes">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">BGPLearnedRoutes</code><span class="sig-paren">(</span><em>ipv4_cidr=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Learned bgp routes</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>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</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.ConnectedServiceListResult">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">ConnectedServiceListResult</code><span class="sig-paren">(</span><em>links=None</em>, <em>schema=None</em>, <em>self_=None</em>, <em>cursor=None</em>, <em>result_count=None</em>, <em>sort_ascending=None</em>, <em>sort_by=None</em>, <em>results=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>A list of status of ‘Enabled/Disabled’ for a service connected to a linked
vpc</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>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.
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
by current result page)
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
format: int64
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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</li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.ConnectedServiceStatus">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">ConnectedServiceStatus</code><span class="sig-paren">(</span><em>links=None</em>, <em>schema=None</em>, <em>self_=None</em>, <em>revision=None</em>, <em>create_time=None</em>, <em>create_user=None</em>, <em>last_modified_time=None</em>, <em>last_modified_user=None</em>, <em>protection=None</em>, <em>system_owned=None</em>, <em>description=None</em>, <em>display_name=None</em>, <em>id=None</em>, <em>resource_type=None</em>, <em>tags=None</em>, <em>marked_for_delete=None</em>, <em>parent_path=None</em>, <em>path=None</em>, <em>relative_path=None</em>, <em>enabled=None</em>, <em>name=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Status of ‘Enabled/Disabled’ for a service connected to a linked vpc</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>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.
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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</li>
<li><strong>revision</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The _revision property describes the current revision of the
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
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
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
operation will be rejected. format: int32</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
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
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Description of this resource</li>
<li><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Defaults to ID if not set</li>
<li><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Unique identifier of this resource</li>
<li><strong>resource_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The type of this resource.</li>
<li><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</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Absolute path of this object
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – status of service
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – service name
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.CsvListResult">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">CsvListResult</code><span class="sig-paren">(</span><em>file_name=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Base type for CSV result.</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>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.</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.CsvRecord">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">CsvRecord</code><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.CsvRecord" title="Permalink to this definition"></a></dt>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Base type for CSV records.</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.DirectConnectBgpInfo">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">DirectConnectBgpInfo</code><span class="sig-paren">(</span><em>links=None</em>, <em>schema=None</em>, <em>self_=None</em>, <em>revision=None</em>, <em>create_time=None</em>, <em>create_user=None</em>, <em>last_modified_time=None</em>, <em>last_modified_user=None</em>, <em>protection=None</em>, <em>system_owned=None</em>, <em>description=None</em>, <em>display_name=None</em>, <em>id=None</em>, <em>resource_type=None</em>, <em>tags=None</em>, <em>marked_for_delete=None</em>, <em>parent_path=None</em>, <em>path=None</em>, <em>relative_path=None</em>, <em>local_as_num=None</em>, <em>mtu=None</em>, <em>route_preference=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Direct Connect BGP related information</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>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.
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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</li>
<li><strong>revision</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The _revision property describes the current revision of the
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
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
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
operation will be rejected. format: int32</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
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
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Description of this resource</li>
<li><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Defaults to ID if not set</li>
<li><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Unique identifier of this resource</li>
<li><strong>resource_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The type of this resource.</li>
<li><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</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Absolute path of this object
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
private BGP ASN range - [64512, 65534] and [4200000000,
4294967294]. If omitted in the payload, BGP ASN will not be
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
modified.</li>
<li><strong>mtu</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum transmission unit allowed by the VIF format: int32
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<li><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></li>
<li><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></li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
<p>Direct connect route preference over VPN routes. If omitted in the
payload, route preference will not be modified.</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.DirectConnectBgpInfo.ROUTE_PREFERENCE_DIRECT_CONNECT_PREFERRED_OVER_VPN">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.DirectConnectBgpInfo.ROUTE_PREFERENCE_VPN_PREFERRED_OVER_DIRECT_CONNECT">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.ExternalConnectivityConfig">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">ExternalConnectivityConfig</code><span class="sig-paren">(</span><em>links=None</em>, <em>schema=None</em>, <em>self_=None</em>, <em>revision=None</em>, <em>create_time=None</em>, <em>create_user=None</em>, <em>last_modified_time=None</em>, <em>last_modified_user=None</em>, <em>protection=None</em>, <em>system_owned=None</em>, <em>description=None</em>, <em>display_name=None</em>, <em>id=None</em>, <em>resource_type=None</em>, <em>tags=None</em>, <em>marked_for_delete=None</em>, <em>parent_path=None</em>, <em>path=None</em>, <em>relative_path=None</em>, <em>internet_mtu=None</em>, <em>intranet_mtu=None</em>, <em>services_mtu=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>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">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>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.
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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</li>
<li><strong>revision</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The _revision property describes the current revision of the
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
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
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
operation will be rejected. format: int32</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
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
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Description of this resource</li>
<li><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Defaults to ID if not set</li>
<li><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Unique identifier of this resource</li>
<li><strong>resource_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The type of this resource.</li>
<li><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</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Absolute path of this object
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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:
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
int32
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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</li>
<li><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.
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
format: int32
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.ExternalSddcConnectivity">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">ExternalSddcConnectivity</code><span class="sig-paren">(</span><em>connectivity_type=None</em>, <em>route_type=None</em>, <em>source=None</em>, <em>status=None</em>, <em>status_message=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>External SDDC connectivity</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<li><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></li>
<li><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></li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</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>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</li>
<li><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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<li><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></li>
<li><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></li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
<blockquote>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<div>The type of the route for the connectivity</div></blockquote>
</li>
<li><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The source of the route for the connectivity</li>
<li><strong>status</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Possible values are:</p>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<li><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></li>
<li><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></li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
<blockquote>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<div>The status of the route for the connectivity</div></blockquote>
</li>
<li><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.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.ExternalSddcConnectivity.CONNECTIVITY_TYPE_DEPLOYMENT_CONNECTIVITY_GROUP">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.ExternalSddcConnectivity.CONNECTIVITY_TYPE_DIRECT_CONNECT">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.ExternalSddcConnectivity.ROUTE_TYPE_PROPAGATED">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.ExternalSddcConnectivity.ROUTE_TYPE_STATIC">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.ExternalSddcConnectivity.STATUS_FAILED">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.ExternalSddcConnectivity.STATUS_SUCCEEDED">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.ExternalSddcRoute">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">ExternalSddcRoute</code><span class="sig-paren">(</span><em>links=None</em>, <em>schema=None</em>, <em>self_=None</em>, <em>revision=None</em>, <em>create_time=None</em>, <em>create_user=None</em>, <em>last_modified_time=None</em>, <em>last_modified_user=None</em>, <em>protection=None</em>, <em>system_owned=None</em>, <em>description=None</em>, <em>display_name=None</em>, <em>id=None</em>, <em>resource_type=None</em>, <em>tags=None</em>, <em>marked_for_delete=None</em>, <em>parent_path=None</em>, <em>path=None</em>, <em>relative_path=None</em>, <em>connectivities=None</em>, <em>destination=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>External SDDC route</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>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.
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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</li>
<li><strong>revision</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The _revision property describes the current revision of the
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
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
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
operation will be rejected. format: int32</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
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
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Description of this resource</li>
<li><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Defaults to ID if not set</li>
<li><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Unique identifier of this resource</li>
<li><strong>resource_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The type of this resource.</li>
<li><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</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Absolute path of this object
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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</li>
<li><strong>destination</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Destination IP CIDR Block format: ipv4-cidr-block</li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.ExternalSddcRouteCsvRecord">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">ExternalSddcRouteCsvRecord</code><span class="sig-paren">(</span><em>connectivity_details=None</em>, <em>destination=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>CSV record for External SDDC route</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>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</li>
<li><strong>destination</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Destination IP CIDR Block format: ipv4-cidr-block</li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.ExternalSddcRoutesListResult">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">ExternalSddcRoutesListResult</code><span class="sig-paren">(</span><em>links=None</em>, <em>schema=None</em>, <em>self_=None</em>, <em>cursor=None</em>, <em>result_count=None</em>, <em>sort_ascending=None</em>, <em>sort_by=None</em>, <em>routes=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>External SDDC routes list result</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>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.
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
by current result page)
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
format: int64
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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>) – </li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.ExternalSddcRoutesListResultInCsvFormat">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">ExternalSddcRoutesListResultInCsvFormat</code><span class="sig-paren">(</span><em>file_name=None</em>, <em>results=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>External SDDC routes list result in CSV format</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>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.</li>
<li><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>) – </li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.IncludedFieldsParameters">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">IncludedFieldsParameters</code><span class="sig-paren">(</span><em>included_fields=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>A list of fields to include in query results</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>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</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.IpAttachmentPair">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">IpAttachmentPair</code><span class="sig-paren">(</span><em>attachment_id=None</em>, <em>ip=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>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</li>
<li><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</li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.LinkedSubnetInfo">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">LinkedSubnetInfo</code><span class="sig-paren">(</span><em>availability_zone=None</em>, <em>cidr=None</em>, <em>id=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Infromation related to a subnet where linked ENIs were created.</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>availability_zone</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Linked subnet availability zone</li>
<li><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</li>
<li><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Linked subnet identifier</li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.LinkedVpcInfo">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">LinkedVpcInfo</code><span class="sig-paren">(</span><em>links=None</em>, <em>schema=None</em>, <em>self_=None</em>, <em>revision=None</em>, <em>create_time=None</em>, <em>create_user=None</em>, <em>last_modified_time=None</em>, <em>last_modified_user=None</em>, <em>protection=None</em>, <em>system_owned=None</em>, <em>description=None</em>, <em>display_name=None</em>, <em>id=None</em>, <em>resource_type=None</em>, <em>tags=None</em>, <em>marked_for_delete=None</em>, <em>parent_path=None</em>, <em>path=None</em>, <em>relative_path=None</em>, <em>active_eni=None</em>, <em>arn_role=None</em>, <em>external_id=None</em>, <em>linked_account=None</em>, <em>linked_vpc_addresses=None</em>, <em>linked_vpc_id=None</em>, <em>linked_vpc_nat_ips=None</em>, <em>linked_vpc_subnets=None</em>, <em>route_table_ids=None</em>, <em>service_arn_role=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Linked VPC info</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>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.
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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</li>
<li><strong>revision</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The _revision property describes the current revision of the
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
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
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
operation will be rejected. format: int32</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
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
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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.</li>
<li><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Description of this resource</li>
<li><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Defaults to ID if not set</li>
<li><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Unique identifier of this resource</li>
<li><strong>resource_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The type of this resource.</li>
<li><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</li>
<li><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.</li>
<li><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.</li>
<li><strong>path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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.</li>
<li><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.</li>
<li><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</li>
<li><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</li>
<li><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</li>
<li><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</li>
<li><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</li>
<li><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</li>
<li><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</li>
<li><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.</li>
<li><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</li>
<li><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</li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.LinkedVpcsListResult">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">LinkedVpcsListResult</code><span class="sig-paren">(</span><em>links=None</em>, <em>schema=None</em>, <em>self_=None</em>, <em>cursor=None</em>, <em>result_count=None</em>, <em>sort_ascending=None</em>, <em>sort_by=None</em>, <em>results=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Linked VPC list query result</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>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.
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
by current result page)
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
format: int64
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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</li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.ListResult">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">ListResult</code><span class="sig-paren">(</span><em>links=None</em>, <em>schema=None</em>, <em>self_=None</em>, <em>cursor=None</em>, <em>result_count=None</em>, <em>sort_ascending=None</em>, <em>sort_by=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Base class for list results from collections</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>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.
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
by current result page)
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
format: int64
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.ManagedResource">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">ManagedResource</code><span class="sig-paren">(</span><em>links=None</em>, <em>schema=None</em>, <em>self_=None</em>, <em>revision=None</em>, <em>create_time=None</em>, <em>create_user=None</em>, <em>last_modified_time=None</em>, <em>last_modified_user=None</em>, <em>protection=None</em>, <em>system_owned=None</em>, <em>description=None</em>, <em>display_name=None</em>, <em>id=None</em>, <em>resource_type=None</em>, <em>tags=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Base type for resources that are managed by API clients</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>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.
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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</li>
<li><strong>revision</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The _revision property describes the current revision of the
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
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
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
operation will be rejected. format: int32</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
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
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Description of this resource</li>
<li><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Defaults to ID if not set</li>
<li><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Unique identifier of this resource</li>
<li><strong>resource_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The type of this resource.</li>
<li><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</li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.MgmtServiceEntry">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">MgmtServiceEntry</code><span class="sig-paren">(</span><em>display_name=None</em>, <em>path=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>A service entry describes the detail of a network service.</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>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</li>
<li><strong>path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Service path should refer to a valid service in the system. Service
can be system defined or user defined.</li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.MgmtVmInfo">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">MgmtVmInfo</code><span class="sig-paren">(</span><em>links=None</em>, <em>schema=None</em>, <em>self_=None</em>, <em>revision=None</em>, <em>create_time=None</em>, <em>create_user=None</em>, <em>last_modified_time=None</em>, <em>last_modified_user=None</em>, <em>protection=None</em>, <em>system_owned=None</em>, <em>description=None</em>, <em>display_name=None</em>, <em>id=None</em>, <em>resource_type=None</em>, <em>tags=None</em>, <em>marked_for_delete=None</em>, <em>parent_path=None</em>, <em>path=None</em>, <em>relative_path=None</em>, <em>group_path=None</em>, <em>ip_attachment_pairs=None</em>, <em>ips=None</em>, <em>services=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Management VM access information</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>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.
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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</li>
<li><strong>revision</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The _revision property describes the current revision of the
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
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
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
operation will be rejected. format: int32</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
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
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Description of this resource</li>
<li><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Management VM name</li>
<li><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Management VM identifier
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>resource_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The type of this resource.</li>
<li><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</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Absolute path of this object
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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.
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This property will reflect its group path.
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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</li>
<li><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</li>
<li><strong>services</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.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.</li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.MgmtVmsListResult">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">MgmtVmsListResult</code><span class="sig-paren">(</span><em>links=None</em>, <em>schema=None</em>, <em>self_=None</em>, <em>cursor=None</em>, <em>result_count=None</em>, <em>sort_ascending=None</em>, <em>sort_by=None</em>, <em>results=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Management VM list query result</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>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.
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
by current result page)
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
format: int64
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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</li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.ModelInterface">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">ModelInterface</code><span class="sig-paren">(</span><em>id=None</em>, <em>name=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Interface information (Label)</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifier of the Interface label</li>
<li><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Name of the Interface label</li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.PrefixListInfo">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">PrefixListInfo</code><span class="sig-paren">(</span><em>name=None</em>, <em>path=None</em>, <em>url=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Prefix lists used by certain features, like Intranet NAT.</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Prefix List name</li>
<li><strong>path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Relative Prefix List path</li>
<li><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</li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.ProviderGatewayKeyValuePairs">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">ProviderGatewayKeyValuePairs</code><span class="sig-paren">(</span><em>key=None</em>, <em>value=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>A list for provider gateways</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>key</strong> (<code class="xref 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</li>
<li><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</li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.ProviderObject">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">ProviderObject</code><span class="sig-paren">(</span><em>display_name=None</em>, <em>id=None</em>, <em>path=None</em>, <em>type=None</em>, <em>url=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Basic properties of SDDC User Config.</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – ID
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Path
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Optional field, used to identify the object.
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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/”.
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.PublicIp">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">PublicIp</code><span class="sig-paren">(</span><em>links=None</em>, <em>schema=None</em>, <em>self_=None</em>, <em>revision=None</em>, <em>create_time=None</em>, <em>create_user=None</em>, <em>last_modified_time=None</em>, <em>last_modified_user=None</em>, <em>protection=None</em>, <em>system_owned=None</em>, <em>description=None</em>, <em>display_name=None</em>, <em>id=None</em>, <em>resource_type=None</em>, <em>tags=None</em>, <em>marked_for_delete=None</em>, <em>parent_path=None</em>, <em>path=None</em>, <em>relative_path=None</em>, <em>ip=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>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.
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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</li>
<li><strong>revision</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The _revision property describes the current revision of the
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
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
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
operation will be rejected. format: int32</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
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
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Description of this resource</li>
<li><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
<li><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Public IP identifier
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>resource_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The type of this resource.</li>
<li><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</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Absolute path of this object
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.PublicIpsListResult">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">PublicIpsListResult</code><span class="sig-paren">(</span><em>links=None</em>, <em>schema=None</em>, <em>self_=None</em>, <em>cursor=None</em>, <em>result_count=None</em>, <em>sort_ascending=None</em>, <em>sort_by=None</em>, <em>results=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Public IP list</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>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.
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
by current result page)
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
format: int64
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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</li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.RelatedApiError">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">RelatedApiError</code><span class="sig-paren">(</span><em>details=None</em>, <em>error_code=None</em>, <em>error_data=None</em>, <em>error_message=None</em>, <em>module_name=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Detailed information about a related API error</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>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</li>
<li><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</li>
<li><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</li>
<li><strong>error_message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – A description of the error</li>
<li><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</li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.Resource">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">Resource</code><span class="sig-paren">(</span><em>links=None</em>, <em>schema=None</em>, <em>self_=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Base class for resources</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>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.
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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</li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.ResourceLink">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">ResourceLink</code><span class="sig-paren">(</span><em>action=None</em>, <em>href=None</em>, <em>rel=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>A link to a related resource</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>action</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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.</li>
<li><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.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
definitions exist)
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.RevisionedResource">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">RevisionedResource</code><span class="sig-paren">(</span><em>links=None</em>, <em>schema=None</em>, <em>self_=None</em>, <em>revision=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>A base class for types that track revisions</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>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.
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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</li>
<li><strong>revision</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The _revision property describes the current revision of the
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
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
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
operation will be rejected. format: int32</li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.SddcUserConfiguration">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">SddcUserConfiguration</code><span class="sig-paren">(</span><em>all_uplink_interface_label=None</em>, <em>all_vpn_interface_label=None</em>, <em>cgw_snat_ip=None</em>, <em>compute_domain=None</em>, <em>compute_gateway=None</em>, <em>domains=None</em>, <em>dx_interface_label=None</em>, <em>enforcement_points=None</em>, <em>gateways=None</em>, <em>infra_subnets=None</em>, <em>interfaces=None</em>, <em>labels=None</em>, <em>linked_vpc_interface_label=None</em>, <em>management_domain=None</em>, <em>management_gateway=None</em>, <em>management_gateway_default_dns_zone=None</em>, <em>management_gateway_label=None</em>, <em>mgmt_subnet=None</em>, <em>mgmt_subnets=None</em>, <em>mgw_snat_ip=None</em>, <em>provider_gateways=None</em>, <em>provider_name=None</em>, <em>provider_prefix_lists=None</em>, <em>public_interface_label=None</em>, <em>sddc_infra_subnet=None</em>, <em>vpn_dx_ips=None</em>, <em>vpn_endpoints=None</em>, <em>vpn_internet_ips=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>SDDC configuration parameters for users. User-level addresses/CIDRs are
provided.</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>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.</li>
<li><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.</li>
<li><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</li>
<li><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.</li>
<li><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.</li>
<li><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.</li>
<li><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.</li>
<li><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.</li>
<li><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.</li>
<li><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</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
interface, linked vpc interface, etc. Deprecated, please use
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
labels.</li>
<li><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.</li>
<li><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.</li>
<li><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.</li>
<li><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.</li>
<li><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</li>
<li><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.</li>
<li><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</li>
<li><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</li>
<li><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</li>
<li><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.</li>
<li><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.</li>
<li><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.</li>
<li><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.</li>
<li><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</li>
<li><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</li>
<li><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.</li>
<li><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</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.SelfResourceLink">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">SelfResourceLink</code><span class="sig-paren">(</span><em>action=None</em>, <em>href=None</em>, <em>rel=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The server will populate this field when returing the resource. Ignored on
PUT and POST.</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>action</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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.</li>
<li><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.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
definitions exist)
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.StubFactory">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.StubFactory" title="Permalink to this definition"></a></dt>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.Tag">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">Tag</code><span class="sig-paren">(</span><em>scope=None</em>, <em>tag=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Arbitrary key-value pairs that may be attached to an entity</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>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</li>
<li><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</li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.TrafficGroup">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">TrafficGroup</code><span class="sig-paren">(</span><em>links=None</em>, <em>schema=None</em>, <em>self_=None</em>, <em>revision=None</em>, <em>create_time=None</em>, <em>create_user=None</em>, <em>last_modified_time=None</em>, <em>last_modified_user=None</em>, <em>protection=None</em>, <em>system_owned=None</em>, <em>description=None</em>, <em>display_name=None</em>, <em>id=None</em>, <em>resource_type=None</em>, <em>tags=None</em>, <em>marked_for_delete=None</em>, <em>parent_path=None</em>, <em>path=None</em>, <em>relative_path=None</em>, <em>association_maps=None</em>, <em>resource_id=None</em>, <em>state=None</em>, <em>state_message=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>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">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>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.
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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</li>
<li><strong>revision</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The _revision property describes the current revision of the
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
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
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
operation will be rejected. format: int32</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
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
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Description of this resource</li>
<li><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – A description field for the traffic group.</li>
<li><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Unique identifier for a traffic group.</li>
<li><strong>resource_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The type of this resource.</li>
<li><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</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Absolute path of this object
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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.
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
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
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>state</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Possible values are:</p>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<li><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></li>
<li><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></li>
<li><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></li>
<li><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></li>
<li><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></li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</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>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
states.
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.TrafficGroup.STATE_FAILURE">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.TrafficGroup.STATE_IN_PROGRESS">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.TrafficGroup.STATE_PENDING">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.TrafficGroup.STATE_SUCCESS">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.TrafficGroup.STATE_UNAVAILABLE">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.TrafficGroupAssociationMap">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">TrafficGroupAssociationMap</code><span class="sig-paren">(</span><em>links=None</em>, <em>schema=None</em>, <em>self_=None</em>, <em>revision=None</em>, <em>create_time=None</em>, <em>create_user=None</em>, <em>last_modified_time=None</em>, <em>last_modified_user=None</em>, <em>protection=None</em>, <em>system_owned=None</em>, <em>description=None</em>, <em>display_name=None</em>, <em>id=None</em>, <em>resource_type=None</em>, <em>tags=None</em>, <em>marked_for_delete=None</em>, <em>parent_path=None</em>, <em>path=None</em>, <em>relative_path=None</em>, <em>prefix_lists=None</em>, <em>scope=None</em>, <em>state=None</em>, <em>state_message=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>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">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>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.
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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</li>
<li><strong>revision</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The _revision property describes the current revision of the
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
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
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
operation will be rejected. format: int32</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
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
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Description of this resource</li>
<li><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – A description field for Traffic group association map。</li>
<li><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The association map id.</li>
<li><strong>resource_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The type of this resource.</li>
<li><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</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Absolute path of this object
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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.</li>
<li><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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<li><code class="xref py py-attr docutils literal notranslate"><span class="pre">TrafficGroupAssociationMap.SCOPE__1S_CGW</span></code></li>
<li><code class="xref py py-attr docutils literal notranslate"><span class="pre">TrafficGroupAssociationMap.SCOPE__0S_VMC</span></code></li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</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>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</li>
<li><strong>state</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Possible values are:</p>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<li><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></li>
<li><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></li>
<li><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></li>
<li><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></li>
<li><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></li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</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>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
states.
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.TrafficGroupAssociationMap.SCOPE_0S_VMC">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.TrafficGroupAssociationMap.SCOPE_1S_CGW">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.TrafficGroupAssociationMap.STATE_FAILURE">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.TrafficGroupAssociationMap.STATE_IN_PROGRESS">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.TrafficGroupAssociationMap.STATE_PENDING">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.TrafficGroupAssociationMap.STATE_SUCCESS">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.TrafficGroupAssociationMap.STATE_UNAVAILABLE">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.TrafficGroupAssociationMapsListResult">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">TrafficGroupAssociationMapsListResult</code><span class="sig-paren">(</span><em>links=None</em>, <em>schema=None</em>, <em>self_=None</em>, <em>cursor=None</em>, <em>result_count=None</em>, <em>sort_ascending=None</em>, <em>sort_by=None</em>, <em>results=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>List result for traffic group association maps.</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>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.
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
by current result page)
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
format: int64
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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</li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.TrafficGroupsListResult">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">TrafficGroupsListResult</code><span class="sig-paren">(</span><em>links=None</em>, <em>schema=None</em>, <em>self_=None</em>, <em>cursor=None</em>, <em>result_count=None</em>, <em>sort_ascending=None</em>, <em>sort_by=None</em>, <em>results=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>List result for traffic groups.</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>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.
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
by current result page)
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
format: int64
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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.</li>
<li><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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.</li>
<li><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</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.nsx_vmc_app.model_client.UpgradeVersionInfo">
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">UpgradeVersionInfo</code><span class="sig-paren">(</span><em>from_sddc_version=None</em>, <em>to_sddc_version=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.UpgradeVersionInfo" title="Permalink to this definition"></a></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>Upgrade versions information</p>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>from_sddc_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The version of SDDC on which the upgrade is started.
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>to_sddc_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The version to which the SDDC is upgraded. port.
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.VMCAccounts">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">VMCAccounts</code><span class="sig-paren">(</span><em>linked_vpc_account=None</em>, <em>shadow_account=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Shadow account and linked VPC account</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>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</li>
<li><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</li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.VifsListResult">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">VifsListResult</code><span class="sig-paren">(</span><em>links=None</em>, <em>schema=None</em>, <em>self_=None</em>, <em>cursor=None</em>, <em>result_count=None</em>, <em>sort_ascending=None</em>, <em>sort_by=None</em>, <em>results=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Direct Connect VIFs (Virtual Interface) list query result</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>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.
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
by current result page)
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
format: int64
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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</li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.VirtualInterface">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">VirtualInterface</code><span class="sig-paren">(</span><em>bgp_status=None</em>, <em>direct_connect_id=None</em>, <em>id=None</em>, <em>local_ip=None</em>, <em>mtu=None</em>, <em>name=None</em>, <em>remote_asn=None</em>, <em>remote_ip=None</em>, <em>state=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<li><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></li>
<li><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></li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
<blockquote>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<div>BGP status</div></blockquote>
</li>
<li><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</li>
<li><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifier for the virtual interface</li>
<li><strong>local_ip</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – amazon side address format: ipv4
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>mtu</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum transmission unit allowed by the VIF format: int32
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – VIF name</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>state</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Possible values are:</p>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<li><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></li>
<li><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></li>
<li><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></li>
<li><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></li>
<li><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></li>
<li><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></li>
<li><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></li>
<li><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></li>
<li><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></li>
<li><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></li>
<li><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></li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
<blockquote>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<div>VIF State</div></blockquote>
</li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.VirtualInterface.BGP_STATUS_DOWN">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.VirtualInterface.BGP_STATUS_UP">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_ATTACHED">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_ATTACHING">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_AVAILABLE">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_CONFIRMING">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_DELETED">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_DELETING">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_DOWN">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_ERROR">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_PENDING">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_REJECTED">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_VERIFYING">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.VmcAppBaseInfo">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">VmcAppBaseInfo</code><span class="sig-paren">(</span><em>links=None</em>, <em>schema=None</em>, <em>self_=None</em>, <em>revision=None</em>, <em>create_time=None</em>, <em>create_user=None</em>, <em>last_modified_time=None</em>, <em>last_modified_user=None</em>, <em>protection=None</em>, <em>system_owned=None</em>, <em>description=None</em>, <em>display_name=None</em>, <em>id=None</em>, <em>resource_type=None</em>, <em>tags=None</em>, <em>marked_for_delete=None</em>, <em>parent_path=None</em>, <em>path=None</em>, <em>relative_path=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Abstract base class for all the VmcApp objects.</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>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.
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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</li>
<li><strong>revision</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The _revision property describes the current revision of the
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
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
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
operation will be rejected. format: int32</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
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
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Description of this resource</li>
<li><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Defaults to ID if not set</li>
<li><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Unique identifier of this resource</li>
<li><strong>resource_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The type of this resource.</li>
<li><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</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Absolute path of this object
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.VmcConsolidatedRealizedStatus">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">VmcConsolidatedRealizedStatus</code><span class="sig-paren">(</span><em>consolidated_status=None</em>, <em>consolidated_status_per_object=None</em>, <em>intent_path=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Represents aggregated realized status for intent entity across associated
realized entities.</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>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.</li>
<li><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.</li>
<li><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.</li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatus">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">VmcConsolidatedStatus</code><span class="sig-paren">(</span><em>consolidated_status=None</em>, <em>status_message=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Consolidated status of an object.</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<li><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></li>
<li><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></li>
<li><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></li>
<li><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></li>
<li><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></li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
<blockquote>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<div>Realized state of consolidation.</div></blockquote>
</li>
<li><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.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatus.CONSOLIDATED_STATUS_FAILURE">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatus.CONSOLIDATED_STATUS_IN_PROGRESS">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatus.CONSOLIDATED_STATUS_PENDING">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatus.CONSOLIDATED_STATUS_SUCCESS">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatus.CONSOLIDATED_STATUS_UNAVAILABLE">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatusPerObject">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">VmcConsolidatedStatusPerObject</code><span class="sig-paren">(</span><em>consolidated_status=None</em>, <em>object_id=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Realized status consolidated by individual objects.</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>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.</li>
<li><strong>object_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Object id used to consolidate state. This can be a particular
backend task/job, etc.</li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.VmcFeatureFlagInfo">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">VmcFeatureFlagInfo</code><span class="sig-paren">(</span><em>links=None</em>, <em>schema=None</em>, <em>self_=None</em>, <em>revision=None</em>, <em>create_time=None</em>, <em>create_user=None</em>, <em>last_modified_time=None</em>, <em>last_modified_user=None</em>, <em>protection=None</em>, <em>system_owned=None</em>, <em>description=None</em>, <em>display_name=None</em>, <em>id=None</em>, <em>resource_type=None</em>, <em>tags=None</em>, <em>marked_for_delete=None</em>, <em>parent_path=None</em>, <em>path=None</em>, <em>relative_path=None</em>, <em>internal_name=None</em>, <em>message=None</em>, <em>name=None</em>, <em>state=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>VMC Feature Flag</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>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.
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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</li>
<li><strong>revision</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The _revision property describes the current revision of the
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
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
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
operation will be rejected. format: int32</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
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
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Description of this resource</li>
<li><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Defaults to ID if not set</li>
<li><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Unique identifier of this resource</li>
<li><strong>resource_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The type of this resource.</li>
<li><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</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Absolute path of this object
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><strong>message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Message</li>
<li><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Feature Name</li>
<li><strong>state</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Possible values are:</p>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<li><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></li>
<li><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></li>
<li><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></li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
<blockquote>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<div>state</div></blockquote>
</li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.VmcFeatureFlagInfo.STATE_DISABLED">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.VmcFeatureFlagInfo.STATE_ENABLED">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.VmcFeatureFlagInfo.STATE_INACTIVE">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.VmcFeatureFlags">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">VmcFeatureFlags</code><span class="sig-paren">(</span><em>features=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>VMC Feature flags</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>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>) – </td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.VmcRealizedEntities">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">VmcRealizedEntities</code><span class="sig-paren">(</span><em>intent_path=None</em>, <em>realized_entities=None</em>, <em>realized_entities_id=None</em>, <em>realized_state=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>A 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">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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.
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<li><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></li>
<li><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></li>
<li><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></li>
<li><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></li>
<li><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></li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
<blockquote>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<div>Realized state</div></blockquote>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<p>This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.VmcRealizedEntities.REALIZED_STATE_FAILURE">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.VmcRealizedEntities.REALIZED_STATE_IN_PROGRESS">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.VmcRealizedEntities.REALIZED_STATE_PENDING">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.VmcRealizedEntities.REALIZED_STATE_SUCCESS">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.VmcRealizedEntities.REALIZED_STATE_UNAVAILABLE">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.VmcRealizedEntity">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">VmcRealizedEntity</code><span class="sig-paren">(</span><em>realization_api=None</em>, <em>realization_id=None</em>, <em>realization_path=None</em>, <em>realized_entity_id=None</em>, <em>realized_entity_type=None</em>, <em>realized_state=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Realized entity object. This accounts for an resource / entity which is
realized within cloud service.</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>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.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
this can be an external id.
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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.
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Some resources are identified by their paths.
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
This attribute may be present in responses from the server, but if
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
it is present in a request to server it will be ignored.</li>
<li><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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<li><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></li>
<li><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></li>
<li><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></li>
<li><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></li>
<li><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></li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
<blockquote>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<div>Realized state</div></blockquote>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<p>This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.VmcRealizedEntity.REALIZED_STATE_FAILURE">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.VmcRealizedEntity.REALIZED_STATE_IN_PROGRESS">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.VmcRealizedEntity.REALIZED_STATE_PENDING">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.VmcRealizedEntity.REALIZED_STATE_SUCCESS">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="attribute">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.VmcRealizedEntity.REALIZED_STATE_UNAVAILABLE">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<code class="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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd></dd></dl>
</dd></dl>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<dl class="class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_vmc_app.model_client.VpnEndpoint">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">VpnEndpoint</code><span class="sig-paren">(</span><em>interface_label=None</em>, <em>ip=None</em>, <em>name=None</em>, <em>type=None</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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>VPN endpoint information</p>
<div class="admonition tip">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
names.</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>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</li>
<li><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</li>
<li><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Name of the VPN endpoint</li>
<li><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Type of the VPN endpoint</li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</ul>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
</td>
</tr>
</tbody>
</table>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<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" aria-hidden="true"></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" aria-hidden="true"></span> Previous</a>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</div>
<hr/>
<div role="contentinfo">
<p>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
&#169; Copyright 2021, VMware, Inc..
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</p>
</div>
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Upgrade NSX docs to M14 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2021-03-31 18:40:01 -04:00
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
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>
Copy Permalink