Mirrors/vsphere-automation-sdk-python
1
0
Fork 0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-26 11:19:59 -05:00
Code
f2a6032fd2
vsphere-automation-sdk-python/nsx/nsx/com.vmware.nsx.migration.html

694 lines
47 KiB
HTML
Raw Normal View History

Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<title>com.vmware.nsx.migration package &mdash; NSX-T SDK 2.5.1.0.1 documentation</title>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="com.vmware.nsx.node package" href="com.vmware.nsx.node.html" />
<link rel="prev" title="com.vmware.nsx.logical_routers.routing.bgp package" href="com.vmware.nsx.logical_routers.routing.bgp.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">
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
<div class="wy-side-nav-search" >
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
<a href="index.html" class="icon icon-home"> NSX-T SDK
</a>
<div class="version">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
2.5.1.0.1
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.nsx_client">com.vmware.nsx_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.nsx_client_for_vmc">com.vmware.nsx_client_for_vmc module</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">NSX-T SDK</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> &raquo;</li>
<li><a href="com.html">com package</a> &raquo;</li>
<li><a href="com.vmware.html">com.vmware package</a> &raquo;</li>
<li><a href="com.vmware.nsx.html">com.vmware.nsx package</a> &raquo;</li>
<li>com.vmware.nsx.migration package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/com.vmware.nsx.migration.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.migration">
<span id="com-vmware-nsx-migration-package"></span><h1>com.vmware.nsx.migration package<a class="headerlink" href="#module-com.vmware.nsx.migration" 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>
</div>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<div class="section" id="module-com.vmware.nsx.migration.logical_constructs_client">
<span id="com-vmware-nsx-migration-logical-constructs-client-module"></span><h2>com.vmware.nsx.migration.logical_constructs_client module<a class="headerlink" href="#module-com.vmware.nsx.migration.logical_constructs_client" title="Permalink to this headline"></a></h2>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
<dl class="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.migration.logical_constructs_client.Stats">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.migration.logical_constructs_client.</code><code class="sig-name descname">Stats</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.logical_constructs_client.Stats" title="Permalink to this definition"></a></dt>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
<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 docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
<dl class="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.migration.logical_constructs_client.Stats.getall">
<code class="sig-name descname">getall</code><span class="sig-paren">(</span><em class="sig-param">cursor=None</em>, <em class="sig-param">included_fields=None</em>, <em class="sig-param">page_size=None</em>, <em class="sig-param">sort_ascending=None</em>, <em class="sig-param">sort_by=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.logical_constructs_client.Stats.getall" title="Permalink to this definition"></a></dt>
<dd><p>Get migration stats for logical constructs phase. This API can be
polled for getting runtime progress of the migration from source to
target.</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dd class="field-odd"><ul class="simple">
<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>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>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</dd>
<dt class="field-even">Return type</dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.LogicalConstructMigrationStatsListResult" title="com.vmware.nsx.model_client.LogicalConstructMigrationStatsListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.LogicalConstructMigrationStatsListResult</span></code></a></p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</dd>
<dt class="field-odd">Returns</dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dd class="field-odd"><p>com.vmware.nsx.model.LogicalConstructMigrationStatsListResult</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</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>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
</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
<dl class="class">
<dt id="com.vmware.nsx.migration.logical_constructs_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.migration.logical_constructs_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.logical_constructs_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>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
</div>
<div class="section" id="module-com.vmware.nsx.migration.migration_unit_groups_client">
<span id="com-vmware-nsx-migration-migration-unit-groups-client-module"></span><h2>com.vmware.nsx.migration.migration_unit_groups_client module<a class="headerlink" href="#module-com.vmware.nsx.migration.migration_unit_groups_client" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="com.vmware.nsx.migration.migration_unit_groups_client.AggregateInfo">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.migration.migration_unit_groups_client.</code><code class="sig-name descname">AggregateInfo</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.migration_unit_groups_client.AggregateInfo" title="Permalink to this definition"></a></dt>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
<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 docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
<dl class="method">
<dt id="com.vmware.nsx.migration.migration_unit_groups_client.AggregateInfo.list">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">component_type=None</em>, <em class="sig-param">cursor=None</em>, <em class="sig-param">included_fields=None</em>, <em class="sig-param">page_size=None</em>, <em class="sig-param">sort_ascending=None</em>, <em class="sig-param">sort_by=None</em>, <em class="sig-param">summary=None</em>, <em class="sig-param">sync=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.migration_unit_groups_client.AggregateInfo.list" title="Permalink to this definition"></a></dt>
<dd><p>Return information of all migration unit groups in the migration plan.
If request parameter summary is set to true, then only count of
migration units will be returned, migration units list will be empty.
If request parameter component type is specified, then all migration
unit groups for that component will be returned.</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>component_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Component type based on which migration unit groups to be filtered
(optional)</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>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>
<li><p><strong>summary</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>) – Flag indicating whether to return summary (optional, default to
false)</p></li>
<li><p><strong>sync</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>) – Synchronize before returning migration unit groups (optional,
default to false)</p></li>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
</ul>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.MigrationUnitGroupAggregateInfoListResult" title="com.vmware.nsx.model_client.MigrationUnitGroupAggregateInfoListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.MigrationUnitGroupAggregateInfoListResult</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx.model.MigrationUnitGroupAggregateInfoListResult</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>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
Service Unavailable</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</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>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
Bad Request, Precondition Failed</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</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>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
Internal Server Error</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</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>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
Forbidden</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</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>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
Not Found</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</dd>
</dl>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.nsx.migration.migration_unit_groups_client.MigrationUnit">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.migration.migration_unit_groups_client.</code><code class="sig-name descname">MigrationUnit</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.migration_unit_groups_client.MigrationUnit" title="Permalink to this definition"></a></dt>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
<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 docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
<dl class="method">
<dt id="com.vmware.nsx.migration.migration_unit_groups_client.MigrationUnit.reorder">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<code class="sig-name descname">reorder</code><span class="sig-paren">(</span><em class="sig-param">group_id</em>, <em class="sig-param">migration_unit_id</em>, <em class="sig-param">reorder_migration_request</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.migration_unit_groups_client.MigrationUnit.reorder" title="Permalink to this definition"></a></dt>
<dd><p>Reorder an migration unit within the migration unit group by placing it
before/after the specified migration unit</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>migration_unit_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>reorder_migration_request</strong> (<a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.ReorderMigrationRequest" title="com.vmware.nsx.model_client.ReorderMigrationRequest"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.ReorderMigrationRequest</span></code></a>) – (required)</p></li>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
</ul>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</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>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
Service Unavailable</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</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>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
Bad Request, Precondition Failed</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</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>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
Internal Server Error</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</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>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
Forbidden</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</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>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
Not Found</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</dd>
</dl>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.nsx.migration.migration_unit_groups_client.Status">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.migration.migration_unit_groups_client.</code><code class="sig-name descname">Status</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.migration_unit_groups_client.Status" title="Permalink to this definition"></a></dt>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
<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 docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
<dl class="method">
<dt id="com.vmware.nsx.migration.migration_unit_groups_client.Status.list">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">group_id</em>, <em class="sig-param">cursor=None</em>, <em class="sig-param">has_errors=None</em>, <em class="sig-param">included_fields=None</em>, <em class="sig-param">page_size=None</em>, <em class="sig-param">sort_ascending=None</em>, <em class="sig-param">sort_by=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.migration_unit_groups_client.Status.list" title="Permalink to this definition"></a></dt>
<dd><p>Get migration status for migration units in the specified group. User
can specify whether to show only the migration units with errors.</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>group_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>has_errors</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>) – Flag to indicate whether to return only migration units with errors
(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>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
</ul>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.MigrationUnitStatusListResult" title="com.vmware.nsx.model_client.MigrationUnitStatusListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.MigrationUnitStatusListResult</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx.model.MigrationUnitStatusListResult</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>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
Service Unavailable</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</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>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
Bad Request, Precondition Failed</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</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>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
Internal Server Error</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</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>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
Forbidden</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</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>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
Not Found</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</dd>
</dl>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.nsx.migration.migration_unit_groups_client.StubFactory">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.migration.migration_unit_groups_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.migration_unit_groups_client.StubFactory" title="Permalink to this definition"></a></dt>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
<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>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
</dd></dl>
</div>
<div class="section" id="module-com.vmware.nsx.migration.migration_units_client">
<span id="com-vmware-nsx-migration-migration-units-client-module"></span><h2>com.vmware.nsx.migration.migration_units_client module<a class="headerlink" href="#module-com.vmware.nsx.migration.migration_units_client" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="com.vmware.nsx.migration.migration_units_client.AggregateInfo">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.migration.migration_units_client.</code><code class="sig-name descname">AggregateInfo</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.migration_units_client.AggregateInfo" title="Permalink to this definition"></a></dt>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
<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 docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
<dl class="attribute">
<dt id="com.vmware.nsx.migration.migration_units_client.AggregateInfo.LIST_SELECTION_STATUS_ALL">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<code class="sig-name descname">LIST_SELECTION_STATUS_ALL</code><em class="property"> = 'ALL'</em><a class="headerlink" href="#com.vmware.nsx.migration.migration_units_client.AggregateInfo.LIST_SELECTION_STATUS_ALL" title="Permalink to this definition"></a></dt>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">selectionStatus</span></code> of method <a class="reference internal" href="#com.vmware.nsx.migration.migration_units_client.AggregateInfo.list" title="com.vmware.nsx.migration.migration_units_client.AggregateInfo.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">AggregateInfo.list()</span></code></a>.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.nsx.migration.migration_units_client.AggregateInfo.LIST_SELECTION_STATUS_DESELECTED">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<code class="sig-name descname">LIST_SELECTION_STATUS_DESELECTED</code><em class="property"> = 'DESELECTED'</em><a class="headerlink" href="#com.vmware.nsx.migration.migration_units_client.AggregateInfo.LIST_SELECTION_STATUS_DESELECTED" title="Permalink to this definition"></a></dt>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">selectionStatus</span></code> of method <a class="reference internal" href="#com.vmware.nsx.migration.migration_units_client.AggregateInfo.list" title="com.vmware.nsx.migration.migration_units_client.AggregateInfo.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">AggregateInfo.list()</span></code></a>.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.nsx.migration.migration_units_client.AggregateInfo.LIST_SELECTION_STATUS_SELECTED">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<code class="sig-name descname">LIST_SELECTION_STATUS_SELECTED</code><em class="property"> = 'SELECTED'</em><a class="headerlink" href="#com.vmware.nsx.migration.migration_units_client.AggregateInfo.LIST_SELECTION_STATUS_SELECTED" title="Permalink to this definition"></a></dt>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">selectionStatus</span></code> of method <a class="reference internal" href="#com.vmware.nsx.migration.migration_units_client.AggregateInfo.list" title="com.vmware.nsx.migration.migration_units_client.AggregateInfo.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">AggregateInfo.list()</span></code></a>.</p>
</dd></dl>
<dl class="method">
<dt id="com.vmware.nsx.migration.migration_units_client.AggregateInfo.list">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">component_type=None</em>, <em class="sig-param">cursor=None</em>, <em class="sig-param">group_id=None</em>, <em class="sig-param">has_errors=None</em>, <em class="sig-param">included_fields=None</em>, <em class="sig-param">metadata=None</em>, <em class="sig-param">page_size=None</em>, <em class="sig-param">selection_status=None</em>, <em class="sig-param">sort_ascending=None</em>, <em class="sig-param">sort_by=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.migration_units_client.AggregateInfo.list" title="Permalink to this definition"></a></dt>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
<dd><p>Get migration units aggregate-info</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>component_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Component type based on which migration units to be filtered
(optional)</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>group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifier of group based on which migration units to be filtered
(optional)</p></li>
<li><p><strong>has_errors</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>) – Flag to indicate whether to return only migration units with errors
(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>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Metadata about migration unit to filter on (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>selection_status</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag to indicate whether to return only selected, only deselected
or both type of migration units (optional, default to ALL)</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>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
</ul>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.MigrationUnitAggregateInfoListResult" title="com.vmware.nsx.model_client.MigrationUnitAggregateInfoListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.MigrationUnitAggregateInfoListResult</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx.model.MigrationUnitAggregateInfoListResult</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>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
Service Unavailable</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</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>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
Bad Request, Precondition Failed</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</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>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
Internal Server Error</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</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>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
Forbidden</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</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>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
Not Found</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</dd>
</dl>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.nsx.migration.migration_units_client.StubFactory">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.migration.migration_units_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.migration_units_client.StubFactory" title="Permalink to this definition"></a></dt>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
<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>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
</dd></dl>
</div>
<div class="section" id="module-com.vmware.nsx.migration.plan_client">
<span id="com-vmware-nsx-migration-plan-client-module"></span><h2>com.vmware.nsx.migration.plan_client module<a class="headerlink" href="#module-com.vmware.nsx.migration.plan_client" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="com.vmware.nsx.migration.plan_client.Settings">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.migration.plan_client.</code><code class="sig-name descname">Settings</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.plan_client.Settings" title="Permalink to this definition"></a></dt>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
<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 docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
<dl class="method">
<dt id="com.vmware.nsx.migration.plan_client.Settings.get">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">component_type</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.plan_client.Settings.get" title="Permalink to this definition"></a></dt>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
<dd><p>Get the migration plan settings for the component.</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>component_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.MigrationPlanSettings" title="com.vmware.nsx.model_client.MigrationPlanSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.MigrationPlanSettings</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx.model.MigrationPlanSettings</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>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
</dd></dl>
<dl class="method">
<dt id="com.vmware.nsx.migration.plan_client.Settings.update">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">component_type</em>, <em class="sig-param">migration_plan_settings</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.plan_client.Settings.update" title="Permalink to this definition"></a></dt>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
<dd><p>Update the migration plan settings for the component.</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>component_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>migration_plan_settings</strong> (<a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.MigrationPlanSettings" title="com.vmware.nsx.model_client.MigrationPlanSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.MigrationPlanSettings</span></code></a>) – (required)</p></li>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
</ul>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.MigrationPlanSettings" title="com.vmware.nsx.model_client.MigrationPlanSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.MigrationPlanSettings</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx.model.MigrationPlanSettings</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>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
Service Unavailable</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</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>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
Bad Request, Precondition Failed</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</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>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
Internal Server Error</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</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>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
Forbidden</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</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>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
Not Found</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</dd>
</dl>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.nsx.migration.plan_client.StubFactory">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.migration.plan_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.plan_client.StubFactory" title="Permalink to this definition"></a></dt>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
<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>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
</dd></dl>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="com.vmware.nsx.node.html" class="btn btn-neutral float-right" title="com.vmware.nsx.node package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
<a href="com.vmware.nsx.logical_routers.routing.bgp.html" class="btn btn-neutral float-left" title="com.vmware.nsx.logical_routers.routing.bgp package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
</div>
<hr/>
<div role="contentinfo">
<p>
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.
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</script>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
</body>
</html>
Copy Permalink