Mirrors/vsphere-automation-sdk-python
1
0
Fork 0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-26 03:10:00 -05:00
Code
de63bf086e
vsphere-automation-sdk-python/nsx/vmc_app/com.vmware.nsx_vmc_app.html
Gordon Good ed37623c20 Fix incorrect name of vmc-app SDK 
Should be "NSX-T VMC Cloud Service SDK".

Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-02-19 17:47:40 -08:00

2082 lines
170 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

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

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com.vmware.nsx_vmc_app package &mdash; NSX-T VMC Cloud Service SDK 2.3.0.0.2 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="com.vmware.nsx_vmc_app.infra package" href="com.vmware.nsx_vmc_app.infra.html" />
<link rel="prev" title="com.vmware package" href="com.vmware.html" />
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="index.html" class="icon icon-home"> NSX-T VMC Cloud Service SDK
</a>
<div class="version">
2.3.0.0.2
</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#module-com.vmware.nsx_vmc_app_client_for_vmc">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-T VMC Cloud Service SDK</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> &raquo;</li>
<li><a href="com.html">com package</a> &raquo;</li>
<li><a href="com.vmware.html">com.vmware package</a> &raquo;</li>
<li>com.vmware.nsx_vmc_app package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/com.vmware.nsx_vmc_app.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="module-com.vmware.nsx_vmc_app">
<span id="com-vmware-nsx-vmc-app-package"></span><h1>com.vmware.nsx_vmc_app package<a class="headerlink" href="#module-com.vmware.nsx_vmc_app" title="Permalink to this headline"></a></h1>
<div class="section" id="subpackages">
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="com.vmware.nsx_vmc_app.infra.html">com.vmware.nsx_vmc_app.infra package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.nsx_vmc_app.infra.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.nsx_vmc_app.infra.direct_connect.html">com.vmware.nsx_vmc_app.infra.direct_connect package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.nsx_vmc_app.infra.direct_connect.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.nsx_vmc_app.infra.direct_connect.html#module-com.vmware.nsx_vmc_app.infra.direct_connect.routes_client">com.vmware.nsx_vmc_app.infra.direct_connect.routes_client module</a></li>
</ul>
</li>
</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.linked_vpcs_client">com.vmware.nsx_vmc_app.infra.linked_vpcs_client module</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="module-com.vmware.nsx_vmc_app.infra_client">
<span id="com-vmware-nsx-vmc-app-infra-client-module"></span><h2>com.vmware.nsx_vmc_app.infra_client module<a class="headerlink" href="#module-com.vmware.nsx_vmc_app.infra_client" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="com.vmware.nsx_vmc_app.infra_client.Accounts">
<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>
<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.Accounts.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.Accounts.get" title="Permalink to this definition"></a></dt>
<dd><p>Retrieve the shadow account and linked VPC account information from VMC
provider. This API is a live query to VMC provider.</p>
<table class="docutils field-list" 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>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.nsx_vmc_app.infra_client.LinkedVpcs">
<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>
<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.LinkedVpcs.get">
<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>
<dd><p>Get linked VPC information.</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>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>
</dd></dl>
<dl class="method">
<dt id="com.vmware.nsx_vmc_app.infra_client.LinkedVpcs.list">
<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>
<dd><p>List linked VPC information.</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.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>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.nsx_vmc_app.infra_client.MgmtVms">
<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>
<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.MgmtVms.get">
<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>
<dd><p>Get management VM access information.</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>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>
</dd></dl>
<dl class="method">
<dt id="com.vmware.nsx_vmc_app.infra_client.MgmtVms.list">
<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>
<dd><p>List Management VM information.</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.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>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.nsx_vmc_app.infra_client.PublicIps">
<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>
<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.PublicIps.delete">
<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>
<dd><p>Delete a public IP. The IP will be released in VMC provider.</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>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>
Service Unavailable</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="com.vmware.nsx_vmc_app.infra_client.PublicIps.get">
<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>
<dd><p>Get the public IP information.</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>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>
</dd></dl>
<dl class="method">
<dt id="com.vmware.nsx_vmc_app.infra_client.PublicIps.list">
<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.PublicIps.list" title="Permalink to this definition"></a></dt>
<dd><p>List all public IPs obtained in the SDDC.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><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></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">com.vmware.nsx_vmc_app.model.PublicIpsListResult</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>
</dd></dl>
<dl class="method">
<dt id="com.vmware.nsx_vmc_app.infra_client.PublicIps.update">
<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>
<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>
<table class="docutils field-list" frame="void" rules="none">
<col class="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>
Service Unavailable</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<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>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.nsx_vmc_app.infra_client.StubFactory">
<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>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.nsx_vmc_app.model_client">
<span id="com-vmware-nsx-vmc-app-model-client-module"></span><h2>com.vmware.nsx_vmc_app.model_client module<a class="headerlink" href="#module-com.vmware.nsx_vmc_app.model_client" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="com.vmware.nsx_vmc_app.model_client.AdvertisedRoute">
<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>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Advertised BGP route</p>
<div class="admonition tip">
<p class="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>advertisement_state</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>Possible values are:</p>
<ul>
<li><a class="reference internal" href="#com.vmware.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>
</ul>
<blockquote>
<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>) – 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">
<dt id="com.vmware.nsx_vmc_app.model_client.AdvertisedRoute.ADVERTISEMENT_STATE_FAILED">
<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>
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.AdvertisedRoute.ADVERTISEMENT_STATE_SUCCESS">
<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>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.nsx_vmc_app.model_client.ApiError">
<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>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Detailed information about an API Error</p>
<div class="admonition tip">
<p class="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>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>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.nsx_vmc_app.model_client.BGPAdvertisedRoutes">
<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>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Advertised bgp routes</p>
<div class="admonition tip">
<p class="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>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>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.nsx_vmc_app.model_client.BGPLearnedRoutes">
<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>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Learned bgp routes</p>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>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>
</dd></dl>
<dl class="class">
<dt id="com.vmware.nsx_vmc_app.model_client.ConnectedServiceListResult">
<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>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>A list of status of ‘Enabled/Disabled’ for a service connected to a linked
vpc</p>
<div class="admonition tip">
<p class="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>links</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ResourceLink" title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</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
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>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
by current result page)
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</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
format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</li>
<li><strong>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.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>) – Connected service status list</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.nsx_vmc_app.model_client.ConnectedServiceStatus">
<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>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>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Status of ‘Enabled/Disabled’ for a service connected to a linked vpc</p>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – status of service
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</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
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.nsx_vmc_app.model_client.DirectConnectBgpInfo">
<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>local_as_num=None</em>, <em>mtu=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>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Direct Connect BGP related information</p>
<div class="admonition tip">
<p class="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>local_as_num</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The ASN paired with the VGW attached to the VPC. AWS allowed
private BGP ASN range - [64512, 65534] and [4200000000, 4294967294]</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
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.nsx_vmc_app.model_client.DiscoveredResource">
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">DiscoveredResource</code><span class="sig-paren">(</span><em>links=None</em>, <em>schema=None</em>, <em>self_=None</em>, <em>last_sync_time=None</em>, <em>description=None</em>, <em>display_name=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.DiscoveredResource" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Base class for resources that are discovered and automatically updated</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>links</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ResourceLink" title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</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
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>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>last_sync_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Timestamp of last modification format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</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>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>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.nsx_vmc_app.model_client.EmbeddedResource">
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">EmbeddedResource</code><span class="sig-paren">(</span><em>links=None</em>, <em>schema=None</em>, <em>self_=None</em>, <em>revision=None</em>, <em>owner=None</em>, <em>description=None</em>, <em>display_name=None</em>, <em>id=None</em>, <em>resource_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.EmbeddedResource" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Base class for resources that are embedded in other resources</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>links</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ResourceLink" title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</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
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>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
resource. To prevent clients from overwriting each other’s changes,
PUT operations must include the current _revision of the resource,
which clients should obtain by issuing a GET operation. If the
_revision provided in a PUT request is missing or stale, the
operation will be rejected. format: int32</li>
<li><strong>owner</strong> (<a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.OwnerResourceLink" title="com.vmware.nsx_vmc_app.model_client.OwnerResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">OwnerResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Owner of this resource</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>) – Identifier of the 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>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>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.nsx_vmc_app.model_client.InterfaceStatistics">
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">InterfaceStatistics</code><span class="sig-paren">(</span><em>links=None</em>, <em>schema=None</em>, <em>self_=None</em>, <em>rx_bytes=None</em>, <em>rx_errors=None</em>, <em>rx_packets=None</em>, <em>tx_bytes=None</em>, <em>tx_errors=None</em>, <em>tx_packets=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.InterfaceStatistics" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Statistics for a network interface</p>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>links</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ResourceLink" title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</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
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>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>rx_bytes</strong> (<code class="xref 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 bytes received on this port format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</li>
<li><strong>rx_errors</strong> (<code class="xref 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 receive errors occurring on this port format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</li>
<li><strong>rx_packets</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Count of packets received on this port format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</li>
<li><strong>tx_bytes</strong> (<code class="xref 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 bytes transmitted on this port format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</li>
<li><strong>tx_errors</strong> (<code class="xref 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 transmit errors occurring on this port format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</li>
<li><strong>tx_packets</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Count of packets transmitted on this port format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.nsx_vmc_app.model_client.IpAttachmentPair">
<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>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>attachment_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</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>) – Management VM IP Address format: ipv4</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.nsx_vmc_app.model_client.LinkedSubnetInfo">
<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>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Infromation related to a subnet where linked ENIs were created.</p>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>availability_zone</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Linked subnet availability zone</li>
<li><strong>cidr</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</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>) – Linked subnet identifier</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.nsx_vmc_app.model_client.LinkedVpcInfo">
<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>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>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Linked VPC info</p>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>active_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>) – 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>) – 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>) – 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>) – 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>) – 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>) – 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>) – 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>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.nsx_vmc_app.model_client.LinkedVpcsListResult">
<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>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Linked VPC list query result</p>
<div class="admonition tip">
<p class="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>links</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ResourceLink" title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</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
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>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
by current result page)
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</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
format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</li>
<li><strong>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.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>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.nsx_vmc_app.model_client.ListResult">
<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>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Base class for list results from collections</p>
<div class="admonition tip">
<p class="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>links</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ResourceLink" title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</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
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>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
by current result page)
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</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
format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</li>
<li><strong>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>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.nsx_vmc_app.model_client.ManagedResource">
<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>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Base type for resources that are managed by API clients</p>
<div class="admonition tip">
<p class="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>links</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ResourceLink" title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</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
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>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
resource. To prevent clients from overwriting each other’s changes,
PUT operations must include the current _revision of the resource,
which clients should obtain by issuing a GET operation. If the
_revision provided in a PUT request is missing or stale, the
operation will be rejected. format: int32</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
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>create_user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – ID of the user who created this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</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
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>last_modified_user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – ID of the user who last modified this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</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
who retrieved the entity is not allowed to modify it. NOT_PROTECTED
- the client who retrieved the entity is allowed to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing the request header
X-Allow-Overwrite=true. UNKNOWN - the _protection field could not
be determined for this entity.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</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
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>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>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.nsx_vmc_app.model_client.MgmtServiceEntry">
<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>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>A service entry describes the detail of a network service.</p>
<div class="admonition tip">
<p class="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>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>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.nsx_vmc_app.model_client.MgmtVmInfo">
<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>display_name=None</em>, <em>group_path=None</em>, <em>id=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>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Management VM access information</p>
<div class="admonition tip">
<p class="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>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>group_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – For each management VM, a dedicated policy group will be created.
This property will reflect its group path.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</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
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>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>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.nsx_vmc_app.model_client.MgmtVmsListResult">
<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>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Management VM list query result</p>
<div class="admonition tip">
<p class="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>links</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ResourceLink" title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</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
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>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
by current result page)
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</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
format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</li>
<li><strong>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.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>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.nsx_vmc_app.model_client.OwnerResourceLink">
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">OwnerResourceLink</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.OwnerResourceLink" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The server will populate this field when returing the resource. Ignored on
PUT and POST.</p>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>action</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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
definitions exist)
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.nsx_vmc_app.model_client.PrefixInfo">
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">PrefixInfo</code><span class="sig-paren">(</span><em>display_name=None</em>, <em>prefixes=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.PrefixInfo" title="Permalink to this definition"></a></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>Service IP prefixes 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>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Display name
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</li>
<li><strong>prefixes</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>) – Service IP prefixes format: ipv4-cidr-block</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.nsx_vmc_app.model_client.PrefixesListResult">
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">PrefixesListResult</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.PrefixesListResult" title="Permalink to this definition"></a></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>Service Prefix list query result</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>links</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ResourceLink" title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</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
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>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
by current result page)
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</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
format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</li>
<li><strong>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.PrefixInfo" title="com.vmware.nsx_vmc_app.model_client.PrefixInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">PrefixInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Service Prefixes list</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.nsx_vmc_app.model_client.PublicIp">
<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>display_name=None</em>, <em>id=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>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>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
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>ip</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – IPv4 address format: ipv4
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.nsx_vmc_app.model_client.PublicIpsListResult">
<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>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Public IP list</p>
<div class="admonition tip">
<p class="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>links</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ResourceLink" title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</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
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>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
by current result page)
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</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
format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</li>
<li><strong>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.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>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.nsx_vmc_app.model_client.RelatedApiError">
<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>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Detailed information about a related API error</p>
<div class="admonition tip">
<p class="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>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>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.nsx_vmc_app.model_client.Resource">
<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>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Base class for resources</p>
<div class="admonition tip">
<p class="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>links</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ResourceLink" title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</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
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>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>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.nsx_vmc_app.model_client.ResourceLink">
<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>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>A link to a related resource</p>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>action</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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
definitions exist)
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.nsx_vmc_app.model_client.RevisionedResource">
<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>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>A base class for types that track revisions</p>
<div class="admonition tip">
<p class="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>links</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ResourceLink" title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</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
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>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
resource. To prevent clients from overwriting each other’s changes,
PUT operations must include the current _revision of the resource,
which clients should obtain by issuing a GET operation. If the
_revision provided in a PUT request is missing or stale, the
operation will be rejected. format: int32</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.nsx_vmc_app.model_client.SddcUserConfiguration">
<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>compute_gateway=None</em>, <em>dx_interface_label=None</em>, <em>linked_vpc_interface_label=None</em>, <em>management_gateway=None</em>, <em>management_gateway_label=None</em>, <em>mgmt_subnet=None</em>, <em>provider_name=None</em>, <em>public_interface_label=None</em>, <em>sddc_infra_subnet=None</em>, <em>vpn_dx_ips=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>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>SDDC configuration parameters for users. User-level addresses/CIDRs are
provided.</p>
<div class="admonition tip">
<p class="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>all_uplink_interface_label</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – All uplink interfaces label name</li>
<li><strong>all_vpn_interface_label</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – All VPN interfaces label name</li>
<li><strong>compute_gateway</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Compute gateway name</li>
<li><strong>dx_interface_label</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – DirectConnect interface label name</li>
<li><strong>linked_vpc_interface_label</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Linked VPC interface label name</li>
<li><strong>management_gateway</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Management gateway name</li>
<li><strong>management_gateway_label</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Management gateway label name</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>) – Management VMs CIDRs format: ipv4-cidr-block</li>
<li><strong>provider_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Provider Name</li>
<li><strong>public_interface_label</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Public interface label name</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>) – SDDC Infra CIDRs 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 format: ipv4</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 format: ipv4</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.nsx_vmc_app.model_client.SelfResourceLink">
<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>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The server will populate this field when returing the resource. Ignored on
PUT and POST.</p>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>action</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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
definitions exist)
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.nsx_vmc_app.model_client.StubFactory">
<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>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.nsx_vmc_app.model_client.Tag">
<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>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Arbitrary key-value pairs that may be attached to an entity</p>
<div class="admonition tip">
<p class="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>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</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.nsx_vmc_app.model_client.TaskProperties">
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.model_client.</code><code class="descname">TaskProperties</code><span class="sig-paren">(</span><em>links=None</em>, <em>schema=None</em>, <em>self_=None</em>, <em>async_response_available=None</em>, <em>cancelable=None</em>, <em>description=None</em>, <em>end_time=None</em>, <em>id=None</em>, <em>message=None</em>, <em>progress=None</em>, <em>request_method=None</em>, <em>request_uri=None</em>, <em>start_time=None</em>, <em>status=None</em>, <em>user=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.TaskProperties" title="Permalink to this definition"></a></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>Task properties</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>links</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ResourceLink" title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</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
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>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>async_response_available</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – True if response for asynchronous request is available
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>cancelable</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – True if this task can be canceled
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 the task
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>end_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The end time of the task in epoch milliseconds format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</li>
<li><strong>id</strong> (<code class="xref 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 this task
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>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 message describing the disposition of the task
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>progress</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Task progress if known, from 0 to 100 format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</li>
<li><strong>request_method</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – HTTP request method
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>request_uri</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – URI of the method invocation that spawned this task
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>start_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The start time of the task in epoch milliseconds format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</li>
<li><strong>status</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Possible values are:</p>
<ul>
<li><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.TaskProperties.STATUS_RUNNING" title="com.vmware.nsx_vmc_app.model_client.TaskProperties.STATUS_RUNNING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">TaskProperties.STATUS_RUNNING</span></code></a></li>
<li><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.TaskProperties.STATUS_ERROR" title="com.vmware.nsx_vmc_app.model_client.TaskProperties.STATUS_ERROR"><code class="xref py py-attr docutils literal notranslate"><span class="pre">TaskProperties.STATUS_ERROR</span></code></a></li>
<li><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.TaskProperties.STATUS_SUCCESS" title="com.vmware.nsx_vmc_app.model_client.TaskProperties.STATUS_SUCCESS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">TaskProperties.STATUS_SUCCESS</span></code></a></li>
<li><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.TaskProperties.STATUS_CANCELING" title="com.vmware.nsx_vmc_app.model_client.TaskProperties.STATUS_CANCELING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">TaskProperties.STATUS_CANCELING</span></code></a></li>
<li><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.TaskProperties.STATUS_CANCELED" title="com.vmware.nsx_vmc_app.model_client.TaskProperties.STATUS_CANCELED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">TaskProperties.STATUS_CANCELED</span></code></a></li>
<li><a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.TaskProperties.STATUS_KILLED" title="com.vmware.nsx_vmc_app.model_client.TaskProperties.STATUS_KILLED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">TaskProperties.STATUS_KILLED</span></code></a></li>
</ul>
<blockquote>
<div>Current status of the task</div></blockquote>
<p>This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p>
</li>
<li><strong>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>) – Name of the user who created this task
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.TaskProperties.STATUS_CANCELED">
<code class="descname">STATUS_CANCELED</code><em class="property"> = 'canceled'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.TaskProperties.STATUS_CANCELED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.TaskProperties.STATUS_CANCELING">
<code class="descname">STATUS_CANCELING</code><em class="property"> = 'canceling'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.TaskProperties.STATUS_CANCELING" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.TaskProperties.STATUS_ERROR">
<code class="descname">STATUS_ERROR</code><em class="property"> = 'error'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.TaskProperties.STATUS_ERROR" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.TaskProperties.STATUS_KILLED">
<code class="descname">STATUS_KILLED</code><em class="property"> = 'killed'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.TaskProperties.STATUS_KILLED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.TaskProperties.STATUS_RUNNING">
<code class="descname">STATUS_RUNNING</code><em class="property"> = 'running'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.TaskProperties.STATUS_RUNNING" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.TaskProperties.STATUS_SUCCESS">
<code class="descname">STATUS_SUCCESS</code><em class="property"> = 'success'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.model_client.TaskProperties.STATUS_SUCCESS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.nsx_vmc_app.model_client.VMCAccounts">
<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>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Shadow account and linked VPC account</p>
<div class="admonition tip">
<p class="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>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>) – Shadow VPC account number</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.nsx_vmc_app.model_client.VifsListResult">
<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>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Direct Connect VIFs (Virtual Interface) list query result</p>
<div class="admonition tip">
<p class="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>links</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.nsx_vmc_app.model_client.ResourceLink" title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceLink</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</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
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>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
by current result page)
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</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
format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</li>
<li><strong>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.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>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.nsx_vmc_app.model_client.VirtualInterface">
<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>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>bgp_status</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>Possible values are:</p>
<ul>
<li><a class="reference internal" href="#com.vmware.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>
</ul>
<blockquote>
<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>) – 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>) – 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
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>mtu</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum transmission unit allowed by the VIF format: int32
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</li>
<li><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</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
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>remote_ip</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – customer address format: ipv4
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</li>
<li><strong>state</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>Possible values are:</p>
<ul>
<li><a class="reference internal" href="#com.vmware.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>
</ul>
<blockquote>
<div>VIF State</div></blockquote>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.VirtualInterface.BGP_STATUS_DOWN">
<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>
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.VirtualInterface.BGP_STATUS_UP">
<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>
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_ATTACHED">
<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>
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_ATTACHING">
<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>
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_AVAILABLE">
<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>
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_CONFIRMING">
<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>
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_DELETED">
<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>
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_DELETING">
<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>
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_DOWN">
<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>
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_ERROR">
<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>
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_PENDING">
<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>
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_REJECTED">
<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>
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_VERIFYING">
<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>
<dd></dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="com.vmware.nsx_vmc_app.infra.html" class="btn btn-neutral float-right" title="com.vmware.nsx_vmc_app.infra package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="com.vmware.html" class="btn btn-neutral" title="com.vmware package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2018, VMware, Inc.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
View Git Blame Copy Permalink