Mirrors/vsphere-automation-sdk-python
1
0
Fork 0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-22 17:39:59 -05:00
Code
7e64cf84f1
vsphere-automation-sdk-python/nsx/nsx_vmc_policy/com.vmware.nsx_policy.infra.segments.html

739 lines
54 KiB
HTML
Raw Normal View History

Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<!DOCTYPE html>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<html class="writer-html5" lang="en" >
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<title>com.vmware.nsx_policy.infra.segments package &mdash; NSX-T Policy API 3.0.2.0.0 documentation</title>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="com.vmware.nsx_policy.infra.service_references package" href="com.vmware.nsx_policy.infra.service_references.html" />
<link rel="prev" title="com.vmware.nsx_policy.infra.realized_state package" href="com.vmware.nsx_policy.infra.realized_state.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<a href="index.html" class="icon icon-home" alt="Documentation Home"> NSX-T Policy API
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
</a>
<div class="version">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
3.0.2.0.0
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<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_policy_client">com.vmware.nsx_policy_client module</a></li>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-nsx-policy-client-for-vmc-module">com.vmware.nsx_policy_client_for_vmc module</a></li>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">NSX-T Policy API</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<li><a href="com.html">com package</a> &raquo;</li>
<li><a href="com.vmware.html">com.vmware package</a> &raquo;</li>
<li><a href="com.vmware.nsx_policy.html">com.vmware.nsx_policy package</a> &raquo;</li>
<li><a href="com.vmware.nsx_policy.infra.html">com.vmware.nsx_policy.infra package</a> &raquo;</li>
<li>com.vmware.nsx_policy.infra.segments package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/com.vmware.nsx_policy.infra.segments.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_policy.infra.segments">
<span id="com-vmware-nsx-policy-infra-segments-package"></span><h1>com.vmware.nsx_policy.infra.segments package<a class="headerlink" href="#module-com.vmware.nsx_policy.infra.segments" title="Permalink to this headline"></a></h1>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</div>
<div class="section" id="module-com.vmware.nsx_policy.infra.segments.dhcp_static_bindings_client">
<span id="com-vmware-nsx-policy-infra-segments-dhcp-static-bindings-client-module"></span><h2>com.vmware.nsx_policy.infra.segments.dhcp_static_bindings_client module<a class="headerlink" href="#module-com.vmware.nsx_policy.infra.segments.dhcp_static_bindings_client" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="com.vmware.nsx_policy.infra.segments.dhcp_static_bindings_client.State">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.segments.dhcp_static_bindings_client.</code><code class="sig-name descname">State</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.segments.dhcp_static_bindings_client.State" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py method">
<dt id="com.vmware.nsx_policy.infra.segments.dhcp_static_bindings_client.State.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">segment_id</span></em>, <em class="sig-param"><span class="n">binding_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.segments.dhcp_static_bindings_client.State.get" title="Permalink to this definition"></a></dt>
<dd><p>Read DHCP static binding state</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>segment_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>binding_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (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_policy.html#com.vmware.nsx_policy.model_client.DhcpStaticBindingState" title="com.vmware.nsx_policy.model_client.DhcpStaticBindingState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.DhcpStaticBindingState</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.DhcpStaticBindingState</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_policy.infra.segments.dhcp_static_bindings_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.segments.dhcp_static_bindings_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.segments.dhcp_static_bindings_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_policy.infra.segments.inter_site_forwarder_client">
<span id="com-vmware-nsx-policy-infra-segments-inter-site-forwarder-client-module"></span><h2>com.vmware.nsx_policy.infra.segments.inter_site_forwarder_client module<a class="headerlink" href="#module-com.vmware.nsx_policy.infra.segments.inter_site_forwarder_client" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="com.vmware.nsx_policy.infra.segments.inter_site_forwarder_client.SiteSpanInfo">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.segments.inter_site_forwarder_client.</code><code class="sig-name descname">SiteSpanInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.segments.inter_site_forwarder_client.SiteSpanInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py method">
<dt id="com.vmware.nsx_policy.infra.segments.inter_site_forwarder_client.SiteSpanInfo.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">segment_id</span></em>, <em class="sig-param"><span class="n">cursor</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">edge_path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">enforcement_point_path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">include_mark_for_delete_objects</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">included_fields</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">page_size</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_ascending</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_by</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.segments.inter_site_forwarder_client.SiteSpanInfo.get" title="Permalink to this definition"></a></dt>
<dd><p>Get infra segment cross site forwarder placement and HA statuss.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>segment_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
by current result page) (optional)</p></li>
<li><p><strong>edge_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Policy path of edge node (optional)</p></li>
<li><p><strong>enforcement_point_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – String Path of the enforcement point (optional)</p></li>
<li><p><strong>include_mark_for_delete_objects</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Include objects that are marked for deletion in results (optional,
default to false)</p></li>
<li><p><strong>included_fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Comma separated list of fields that should be included in query
result (optional)</p></li>
<li><p><strong>page_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of results to return in this page (server may return
fewer) (optional, default to 1000)</p></li>
<li><p><strong>sort_ascending</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</p></li>
<li><p><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted (optional)</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.SegmentL2ForwarderSiteSpanInfo" title="com.vmware.nsx_policy.model_client.SegmentL2ForwarderSiteSpanInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.SegmentL2ForwarderSiteSpanInfo</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.SegmentL2ForwarderSiteSpanInfo</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_policy.infra.segments.inter_site_forwarder_client.Status">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.segments.inter_site_forwarder_client.</code><code class="sig-name descname">Status</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.segments.inter_site_forwarder_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="py method">
<dt id="com.vmware.nsx_policy.infra.segments.inter_site_forwarder_client.Status.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">segment_id</span></em>, <em class="sig-param"><span class="n">cursor</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">edge_path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">enforcement_point_path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">include_mark_for_delete_objects</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">included_fields</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">page_size</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_ascending</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_by</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.segments.inter_site_forwarder_client.Status.get" title="Permalink to this definition"></a></dt>
<dd><p>Get infra segment cross site traffic statistics.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>segment_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
by current result page) (optional)</p></li>
<li><p><strong>edge_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Policy path of edge node (optional)</p></li>
<li><p><strong>enforcement_point_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – String Path of the enforcement point (optional)</p></li>
<li><p><strong>include_mark_for_delete_objects</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Include objects that are marked for deletion in results (optional,
default to false)</p></li>
<li><p><strong>included_fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Comma separated list of fields that should be included in query
result (optional)</p></li>
<li><p><strong>page_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of results to return in this page (server may return
fewer) (optional, default to 1000)</p></li>
<li><p><strong>sort_ascending</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</p></li>
<li><p><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted (optional)</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.SegmentCrossSiteTrafficStats" title="com.vmware.nsx_policy.model_client.SegmentCrossSiteTrafficStats"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.SegmentCrossSiteTrafficStats</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.SegmentCrossSiteTrafficStats</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_policy.infra.segments.inter_site_forwarder_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.segments.inter_site_forwarder_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.segments.inter_site_forwarder_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>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
</div>
<div class="section" id="module-com.vmware.nsx_policy.infra.segments.ports_client">
<span id="com-vmware-nsx-policy-infra-segments-ports-client-module"></span><h2>com.vmware.nsx_policy.infra.segments.ports_client module<a class="headerlink" href="#module-com.vmware.nsx_policy.infra.segments.ports_client" title="Permalink to this headline"></a></h2>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py class">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dt id="com.vmware.nsx_policy.infra.segments.ports_client.PortMonitoringProfileBindingMaps">
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.segments.ports_client.</code><code class="sig-name descname">PortMonitoringProfileBindingMaps</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.segments.ports_client.PortMonitoringProfileBindingMaps" title="Permalink to this definition"></a></dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<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>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dt id="com.vmware.nsx_policy.infra.segments.ports_client.PortMonitoringProfileBindingMaps.delete">
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">infra_segment_id</span></em>, <em class="sig-param"><span class="n">infra_port_id</span></em>, <em class="sig-param"><span class="n">port_monitoring_profile_binding_map_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.segments.ports_client.PortMonitoringProfileBindingMaps.delete" title="Permalink to this definition"></a></dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dd><p>API will delete Infra Port Monitoring Profile Binding Profile.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>infra_segment_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Infra Segment ID (required)</p></li>
<li><p><strong>infra_port_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Infra Port ID (required)</p></li>
<li><p><strong>port_monitoring_profile_binding_map_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Port Monitoring Profile Binding Map ID (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>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dt id="com.vmware.nsx_policy.infra.segments.ports_client.PortMonitoringProfileBindingMaps.get">
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">infra_segment_id</span></em>, <em class="sig-param"><span class="n">infra_port_id</span></em>, <em class="sig-param"><span class="n">port_monitoring_profile_binding_map_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.segments.ports_client.PortMonitoringProfileBindingMaps.get" title="Permalink to this definition"></a></dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dd><p>API will get Infra Port Monitoring Profile Binding Map.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>infra_segment_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Infra Segment ID (required)</p></li>
<li><p><strong>infra_port_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Infra Port ID (required)</p></li>
<li><p><strong>port_monitoring_profile_binding_map_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Port Monitoring Profile Binding Map ID (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_policy.html#com.vmware.nsx_policy.model_client.PortMonitoringProfileBindingMap" title="com.vmware.nsx_policy.model_client.PortMonitoringProfileBindingMap"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.PortMonitoringProfileBindingMap</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.PortMonitoringProfileBindingMap</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>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dt id="com.vmware.nsx_policy.infra.segments.ports_client.PortMonitoringProfileBindingMaps.list">
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">infra_segment_id</span></em>, <em class="sig-param"><span class="n">infra_port_id</span></em>, <em class="sig-param"><span class="n">cursor</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">include_mark_for_delete_objects</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">included_fields</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">page_size</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_ascending</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_by</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.segments.ports_client.PortMonitoringProfileBindingMaps.list" title="Permalink to this definition"></a></dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dd><p>API will list all Infra Port Monitoring Profile Binding Maps in current
port id.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>infra_segment_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>infra_port_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
by current result page) (optional)</p></li>
<li><p><strong>include_mark_for_delete_objects</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Include objects that are marked for deletion in results (optional,
default to false)</p></li>
<li><p><strong>included_fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Comma separated list of fields that should be included in query
result (optional)</p></li>
<li><p><strong>page_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of results to return in this page (server may return
fewer) (optional, default to 1000)</p></li>
<li><p><strong>sort_ascending</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</p></li>
<li><p><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted (optional)</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.PortMonitoringProfileBindingMapListResult" title="com.vmware.nsx_policy.model_client.PortMonitoringProfileBindingMapListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.PortMonitoringProfileBindingMapListResult</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.PortMonitoringProfileBindingMapListResult</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>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dt id="com.vmware.nsx_policy.infra.segments.ports_client.PortMonitoringProfileBindingMaps.patch">
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<code class="sig-name descname">patch</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">infra_segment_id</span></em>, <em class="sig-param"><span class="n">infra_port_id</span></em>, <em class="sig-param"><span class="n">port_monitoring_profile_binding_map_id</span></em>, <em class="sig-param"><span class="n">port_monitoring_profile_binding_map</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.segments.ports_client.PortMonitoringProfileBindingMaps.patch" title="Permalink to this definition"></a></dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dd><p>API will create Infra Port Monitoring Profile Binding Map.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>infra_segment_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Infra Segment ID (required)</p></li>
<li><p><strong>infra_port_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Infra Port ID (required)</p></li>
<li><p><strong>port_monitoring_profile_binding_map_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Port Monitoring Profile Binding Map ID (required)</p></li>
<li><p><strong>port_monitoring_profile_binding_map</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.PortMonitoringProfileBindingMap" title="com.vmware.nsx_policy.model_client.PortMonitoringProfileBindingMap"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.PortMonitoringProfileBindingMap</span></code></a>) – (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>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dt id="com.vmware.nsx_policy.infra.segments.ports_client.PortMonitoringProfileBindingMaps.update">
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">infra_segment_id</span></em>, <em class="sig-param"><span class="n">infra_port_id</span></em>, <em class="sig-param"><span class="n">port_monitoring_profile_binding_map_id</span></em>, <em class="sig-param"><span class="n">port_monitoring_profile_binding_map</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.segments.ports_client.PortMonitoringProfileBindingMaps.update" title="Permalink to this definition"></a></dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dd><p>API will update Infra Port Monitoring Profile Binding Map.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>infra_segment_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – InfraSegment ID (required)</p></li>
<li><p><strong>infra_port_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Infra Port ID (required)</p></li>
<li><p><strong>port_monitoring_profile_binding_map_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Port Monitoring Profile Binding Map ID (required)</p></li>
<li><p><strong>port_monitoring_profile_binding_map</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.PortMonitoringProfileBindingMap" title="com.vmware.nsx_policy.model_client.PortMonitoringProfileBindingMap"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.PortMonitoringProfileBindingMap</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_policy.html#com.vmware.nsx_policy.model_client.PortMonitoringProfileBindingMap" title="com.vmware.nsx_policy.model_client.PortMonitoringProfileBindingMap"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.PortMonitoringProfileBindingMap</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.PortMonitoringProfileBindingMap</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>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py class">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dt id="com.vmware.nsx_policy.infra.segments.ports_client.Statistics">
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.segments.ports_client.</code><code class="sig-name descname">Statistics</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.segments.ports_client.Statistics" title="Permalink to this definition"></a></dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<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>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dt id="com.vmware.nsx_policy.infra.segments.ports_client.Statistics.get">
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">segments_id</span></em>, <em class="sig-param"><span class="n">port_id</span></em>, <em class="sig-param"><span class="n">cursor</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">edge_path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">enforcement_point_path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">include_mark_for_delete_objects</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">included_fields</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">page_size</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_ascending</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_by</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.segments.ports_client.Statistics.get" title="Permalink to this definition"></a></dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dd><p>Get infra segment port statistics information.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>segments_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>port_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
by current result page) (optional)</p></li>
<li><p><strong>edge_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Policy path of edge node (optional)</p></li>
<li><p><strong>enforcement_point_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – String Path of the enforcement point (optional)</p></li>
<li><p><strong>include_mark_for_delete_objects</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Include objects that are marked for deletion in results (optional,
default to false)</p></li>
<li><p><strong>included_fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Comma separated list of fields that should be included in query
result (optional)</p></li>
<li><p><strong>page_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of results to return in this page (server may return
fewer) (optional, default to 1000)</p></li>
<li><p><strong>sort_ascending</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</p></li>
<li><p><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted (optional)</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.SegmentPortStatistics" title="com.vmware.nsx_policy.model_client.SegmentPortStatistics"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.SegmentPortStatistics</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.SegmentPortStatistics</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>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py class">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dt id="com.vmware.nsx_policy.infra.segments.ports_client.StubFactory">
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.segments.ports_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.segments.ports_client.StubFactory" title="Permalink to this definition"></a></dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<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_policy.infra.service_references.html" class="btn btn-neutral float-right" title="com.vmware.nsx_policy.infra.service_references package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="com.vmware.nsx_policy.infra.realized_state.html" class="btn btn-neutral float-left" title="com.vmware.nsx_policy.infra.realized_state package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
&copy; Copyright 2020, VMware, Inc.
</p>
</div>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
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>.
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
Copy Permalink