mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-22 17:39:59 -05:00
639 lines
35 KiB
HTML
639 lines
35 KiB
HTML
|
||
|
||
<!DOCTYPE html>
|
||
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
||
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
||
<head>
|
||
<meta charset="utf-8">
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
|
||
<title>com.vmware.nsx_vmc_app.infra package — NSX VMC AWS Integration API 2.3.0.0.3 documentation</title>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||
|
||
|
||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||
<script type="text/javascript" src="_static/language_data.js"></script>
|
||
|
||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||
|
||
|
||
|
||
|
||
<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.direct_connect package" href="com.vmware.nsx_vmc_app.infra.direct_connect.html" />
|
||
<link rel="prev" title="com.vmware.nsx_vmc_app package" href="com.vmware.nsx_vmc_app.html" />
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav">
|
||
|
||
|
||
<div class="wy-grid-for-nav">
|
||
|
||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
<div class="wy-side-scroll">
|
||
<div class="wy-side-nav-search" >
|
||
|
||
|
||
|
||
<a href="index.html" class="icon icon-home"> NSX VMC AWS Integration API
|
||
|
||
|
||
|
||
</a>
|
||
|
||
|
||
|
||
|
||
<div class="version">
|
||
2.3.0.0.3
|
||
</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 VMC AWS Integration API</a>
|
||
|
||
</nav>
|
||
|
||
|
||
<div class="wy-nav-content">
|
||
|
||
<div class="rst-content">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||
|
||
<ul class="wy-breadcrumbs">
|
||
|
||
<li><a href="index.html">Docs</a> »</li>
|
||
|
||
<li><a href="com.html">com package</a> »</li>
|
||
|
||
<li><a href="com.vmware.html">com.vmware package</a> »</li>
|
||
|
||
<li><a href="com.vmware.nsx_vmc_app.html">com.vmware.nsx_vmc_app package</a> »</li>
|
||
|
||
<li>com.vmware.nsx_vmc_app.infra package</li>
|
||
|
||
|
||
<li class="wy-breadcrumbs-aside">
|
||
|
||
|
||
<a href="_sources/com.vmware.nsx_vmc_app.infra.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.infra">
|
||
<span id="com-vmware-nsx-vmc-app-infra-package"></span><h1>com.vmware.nsx_vmc_app.infra package<a class="headerlink" href="#module-com.vmware.nsx_vmc_app.infra" 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.direct_connect.html">com.vmware.nsx_vmc_app.infra.direct_connect package</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.nsx_vmc_app.infra.direct_connect.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l2"><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>
|
||
</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.direct_connect_client">
|
||
<span id="com-vmware-nsx-vmc-app-infra-direct-connect-client-module"></span><h2>com.vmware.nsx_vmc_app.infra.direct_connect_client module<a class="headerlink" href="#module-com.vmware.nsx_vmc_app.infra.direct_connect_client" title="Permalink to this headline">¶</a></h2>
|
||
<dl class="class">
|
||
<dt id="com.vmware.nsx_vmc_app.infra.direct_connect_client.Bgp">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.infra.direct_connect_client.</code><code class="descname">Bgp</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.infra.direct_connect_client.Bgp" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="method">
|
||
<dt id="com.vmware.nsx_vmc_app.infra.direct_connect_client.Bgp.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.direct_connect_client.Bgp.get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get Direct Connect BGP related information, including current
|
||
Autonomous System Number of the VGW attached to the VPC</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.nsx_vmc_app.html#com.vmware.nsx_vmc_app.model_client.DirectConnectBgpInfo" title="com.vmware.nsx_vmc_app.model_client.DirectConnectBgpInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_vmc_app.model_client.DirectConnectBgpInfo</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>com.vmware.nsx_vmc_app.model.DirectConnectBgpInfo</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||
Service Unavailable</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||
Bad Request, Precondition Failed</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||
Internal Server Error</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||
Forbidden</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||
Not Found</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.nsx_vmc_app.infra.direct_connect_client.Bgp.update">
|
||
<code class="descname">update</code><span class="sig-paren">(</span><em>direct_connect_bgp_info</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.infra.direct_connect_client.Bgp.update" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>This API is used to create or update DX BGP related information. For
|
||
ASN update, VIFs should be disconnected from the DX VGW before making
|
||
this API call. The ASN update operation will be synchronous at this
|
||
point. In the future the user should make use of the Get
|
||
RealizationStatus call to check update status. While an ASN update call
|
||
is in progress, any other DX BGP update request will be rejected.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>direct_connect_bgp_info</strong> (<a class="reference internal" href="com.vmware.nsx_vmc_app.html#com.vmware.nsx_vmc_app.model_client.DirectConnectBgpInfo" title="com.vmware.nsx_vmc_app.model_client.DirectConnectBgpInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_vmc_app.model_client.DirectConnectBgpInfo</span></code></a>) – (required)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx_vmc_app.html#com.vmware.nsx_vmc_app.model_client.DirectConnectBgpInfo" title="com.vmware.nsx_vmc_app.model_client.DirectConnectBgpInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_vmc_app.model_client.DirectConnectBgpInfo</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>com.vmware.nsx_vmc_app.model.DirectConnectBgpInfo</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||
Service Unavailable</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||
Bad Request, Precondition Failed</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||
Internal Server Error</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||
Forbidden</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||
Not Found</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.nsx_vmc_app.infra.direct_connect_client.StubFactory">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.infra.direct_connect_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.direct_connect_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||
<p>Initialize StubFactoryBase</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.nsx_vmc_app.infra.direct_connect_client.Vifs">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.infra.direct_connect_client.</code><code class="descname">Vifs</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.infra.direct_connect_client.Vifs" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.nsx_vmc_app.infra.direct_connect_client.Vifs.CREATE_ACTION_ATTACH">
|
||
<code class="descname">CREATE_ACTION_ATTACH</code><em class="property"> = 'ATTACH'</em><a class="headerlink" href="#com.vmware.nsx_vmc_app.infra.direct_connect_client.Vifs.CREATE_ACTION_ATTACH" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">action</span></code> of method <a class="reference internal" href="#com.vmware.nsx_vmc_app.infra.direct_connect_client.Vifs.create" title="com.vmware.nsx_vmc_app.infra.direct_connect_client.Vifs.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">Vifs.create()</span></code></a>.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.nsx_vmc_app.infra.direct_connect_client.Vifs.create">
|
||
<code class="descname">create</code><span class="sig-paren">(</span><em>vif_id</em>, <em>action</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.infra.direct_connect_client.Vifs.create" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Perform the attach operation in VMC provider to attach the specified
|
||
VIF (Virtual Interface) to the SDDC.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>vif_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||
<li><p><strong>action</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Direct Connect VIF (Virtual Interface) action (required)</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||
Service Unavailable</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||
Bad Request, Precondition Failed</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||
Internal Server Error</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||
Forbidden</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||
Not Found</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.nsx_vmc_app.infra.direct_connect_client.Vifs.delete">
|
||
<code class="descname">delete</code><span class="sig-paren">(</span><em>vif_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.infra.direct_connect_client.Vifs.delete" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Detach and delete a Direct Connect VIF (Virtual Interface) from the
|
||
SDDC. Detach and delete are one operation in VMC provider, a Direct
|
||
Connect VIF will be deleted after detached.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>vif_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||
Service Unavailable</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||
Bad Request, Precondition Failed</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||
Internal Server Error</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||
Forbidden</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||
Not Found</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.nsx_vmc_app.infra.direct_connect_client.Vifs.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.direct_connect_client.Vifs.list" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return all non-connected VIFs (with states “avalible”, “down”,
|
||
“pending” and “confirming”) and connected VIFs that are available
|
||
to the SDDC.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.nsx_vmc_app.html#com.vmware.nsx_vmc_app.model_client.VifsListResult" title="com.vmware.nsx_vmc_app.model_client.VifsListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_vmc_app.model_client.VifsListResult</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>com.vmware.nsx_vmc_app.model.VifsListResult</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||
Service Unavailable</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||
Bad Request, Precondition Failed</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||
Internal Server Error</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||
Forbidden</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||
Not Found</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-com.vmware.nsx_vmc_app.infra.linked_vpcs_client">
|
||
<span id="com-vmware-nsx-vmc-app-infra-linked-vpcs-client-module"></span><h2>com.vmware.nsx_vmc_app.infra.linked_vpcs_client module<a class="headerlink" href="#module-com.vmware.nsx_vmc_app.infra.linked_vpcs_client" title="Permalink to this headline">¶</a></h2>
|
||
<dl class="class">
|
||
<dt id="com.vmware.nsx_vmc_app.infra.linked_vpcs_client.ConnectedServices">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.infra.linked_vpcs_client.</code><code class="descname">ConnectedServices</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.infra.linked_vpcs_client.ConnectedServices" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="method">
|
||
<dt id="com.vmware.nsx_vmc_app.infra.linked_vpcs_client.ConnectedServices.list">
|
||
<code class="descname">list</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.linked_vpcs_client.ConnectedServices.list" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>List services connected to this linked vpc, for example, S3. The
|
||
response consist of all available services along with their status.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>linked_vpc_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – linked vpc id (required)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx_vmc_app.html#com.vmware.nsx_vmc_app.model_client.ConnectedServiceListResult" title="com.vmware.nsx_vmc_app.model_client.ConnectedServiceListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_vmc_app.model_client.ConnectedServiceListResult</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>com.vmware.nsx_vmc_app.model.ConnectedServiceListResult</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||
Service Unavailable</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||
Bad Request, Precondition Failed</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||
Internal Server Error</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||
Forbidden</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||
Not Found</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.nsx_vmc_app.infra.linked_vpcs_client.ConnectedServices.update">
|
||
<code class="descname">update</code><span class="sig-paren">(</span><em>linked_vpc_id</em>, <em>service_name</em>, <em>connected_service_status</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.infra.linked_vpcs_client.ConnectedServices.update" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Connect/Disconnect the service to the given linked vpc. For example,
|
||
connect S3. The user will know what services are available through the
|
||
GET call. If the user is trying to connect/disconnect an unknown
|
||
service, the POST call will throw a 400 Bad Request error.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>linked_vpc_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – linked vpc id (required)</p></li>
|
||
<li><p><strong>service_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – connected service name, e.g. s3 (required)</p></li>
|
||
<li><p><strong>connected_service_status</strong> (<a class="reference internal" href="com.vmware.nsx_vmc_app.html#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">com.vmware.nsx_vmc_app.model_client.ConnectedServiceStatus</span></code></a>) – (required)</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx_vmc_app.html#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">com.vmware.nsx_vmc_app.model_client.ConnectedServiceStatus</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>com.vmware.nsx_vmc_app.model.ConnectedServiceStatus</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||
Service Unavailable</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||
Bad Request, Precondition Failed</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||
Internal Server Error</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||
Forbidden</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||
Not Found</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.nsx_vmc_app.infra.linked_vpcs_client.StubFactory">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.infra.linked_vpcs_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.linked_vpcs_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||
<p>Initialize StubFactoryBase</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-com.vmware.nsx_vmc_app.infra.realized_state_client">
|
||
<span id="com-vmware-nsx-vmc-app-infra-realized-state-client-module"></span><h2>com.vmware.nsx_vmc_app.infra.realized_state_client module<a class="headerlink" href="#module-com.vmware.nsx_vmc_app.infra.realized_state_client" title="Permalink to this headline">¶</a></h2>
|
||
<dl class="class">
|
||
<dt id="com.vmware.nsx_vmc_app.infra.realized_state_client.Status">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.infra.realized_state_client.</code><code class="descname">Status</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.infra.realized_state_client.Status" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="method">
|
||
<dt id="com.vmware.nsx_vmc_app.infra.realized_state_client.Status.get">
|
||
<code class="descname">get</code><span class="sig-paren">(</span><em>intent_path</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_vmc_app.infra.realized_state_client.Status.get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get the consolidated status of an intent object, specified by path in
|
||
query parameter. The intent object is indicated by a specific VMC-App
|
||
API and can contain multiple objects. For example,
|
||
/infra/direct-connect/bgp can return the consolidated status of ASN
|
||
update and route preference update.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>intent_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String Path of the intent object (required)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx_vmc_app.html#com.vmware.nsx_vmc_app.model_client.VmcConsolidatedRealizedStatus" title="com.vmware.nsx_vmc_app.model_client.VmcConsolidatedRealizedStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_vmc_app.model_client.VmcConsolidatedRealizedStatus</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>com.vmware.nsx_vmc_app.model.VmcConsolidatedRealizedStatus</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||
Service Unavailable</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||
Bad Request, Precondition Failed</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||
Internal Server Error</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||
Forbidden</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||
Not Found</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.nsx_vmc_app.infra.realized_state_client.StubFactory">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.nsx_vmc_app.infra.realized_state_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.realized_state_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||
<p>Initialize StubFactoryBase</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<footer>
|
||
|
||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||
|
||
<a href="com.vmware.nsx_vmc_app.infra.direct_connect.html" class="btn btn-neutral float-right" title="com.vmware.nsx_vmc_app.infra.direct_connect package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||
|
||
|
||
<a href="com.vmware.nsx_vmc_app.html" class="btn btn-neutral float-left" title="com.vmware.nsx_vmc_app package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||
|
||
</div>
|
||
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>
|
||
© Copyright 2019, VMware, Inc.
|
||
|
||
</p>
|
||
</div>
|
||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
||
</footer>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</section>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<script type="text/javascript">
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</body>
|
||
</html> |