<spanid="com-vmware-nsx-vmc-app-package"></span><h1>com.vmware.nsx_vmc_app package<aclass="headerlink"href="#module-com.vmware.nsx_vmc_app"title="Permalink to this headline">¶</a></h1>
<divclass="section"id="subpackages">
<h2>Subpackages<aclass="headerlink"href="#subpackages"title="Permalink to this headline">¶</a></h2>
<spanid="com-vmware-nsx-vmc-app-infra-client-module"></span><h2>com.vmware.nsx_vmc_app.infra_client module<aclass="headerlink"href="#module-com.vmware.nsx_vmc_app.infra_client"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_vmc_app.infra_client.</code><codeclass="sig-name descname">Accounts</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.infra_client.Accounts"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.infra_client.Accounts.get"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_vmc_app.infra_client.</code><codeclass="sig-name descname">AssociatedGroups</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.infra_client.AssociatedGroups"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<codeclass="sig-name descname">delete</code><spanclass="sig-paren">(</span><emclass="sig-param">sddc_group_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.infra_client.AssociatedGroups.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Delete the associated Group connection info for the local SDDC just
before skynet service tries to remove the SDDC from the Group.</p>
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">sddc_group_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.infra_client.AssociatedGroups.get"title="Permalink to this definition">¶</a></dt>
<dd><p>The API is used to get the associated Group connection info for the
local SDDC. It returns the run time attachment state for the local
<codeclass="sig-name descname">list</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.infra_client.AssociatedGroups.list"title="Permalink to this definition">¶</a></dt>
<dd><p>This API is used to list all associated Group connection infos for the
local SDDC. It returns the run time attachment state for the local
<codeclass="sig-name descname">update</code><spanclass="sig-paren">(</span><emclass="sig-param">sddc_group_id</em>, <emclass="sig-param">associated_base_group_connection_info</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.infra_client.AssociatedGroups.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Create or update the associated Group connection info for the local
SDDC just after skynet service adds the local SDDC to the Group and the
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_vmc_app.infra_client.</code><codeclass="sig-name descname">FeatureFlags</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.infra_client.FeatureFlags"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">internal_name=None</em>, <emclass="sig-param">name=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.infra_client.FeatureFlags.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Get vmc environment feature flags</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>internal_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – internal feature name (optional)</p></li>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – feature name (optional)</p></li>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_vmc_app.infra_client.</code><codeclass="sig-name descname">LinkedVpcs</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.infra_client.LinkedVpcs"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">linked_vpc_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.infra_client.LinkedVpcs.get"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">list</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.infra_client.LinkedVpcs.list"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_vmc_app.infra_client.</code><codeclass="sig-name descname">MgmtVms</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.infra_client.MgmtVms"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">vm_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.infra_client.MgmtVms.get"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">list</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.infra_client.MgmtVms.list"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_vmc_app.infra_client.</code><codeclass="sig-name descname">PublicIps</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.infra_client.PublicIps"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<codeclass="sig-name descname">delete</code><spanclass="sig-paren">(</span><emclass="sig-param">public_ip_id</em>, <emclass="sig-param">force=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.infra_client.PublicIps.delete"title="Permalink to this definition">¶</a></dt>
<li><p><strong>force</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Force delete the resource even if it is being used somewhere
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">public_ip_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.infra_client.PublicIps.get"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">list</code><spanclass="sig-paren">(</span><emclass="sig-param">cursor=None</em>, <emclass="sig-param">included_fields=None</em>, <emclass="sig-param">page_size=None</em>, <emclass="sig-param">sort_ascending=None</em>, <emclass="sig-param">sort_by=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.infra_client.PublicIps.list"title="Permalink to this definition">¶</a></dt>
<li><p><strong>cursor</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
by current result page) (optional)</p></li>
<li><p><strong>included_fields</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Comma separated list of fields that should be included in query
result (optional)</p></li>
<li><p><strong>page_size</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Maximum number of results to return in this page (server may return
<li><p><strong>sort_by</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Field by which records are sorted (optional)</p></li>
<codeclass="sig-name descname">update</code><spanclass="sig-paren">(</span><emclass="sig-param">public_ip_id</em>, <emclass="sig-param">public_ip</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.infra_client.PublicIps.update"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_vmc_app.infra_client.</code><codeclass="sig-name descname">SddcUserConfig</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.infra_client.SddcUserConfig"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.infra_client.SddcUserConfig.get"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_vmc_app.infra_client.</code><codeclass="sig-name descname">StubFactory</code><spanclass="sig-paren">(</span><emclass="sig-param">stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.infra_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-nsx-vmc-app-model-client-module"></span><h2>com.vmware.nsx_vmc_app.model_client module<aclass="headerlink"href="#module-com.vmware.nsx_vmc_app.model_client"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><codeclass="sig-name descname">AdvertisedRoute</code><spanclass="sig-paren">(</span><emclass="sig-param">advertisement_state=None</em>, <emclass="sig-param">ipv4_cidr=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.AdvertisedRoute"title="Permalink to this definition">¶</a></dt>
<li><p><strong>ipv4_cidr</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The route that is advertised to on-premise datacenter via Direct
<codeclass="sig-name descname">ADVERTISEMENT_STATE_FAILED</code><emclass="property"> = 'FAILED'</em><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.AdvertisedRoute.ADVERTISEMENT_STATE_FAILED"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">ADVERTISEMENT_STATE_SUCCESS</code><emclass="property"> = 'SUCCESS'</em><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.AdvertisedRoute.ADVERTISEMENT_STATE_SUCCESS"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>details</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Further details about the error</p></li>
<li><p><strong>error_code</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A numeric error code format: int64</p></li>
<li><p><strong>error_data</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.struct.VapiStruct</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Additional data about the error</p></li>
<li><p><strong>error_message</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A description of the error</p></li>
<li><p><strong>module_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The module name where the error occurred</p></li>
<li><p><strong>related_errors</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.nsx_vmc_app.model_client.RelatedApiError"title="com.vmware.nsx_vmc_app.model_client.RelatedApiError"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">RelatedApiError</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Other errors related to this error</p></li>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><codeclass="sig-name descname">AssociatedBaseGroupConnectionInfo</code><spanclass="sig-paren">(</span><emclass="sig-param">description=None</em>, <emclass="sig-param">id=None</em>, <emclass="sig-param">name=None</em>, <emclass="sig-param">resource_type='AssociatedBaseGroupConnectionInfo'</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.AssociatedBaseGroupConnectionInfo"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">RESOURCE_TYPE_ASSOCIATEDTGWGROUPCONNECTIONINFO</code><emclass="property"> = 'AssociatedTgwGroupConnectionInfo'</em><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.AssociatedBaseGroupConnectionInfo.RESOURCE_TYPE_ASSOCIATEDTGWGROUPCONNECTIONINFO"title="Permalink to this definition">¶</a></dt>
<emclass="property">property </em><codeclass="sig-name descname">resource_type</code><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.AssociatedBaseGroupConnectionInfo.resource_type"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>links</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.nsx_vmc_app.model_client.ResourceLink"title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ResourceLink</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>schema</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Schema for this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>self</strong> (<aclass="reference internal"href="#com.vmware.nsx_vmc_app.model_client.SelfResourceLink"title="com.vmware.nsx_vmc_app.model_client.SelfResourceLink"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SelfResourceLink</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Link to this resource</p></li>
<li><p><strong>cursor</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
by current result page)
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>result_count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Count of results found (across all pages), set only on first page
format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>sort_ascending</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – If true, results are sorted in ascending order
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>sort_by</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Field by which records are sorted
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>results</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.struct.VapiStruct</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – When clients pass a value of this class as a parameter, the
attribute must contain all the attributes defined in
<aclass="reference internal"href="#com.vmware.nsx_vmc_app.model_client.AssociatedBaseGroupConnectionInfo"title="com.vmware.nsx_vmc_app.model_client.AssociatedBaseGroupConnectionInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">AssociatedBaseGroupConnectionInfo</span></code></a>. When methods return a
value of this class as a return value, the attribute will contain
<div><p>The TGW attachment state of the SDDC in the Group</p>
</div></blockquote>
</p></li>
<li><p><strong>tgw_attachment_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – TGW attachment ID for the local SDDC in the Group</p></li>
<li><p><strong>tgw_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – TGW ID for the local SDDC in the Group</p></li>
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – SDDC Group description</p></li>
<codeclass="sig-name descname">STATE_CONNECTED</code><emclass="property"> = 'CONNECTED'</em><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.AssociatedTgwGroupConnectionInfo.STATE_CONNECTED"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">STATE_DISCONNECTED</code><emclass="property"> = 'DISCONNECTED'</em><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.AssociatedTgwGroupConnectionInfo.STATE_DISCONNECTED"title="Permalink to this definition">¶</a></dt>
<emclass="property">property </em><codeclass="sig-name descname">resource_type</code><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.AssociatedTgwGroupConnectionInfo.resource_type"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><codeclass="sig-name descname">BGPAdvertisedRoutes</code><spanclass="sig-paren">(</span><emclass="sig-param">advertised_routes=None</em>, <emclass="sig-param">failed_advertised_routes=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.BGPAdvertisedRoutes"title="Permalink to this definition">¶</a></dt>
<li><p><strong>advertised_routes</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.nsx_vmc_app.model_client.AdvertisedRoute"title="com.vmware.nsx_vmc_app.model_client.AdvertisedRoute"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">AdvertisedRoute</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Routes advertised to on-premise datacenter via Direct Connect</p></li>
<li><p><strong>failed_advertised_routes</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Number of routes failed to advertise format: int32</p></li>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><codeclass="sig-name descname">BGPLearnedRoutes</code><spanclass="sig-paren">(</span><emclass="sig-param">ipv4_cidr=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.BGPLearnedRoutes"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>ipv4_cidr</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The route that is learned from BGP via Direct Connect format:
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>links</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.nsx_vmc_app.model_client.ResourceLink"title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ResourceLink</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>schema</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Schema for this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>self</strong> (<aclass="reference internal"href="#com.vmware.nsx_vmc_app.model_client.SelfResourceLink"title="com.vmware.nsx_vmc_app.model_client.SelfResourceLink"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SelfResourceLink</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Link to this resource</p></li>
<li><p><strong>cursor</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
by current result page)
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>result_count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Count of results found (across all pages), set only on first page
format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>sort_ascending</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – If true, results are sorted in ascending order
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>sort_by</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Field by which records are sorted
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><codeclass="sig-name descname">ConnectedServiceStatus</code><spanclass="sig-paren">(</span><emclass="sig-param">enabled=None</em>, <emclass="sig-param">name=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.ConnectedServiceStatus"title="Permalink to this definition">¶</a></dt>
<li><p><strong>enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – status of service
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – service name
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><codeclass="sig-name descname">CsvListResult</code><spanclass="sig-paren">(</span><emclass="sig-param">file_name=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.CsvListResult"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>file_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – File name set by HTTP server if API returns CSV result as a file.</p>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><codeclass="sig-name descname">CsvRecord</code><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.CsvRecord"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><codeclass="sig-name descname">DirectConnectBgpInfo</code><spanclass="sig-paren">(</span><emclass="sig-param">local_as_num=None</em>, <emclass="sig-param">mtu=None</em>, <emclass="sig-param">route_preference=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.DirectConnectBgpInfo"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>local_as_num</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The ASN paired with the VGW attached to the VPC. AWS allowed
private BGP ASN range - [64512, 65534] and [4200000000,
4294967294]. If omitted in the payload, BGP ASN will not be
modified.</p></li>
<li><p><strong>mtu</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Maximum transmission unit allowed by the VIF format: int32
<codeclass="sig-name descname">ROUTE_PREFERENCE_DIRECT_CONNECT_PREFERRED_OVER_VPN</code><emclass="property"> = 'DIRECT_CONNECT_PREFERRED_OVER_VPN'</em><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.DirectConnectBgpInfo.ROUTE_PREFERENCE_DIRECT_CONNECT_PREFERRED_OVER_VPN"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">ROUTE_PREFERENCE_VPN_PREFERRED_OVER_DIRECT_CONNECT</code><emclass="property"> = 'VPN_PREFERRED_OVER_DIRECT_CONNECT'</em><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.DirectConnectBgpInfo.ROUTE_PREFERENCE_VPN_PREFERRED_OVER_DIRECT_CONNECT"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><codeclass="sig-name descname">DirectConnectConfig</code><spanclass="sig-paren">(</span><emclass="sig-param">connected_vpc_mtu=None</em>, <emclass="sig-param">internet_mtu=None</em>, <emclass="sig-param">intranet_mtu=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.DirectConnectConfig"title="Permalink to this definition">¶</a></dt>
<li><p><strong>connected_vpc_mtu</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Uplink MTU of connected VPC traffic in edge tier-0 router port.
format: int32
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>internet_mtu</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Uplink MTU of internet traffic in edge tier-0 router port. format:
int32
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>intranet_mtu</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Uplink MTU of direct connect, sddc-grouping and outposts traffic in
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><codeclass="sig-name descname">ExternalSddcConnectivity</code><spanclass="sig-paren">(</span><emclass="sig-param">connectivity_type=None</em>, <emclass="sig-param">error_message=None</em>, <emclass="sig-param">source=None</em>, <emclass="sig-param">status=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.ExternalSddcConnectivity"title="Permalink to this definition">¶</a></dt>
<p>The external SDDC connectivity type is used by the SDDC for the L3
connectivity. DIRECT_CONNECT means that the external SDDC
connectivity is through AWS Direct Connect.
DEPLOYMENT_CONNECTIVITY_GROUP means that the external SDDC
connectivity is through AWS TGW.</p>
</p></li>
<li><p><strong>error_message</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The error message if the status is FAILED</p></li>
<li><p><strong>source</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The source of the route for the connectivity</p></li>
<codeclass="sig-name descname">CONNECTIVITY_TYPE_DEPLOYMENT_CONNECTIVITY_GROUP</code><emclass="property"> = 'DEPLOYMENT_CONNECTIVITY_GROUP'</em><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.ExternalSddcConnectivity.CONNECTIVITY_TYPE_DEPLOYMENT_CONNECTIVITY_GROUP"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">CONNECTIVITY_TYPE_DIRECT_CONNECT</code><emclass="property"> = 'DIRECT_CONNECT'</em><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.ExternalSddcConnectivity.CONNECTIVITY_TYPE_DIRECT_CONNECT"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">STATUS_FAILED</code><emclass="property"> = 'FAILED'</em><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.ExternalSddcConnectivity.STATUS_FAILED"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">STATUS_SUCCEEDED</code><emclass="property"> = 'SUCCEEDED'</em><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.ExternalSddcConnectivity.STATUS_SUCCEEDED"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><codeclass="sig-name descname">ExternalSddcRoute</code><spanclass="sig-paren">(</span><emclass="sig-param">connectivities=None</em>, <emclass="sig-param">destination=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.ExternalSddcRoute"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>connectivities</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.nsx_vmc_app.model_client.ExternalSddcConnectivity"title="com.vmware.nsx_vmc_app.model_client.ExternalSddcConnectivity"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ExternalSddcConnectivity</span></code></a>) – The route used for what kind of connectivities</p></li>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><codeclass="sig-name descname">ExternalSddcRouteCsvRecord</code><spanclass="sig-paren">(</span><emclass="sig-param">connectivity_details=None</em>, <emclass="sig-param">destination=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.ExternalSddcRouteCsvRecord"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>connectivity_details</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The connectivity datails contains status of route, source of the
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>links</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.nsx_vmc_app.model_client.ResourceLink"title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ResourceLink</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>schema</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Schema for this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>self</strong> (<aclass="reference internal"href="#com.vmware.nsx_vmc_app.model_client.SelfResourceLink"title="com.vmware.nsx_vmc_app.model_client.SelfResourceLink"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SelfResourceLink</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Link to this resource</p></li>
<li><p><strong>cursor</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
by current result page)
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>result_count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Count of results found (across all pages), set only on first page
format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>sort_ascending</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – If true, results are sorted in ascending order
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>sort_by</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Field by which records are sorted
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><codeclass="sig-name descname">ExternalSddcRoutesListResultInCsvFormat</code><spanclass="sig-paren">(</span><emclass="sig-param">file_name=None</em>, <emclass="sig-param">results=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.ExternalSddcRoutesListResultInCsvFormat"title="Permalink to this definition">¶</a></dt>
<li><p><strong>file_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – File name set by HTTP server if API returns CSV result as a file.</p></li>
<li><p><strong>results</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.nsx_vmc_app.model_client.ExternalSddcRouteCsvRecord"title="com.vmware.nsx_vmc_app.model_client.ExternalSddcRouteCsvRecord"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ExternalSddcRouteCsvRecord</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</p></li>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><codeclass="sig-name descname">IncludedFieldsParameters</code><spanclass="sig-paren">(</span><emclass="sig-param">included_fields=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.IncludedFieldsParameters"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>included_fields</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Comma separated list of fields that should be included in query
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><codeclass="sig-name descname">IpAttachmentPair</code><spanclass="sig-paren">(</span><emclass="sig-param">attachment_id=None</em>, <emclass="sig-param">ip=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.IpAttachmentPair"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>attachment_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Attachment id which maps to management VM IP</p></li>
<li><p><strong>ip</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Management VM IP Address format: ipv4</p></li>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><codeclass="sig-name descname">LinkedSubnetInfo</code><spanclass="sig-paren">(</span><emclass="sig-param">availability_zone=None</em>, <emclass="sig-param">cidr=None</em>, <emclass="sig-param">id=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.LinkedSubnetInfo"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>active_eni</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Active network interface used for linked vpc traffic</p></li>
<li><p><strong>arn_role</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – ARN role for linked VPC operations</p></li>
<li><p><strong>linked_vpc_nat_ips</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The IPs of linked VPC NAT rule for service access. format: ipv4</p></li>
<li><p><strong>linked_vpc_subnets</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.nsx_vmc_app.model_client.LinkedSubnetInfo"title="com.vmware.nsx_vmc_app.model_client.LinkedSubnetInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LinkedSubnetInfo</span></code></a>) – Infromation related to the subnets where linked ENIs were created.</p></li>
<li><p><strong>route_table_ids</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifiers of route tables to be dynamically updated with SDDC
networks</p></li>
<li><p><strong>service_arn_role</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – service ARN role</p></li>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>links</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.nsx_vmc_app.model_client.ResourceLink"title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ResourceLink</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>schema</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Schema for this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>self</strong> (<aclass="reference internal"href="#com.vmware.nsx_vmc_app.model_client.SelfResourceLink"title="com.vmware.nsx_vmc_app.model_client.SelfResourceLink"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SelfResourceLink</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Link to this resource</p></li>
<li><p><strong>cursor</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
by current result page)
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>result_count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Count of results found (across all pages), set only on first page
format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>sort_ascending</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – If true, results are sorted in ascending order
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>sort_by</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Field by which records are sorted
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<p>Base class for list results from collections</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>links</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.nsx_vmc_app.model_client.ResourceLink"title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ResourceLink</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>schema</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Schema for this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>self</strong> (<aclass="reference internal"href="#com.vmware.nsx_vmc_app.model_client.SelfResourceLink"title="com.vmware.nsx_vmc_app.model_client.SelfResourceLink"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SelfResourceLink</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Link to this resource</p></li>
<li><p><strong>cursor</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
by current result page)
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>result_count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Count of results found (across all pages), set only on first page
format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>sort_ascending</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – If true, results are sorted in ascending order
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>sort_by</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Field by which records are sorted
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><codeclass="sig-name descname">MgmtServiceEntry</code><spanclass="sig-paren">(</span><emclass="sig-param">display_name=None</em>, <emclass="sig-param">path=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.MgmtServiceEntry"title="Permalink to this definition">¶</a></dt>
<p>A service entry describes the detail of a network service.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>display_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Display name for this service</p></li>
<li><p><strong>path</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Service path should refer to a valid service in the system. Service
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>display_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Management VM name</p></li>
<li><p><strong>group_path</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – For each management VM, a dedicated policy group will be created.
This property will reflect its group path.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Management VM identifier
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>ip_attachment_pairs</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.nsx_vmc_app.model_client.IpAttachmentPair"title="com.vmware.nsx_vmc_app.model_client.IpAttachmentPair"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">IpAttachmentPair</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – IP address and attachment id pairs for tagging managment VM</p></li>
<li><p><strong>ips</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Local IPs of a management VM format: address-or-block-or-range</p></li>
<li><p><strong>services</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.nsx_vmc_app.model_client.MgmtServiceEntry"title="com.vmware.nsx_vmc_app.model_client.MgmtServiceEntry"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">MgmtServiceEntry</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Details services path and display name.</p></li>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>links</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.nsx_vmc_app.model_client.ResourceLink"title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ResourceLink</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>schema</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Schema for this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>self</strong> (<aclass="reference internal"href="#com.vmware.nsx_vmc_app.model_client.SelfResourceLink"title="com.vmware.nsx_vmc_app.model_client.SelfResourceLink"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SelfResourceLink</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Link to this resource</p></li>
<li><p><strong>cursor</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
by current result page)
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>result_count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Count of results found (across all pages), set only on first page
format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>sort_ascending</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – If true, results are sorted in ascending order
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>sort_by</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Field by which records are sorted
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><codeclass="sig-name descname">ModelInterface</code><spanclass="sig-paren">(</span><emclass="sig-param">id=None</em>, <emclass="sig-param">name=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.ModelInterface"title="Permalink to this definition">¶</a></dt>
<li><p><strong>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the Interface label</p></li>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the Interface label</p></li>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><codeclass="sig-name descname">PublicIp</code><spanclass="sig-paren">(</span><emclass="sig-param">display_name=None</em>, <emclass="sig-param">id=None</em>, <emclass="sig-param">ip=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.PublicIp"title="Permalink to this definition">¶</a></dt>
<li><p><strong>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Public IP identifier
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>links</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.nsx_vmc_app.model_client.ResourceLink"title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ResourceLink</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>schema</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Schema for this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>self</strong> (<aclass="reference internal"href="#com.vmware.nsx_vmc_app.model_client.SelfResourceLink"title="com.vmware.nsx_vmc_app.model_client.SelfResourceLink"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SelfResourceLink</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Link to this resource</p></li>
<li><p><strong>cursor</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
by current result page)
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>result_count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Count of results found (across all pages), set only on first page
format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>sort_ascending</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – If true, results are sorted in ascending order
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>sort_by</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Field by which records are sorted
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>results</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.nsx_vmc_app.model_client.PublicIp"title="com.vmware.nsx_vmc_app.model_client.PublicIp"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">PublicIp</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Public IP list</p></li>
<p>Detailed information about a related API error</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>details</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Further details about the error</p></li>
<li><p><strong>error_code</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A numeric error code format: int64</p></li>
<li><p><strong>error_data</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.struct.VapiStruct</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Additional data about the error</p></li>
<li><p><strong>error_message</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A description of the error</p></li>
<li><p><strong>module_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The module name where the error occurred</p></li>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><codeclass="sig-name descname">Resource</code><spanclass="sig-paren">(</span><emclass="sig-param">links=None</em>, <emclass="sig-param">schema=None</em>, <emclass="sig-param">self_=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.Resource"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>links</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.nsx_vmc_app.model_client.ResourceLink"title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ResourceLink</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>schema</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Schema for this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>self</strong> (<aclass="reference internal"href="#com.vmware.nsx_vmc_app.model_client.SelfResourceLink"title="com.vmware.nsx_vmc_app.model_client.SelfResourceLink"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SelfResourceLink</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Link to this resource</p></li>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><codeclass="sig-name descname">ResourceLink</code><spanclass="sig-paren">(</span><emclass="sig-param">action=None</em>, <emclass="sig-param">href=None</em>, <emclass="sig-param">rel=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.ResourceLink"title="Permalink to this definition">¶</a></dt>
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>href</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Link to resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>rel</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Custom relation type (follows RFC 5988 where appropriate
definitions exist)
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>vpn_dx_ips</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Local IPs for VPN tunnel over Direct Connect. Deprecated. Please
use vpn_endpoints instead of vpn_dx_ips. format: ipv4</p></li>
<li><p><strong>vpn_endpoints</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.nsx_vmc_app.model_client.VpnEndpoint"title="com.vmware.nsx_vmc_app.model_client.VpnEndpoint"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">VpnEndpoint</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – VPN tunnel endpoints. Currently containing public IPs for VPN over
internet and local IPs for VPN over Direct Connect.</p></li>
<li><p><strong>vpn_internet_ips</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Public IPs for VPN tunnel over internet. Deprecated. Please use
vpn_endpoints instead of vpn_internet_ips. format: ipv4</p></li>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><codeclass="sig-name descname">SelfResourceLink</code><spanclass="sig-paren">(</span><emclass="sig-param">action=None</em>, <emclass="sig-param">href=None</em>, <emclass="sig-param">rel=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.SelfResourceLink"title="Permalink to this definition">¶</a></dt>
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>href</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Link to resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>rel</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Custom relation type (follows RFC 5988 where appropriate
definitions exist)
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><codeclass="sig-name descname">StubFactory</code><spanclass="sig-paren">(</span><emclass="sig-param">stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><codeclass="sig-name descname">VMCAccounts</code><spanclass="sig-paren">(</span><emclass="sig-param">linked_vpc_account=None</em>, <emclass="sig-param">shadow_account=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.VMCAccounts"title="Permalink to this definition">¶</a></dt>
<p>Direct Connect VIFs (Virtual Interface) list query result</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>links</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.nsx_vmc_app.model_client.ResourceLink"title="com.vmware.nsx_vmc_app.model_client.ResourceLink"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ResourceLink</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The server will populate this field when returing the resource.
Ignored on PUT and POST.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>schema</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Schema for this resource
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>self</strong> (<aclass="reference internal"href="#com.vmware.nsx_vmc_app.model_client.SelfResourceLink"title="com.vmware.nsx_vmc_app.model_client.SelfResourceLink"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SelfResourceLink</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Link to this resource</p></li>
<li><p><strong>cursor</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
by current result page)
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>result_count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Count of results found (across all pages), set only on first page
format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>sort_ascending</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – If true, results are sorted in ascending order
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>sort_by</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Field by which records are sorted
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>direct_connect_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the Direct Connect</p></li>
<li><p><strong>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the virtual interface</p></li>
<li><p><strong>local_ip</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – amazon side address format: ipv4
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>mtu</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Maximum transmission unit allowed by the VIF format: int32
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<li><p><strong>remote_asn</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Remote autonomous system number of vif
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</p></li>
<codeclass="sig-name descname">BGP_STATUS_DOWN</code><emclass="property"> = 'DOWN'</em><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.VirtualInterface.BGP_STATUS_DOWN"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">BGP_STATUS_UP</code><emclass="property"> = 'UP'</em><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.VirtualInterface.BGP_STATUS_UP"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">STATE_ATTACHED</code><emclass="property"> = 'ATTACHED'</em><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_ATTACHED"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">STATE_ATTACHING</code><emclass="property"> = 'ATTACHING'</em><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_ATTACHING"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">STATE_AVAILABLE</code><emclass="property"> = 'AVAILABLE'</em><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_AVAILABLE"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">STATE_CONFIRMING</code><emclass="property"> = 'CONFIRMING'</em><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_CONFIRMING"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">STATE_DELETED</code><emclass="property"> = 'DELETED'</em><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_DELETED"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">STATE_DELETING</code><emclass="property"> = 'DELETING'</em><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_DELETING"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">STATE_DOWN</code><emclass="property"> = 'DOWN'</em><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_DOWN"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">STATE_ERROR</code><emclass="property"> = 'ERROR'</em><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_ERROR"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">STATE_PENDING</code><emclass="property"> = 'PENDING'</em><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_PENDING"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">STATE_REJECTED</code><emclass="property"> = 'REJECTED'</em><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_REJECTED"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">STATE_VERIFYING</code><emclass="property"> = 'VERIFYING'</em><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.VirtualInterface.STATE_VERIFYING"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><codeclass="sig-name descname">VmcConsolidatedRealizedStatus</code><spanclass="sig-paren">(</span><emclass="sig-param">consolidated_status=None</em>, <emclass="sig-param">consolidated_status_per_object=None</em>, <emclass="sig-param">intent_path=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.VmcConsolidatedRealizedStatus"title="Permalink to this definition">¶</a></dt>
<p>Represents aggregated realized status for intent entity across associated
realized entities.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>consolidated_status</strong> (<aclass="reference internal"href="#com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatus"title="com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatus"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">VmcConsolidatedStatus</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Consolidated state of objects for a given intent entity.</p></li>
<li><p><strong>consolidated_status_per_object</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatusPerObject"title="com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatusPerObject"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">VmcConsolidatedStatusPerObject</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Aggregated consolidated status by enforcement point.</p></li>
<li><p><strong>intent_path</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Intent path of the object representing this consolidated state.</p></li>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><codeclass="sig-name descname">VmcConsolidatedStatus</code><spanclass="sig-paren">(</span><emclass="sig-param">consolidated_status=None</em>, <emclass="sig-param">status_message=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatus"title="Permalink to this definition">¶</a></dt>
<p>Possible values could be IN_PROGRESS, SUCCESS, ERROR, UNAVAILABLE.
IN_PROGRESS - The object realization is in progress. ERROR - The
object realization fails or is caught in an error. SUCCESS - The
realization succeeds. UNAVAILABLE - The object realization status
is unavailable.</p>
</p></li>
<li><p><strong>status_message</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Help message for the current status regarding an object, providing
<codeclass="sig-name descname">CONSOLIDATED_STATUS_ERROR</code><emclass="property"> = 'ERROR'</em><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatus.CONSOLIDATED_STATUS_ERROR"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">CONSOLIDATED_STATUS_IN_PROGRESS</code><emclass="property"> = 'IN_PROGRESS'</em><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatus.CONSOLIDATED_STATUS_IN_PROGRESS"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">CONSOLIDATED_STATUS_SUCCESS</code><emclass="property"> = 'SUCCESS'</em><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatus.CONSOLIDATED_STATUS_SUCCESS"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">CONSOLIDATED_STATUS_UNAVAILABLE</code><emclass="property"> = 'UNAVAILABLE'</em><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatus.CONSOLIDATED_STATUS_UNAVAILABLE"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><codeclass="sig-name descname">VmcConsolidatedStatusPerObject</code><spanclass="sig-paren">(</span><emclass="sig-param">consolidated_status=None</em>, <emclass="sig-param">object_id=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatusPerObject"title="Permalink to this definition">¶</a></dt>
<p>Realized status consolidated by individual objects.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>consolidated_status</strong> (<aclass="reference internal"href="#com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatus"title="com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatus"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">VmcConsolidatedStatus</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Detailed consolidated realized status for an intent object.</p></li>
<li><p><strong>object_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Object id used to consolidate state. This can be a particular
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><codeclass="sig-name descname">VmcFeatureFlagInfo</code><spanclass="sig-paren">(</span><emclass="sig-param">internal_name=None</em>, <emclass="sig-param">message=None</em>, <emclass="sig-param">name=None</em>, <emclass="sig-param">state=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.VmcFeatureFlagInfo"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">STATE_DISABLED</code><emclass="property"> = 'disabled'</em><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.VmcFeatureFlagInfo.STATE_DISABLED"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">STATE_ENABLED</code><emclass="property"> = 'enabled'</em><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.VmcFeatureFlagInfo.STATE_ENABLED"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">STATE_INACTIVE</code><emclass="property"> = 'inactive'</em><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.VmcFeatureFlagInfo.STATE_INACTIVE"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><codeclass="sig-name descname">VmcFeatureFlags</code><spanclass="sig-paren">(</span><emclass="sig-param">features=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.VmcFeatureFlags"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><codeclass="sig-name descname">VmcKeyValueProviderGatewayListPair</code><spanclass="sig-paren">(</span><emclass="sig-param">key=None</em>, <emclass="sig-param">value=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.VmcKeyValueProviderGatewayListPair"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><codeclass="sig-name descname">VmcProviderGateway</code><spanclass="sig-paren">(</span><emclass="sig-param">display_name=None</em>, <emclass="sig-param">id=None</em>, <emclass="sig-param">path=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.VmcProviderGateway"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_vmc_app.model_client.</code><codeclass="sig-name descname">VpnEndpoint</code><spanclass="sig-paren">(</span><emclass="sig-param">ip=None</em>, <emclass="sig-param">name=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_vmc_app.model_client.VpnEndpoint"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>ip</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – IP address of VPN endpoint format: ipv4</p></li>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the VPN endpoint</p></li>
Built with <ahref="http://sphinx-doc.org/">Sphinx</a> using a <ahref="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <ahref="https://readthedocs.org">Read the Docs</a>.
