1
0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-26 03:10:00 -05:00

Updating latest python vmc docs

This commit is contained in:
amanp 2019-07-15 12:32:15 +00:00
parent bf8eb0d494
commit f9cc3aeca8
24 changed files with 52 additions and 52 deletions

View File

@ -1,5 +1,5 @@
.. VMware Cloud on AWS Console API documentation master file, created by .. VMware Cloud on AWS Console API documentation master file, created by
sphinx-quickstart on Wed Jul 10 06:17:09 2019. sphinx-quickstart on Mon Jul 15 12:31:49 2019.
You can adapt this file completely to your liking, but it should at least You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive. contain the root `toctree` directive.

View File

@ -1,6 +1,6 @@
var DOCUMENTATION_OPTIONS = { var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '1.8.0', VERSION: '1.9.0',
LANGUAGE: 'en', LANGUAGE: 'en',
COLLAPSE_INDEX: false, COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html', FILE_SUFFIX: '.html',

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com package &mdash; VMware Cloud on AWS Console API 1.8.0 documentation</title> <title>com package &mdash; VMware Cloud on AWS Console API 1.9.0 documentation</title>
@ -60,7 +60,7 @@
<div class="version"> <div class="version">
1.8.0 1.9.0
</div> </div>

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com.vmware package &mdash; VMware Cloud on AWS Console API 1.8.0 documentation</title> <title>com.vmware package &mdash; VMware Cloud on AWS Console API 1.9.0 documentation</title>
@ -60,7 +60,7 @@
<div class="version"> <div class="version">
1.8.0 1.9.0
</div> </div>

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com.vmware.vmc package &mdash; VMware Cloud on AWS Console API 1.8.0 documentation</title> <title>com.vmware.vmc package &mdash; VMware Cloud on AWS Console API 1.9.0 documentation</title>
@ -60,7 +60,7 @@
<div class="version"> <div class="version">
1.8.0 1.9.0
</div> </div>
@ -6485,21 +6485,17 @@ Forbidden</p>
</dl> </dl>
<dl class="method"> <dl class="method">
<dt id="com.vmware.vmc.orgs_client.Sddcs.create"> <dt id="com.vmware.vmc.orgs_client.Sddcs.create">
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param">org</em>, <em class="sig-param">sddc_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs_client.Sddcs.create" title="Permalink to this definition"></a></dt> <code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param">org</em>, <em class="sig-param">sddc_config</em>, <em class="sig-param">validate_only=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs_client.Sddcs.create" title="Permalink to this definition"></a></dt>
<dd><p>Provision an SDDC in target cloud</p> <dd><p>Provision an SDDC in target cloud</p>
<dl class="field-list simple"> <dl class="field-list simple">
<dt class="field-odd">Parameters</dt> <dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple"> <dd class="field-odd"><ul class="simple">
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Organization identifier. (required)</p></li> <li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Organization identifier. (required)</p></li>
<li><p><strong>sddc_config</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.AwsSddcConfig" title="com.vmware.vmc.model_client.AwsSddcConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.AwsSddcConfig</span></code></a>) sddcConfig (required)</p></li> <li><p><strong>sddc_config</strong> (<a class="reference internal" href="#com.vmware.vmc.model_client.AwsSddcConfig" title="com.vmware.vmc.model_client.AwsSddcConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.AwsSddcConfig</span></code></a>) sddcConfig (required)</p></li>
<li><p><strong>validate_only</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>) When true, only validates the given sddc configuration without
provisioning. (optional)</p></li>
</ul> </ul>
</dd> </dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vmc.model_client.Task" title="com.vmware.vmc.model_client.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Task</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.vmc.model.Task</p>
</dd>
<dt class="field-even">Raise</dt> <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.Unauthenticated</span></code> <dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
Unauthorized</p> Unauthorized</p>

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com.vmware.vmc.orgs package &mdash; VMware Cloud on AWS Console API 1.8.0 documentation</title> <title>com.vmware.vmc.orgs package &mdash; VMware Cloud on AWS Console API 1.9.0 documentation</title>
@ -60,7 +60,7 @@
<div class="version"> <div class="version">
1.8.0 1.9.0
</div> </div>
@ -253,7 +253,7 @@
</dl> </dl>
<dl class="method"> <dl class="method">
<dt id="com.vmware.vmc.orgs.account_link_client.CompatibleSubnets.get"> <dt id="com.vmware.vmc.orgs.account_link_client.CompatibleSubnets.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">org</em>, <em class="sig-param">linked_account_id=None</em>, <em class="sig-param">region=None</em>, <em class="sig-param">sddc=None</em>, <em class="sig-param">force_refresh=None</em>, <em class="sig-param">instance_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.account_link_client.CompatibleSubnets.get" title="Permalink to this definition"></a></dt> <code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">org</em>, <em class="sig-param">linked_account_id=None</em>, <em class="sig-param">region=None</em>, <em class="sig-param">sddc=None</em>, <em class="sig-param">force_refresh=None</em>, <em class="sig-param">instance_type=None</em>, <em class="sig-param">sddc_type=None</em>, <em class="sig-param">num_of_hosts=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.account_link_client.CompatibleSubnets.get" title="Permalink to this definition"></a></dt>
<dd><p>Gets a customers compatible subnets for account linking</p> <dd><p>Gets a customers compatible subnets for account linking</p>
<dl class="field-list simple"> <dl class="field-list simple">
<dt class="field-odd">Parameters</dt> <dt class="field-odd">Parameters</dt>
@ -265,6 +265,8 @@
<li><p><strong>force_refresh</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>) When true, forces the mappings for datacenters to be refreshed for <li><p><strong>force_refresh</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>) When true, forces the mappings for datacenters to be refreshed for
the connected account. (optional)</p></li> the connected account. (optional)</p></li>
<li><p><strong>instance_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The server instance type to be used. (optional)</p></li> <li><p><strong>instance_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The server instance type to be used. (optional)</p></li>
<li><p><strong>sddc_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The sddc type to be used. (1NODE, SingleAZ, MultiAZ) (optional)</p></li>
<li><p><strong>num_of_hosts</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The number of hosts (optional)</p></li>
</ul> </ul>
</dd> </dd>
<dt class="field-even">Return type</dt> <dt class="field-even">Return type</dt>
@ -323,7 +325,7 @@ Forbidden</p>
</dl> </dl>
<dl class="method"> <dl class="method">
<dt id="com.vmware.vmc.orgs.account_link_client.CompatibleSubnetsAsync.get"> <dt id="com.vmware.vmc.orgs.account_link_client.CompatibleSubnetsAsync.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">org</em>, <em class="sig-param">linked_account_id=None</em>, <em class="sig-param">region=None</em>, <em class="sig-param">sddc=None</em>, <em class="sig-param">instance_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.account_link_client.CompatibleSubnetsAsync.get" title="Permalink to this definition"></a></dt> <code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">org</em>, <em class="sig-param">linked_account_id=None</em>, <em class="sig-param">region=None</em>, <em class="sig-param">sddc=None</em>, <em class="sig-param">instance_type=None</em>, <em class="sig-param">sddc_type=None</em>, <em class="sig-param">num_of_hosts=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.account_link_client.CompatibleSubnetsAsync.get" title="Permalink to this definition"></a></dt>
<dd><p>Gets a customers compatible subnets for account linking via a task. <dd><p>Gets a customers compatible subnets for account linking via a task.
The information is returned as a member of the task (found in The information is returned as a member of the task (found in
task.params[subnet_list_result] when you are notified it is task.params[subnet_list_result] when you are notified it is
@ -337,6 +339,8 @@ complete), and its documented under ref
<li><p><strong>region</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The region of the cloud resources to work in (optional)</p></li> <li><p><strong>region</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The region of the cloud resources to work in (optional)</p></li>
<li><p><strong>sddc</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>) sddc (optional)</p></li> <li><p><strong>sddc</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>) sddc (optional)</p></li>
<li><p><strong>instance_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The server instance type to be used. (optional)</p></li> <li><p><strong>instance_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The server instance type to be used. (optional)</p></li>
<li><p><strong>sddc_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The sddc type to be used. (1NODE, SingleAZ, MultiAZ) (optional)</p></li>
<li><p><strong>num_of_hosts</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The number of hosts (optional)</p></li>
</ul> </ul>
</dd> </dd>
<dt class="field-even">Return type</dt> <dt class="field-even">Return type</dt>

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com.vmware.vmc.orgs.sddcs package &mdash; VMware Cloud on AWS Console API 1.8.0 documentation</title> <title>com.vmware.vmc.orgs.sddcs package &mdash; VMware Cloud on AWS Console API 1.9.0 documentation</title>
@ -60,7 +60,7 @@
<div class="version"> <div class="version">
1.8.0 1.9.0
</div> </div>

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com.vmware.vmc.orgs.sddcs.networks.cgws package &mdash; VMware Cloud on AWS Console API 1.8.0 documentation</title> <title>com.vmware.vmc.orgs.sddcs.networks.cgws package &mdash; VMware Cloud on AWS Console API 1.9.0 documentation</title>
@ -60,7 +60,7 @@
<div class="version"> <div class="version">
1.8.0 1.9.0
</div> </div>

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com.vmware.vmc.orgs.sddcs.networks.edges.firewall package &mdash; VMware Cloud on AWS Console API 1.8.0 documentation</title> <title>com.vmware.vmc.orgs.sddcs.networks.edges.firewall package &mdash; VMware Cloud on AWS Console API 1.9.0 documentation</title>
@ -60,7 +60,7 @@
<div class="version"> <div class="version">
1.8.0 1.9.0
</div> </div>

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com.vmware.vmc.orgs.sddcs.networks.edges package &mdash; VMware Cloud on AWS Console API 1.8.0 documentation</title> <title>com.vmware.vmc.orgs.sddcs.networks.edges package &mdash; VMware Cloud on AWS Console API 1.9.0 documentation</title>
@ -60,7 +60,7 @@
<div class="version"> <div class="version">
1.8.0 1.9.0
</div> </div>

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn package &mdash; VMware Cloud on AWS Console API 1.8.0 documentation</title> <title>com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn package &mdash; VMware Cloud on AWS Console API 1.9.0 documentation</title>
@ -60,7 +60,7 @@
<div class="version"> <div class="version">
1.8.0 1.9.0
</div> </div>

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com.vmware.vmc.orgs.sddcs.networks.edges.nat package &mdash; VMware Cloud on AWS Console API 1.8.0 documentation</title> <title>com.vmware.vmc.orgs.sddcs.networks.edges.nat package &mdash; VMware Cloud on AWS Console API 1.9.0 documentation</title>
@ -60,7 +60,7 @@
<div class="version"> <div class="version">
1.8.0 1.9.0
</div> </div>

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com.vmware.vmc.orgs.sddcs.networks.edges.statistics package &mdash; VMware Cloud on AWS Console API 1.8.0 documentation</title> <title>com.vmware.vmc.orgs.sddcs.networks.edges.statistics package &mdash; VMware Cloud on AWS Console API 1.9.0 documentation</title>
@ -60,7 +60,7 @@
<div class="version"> <div class="version">
1.8.0 1.9.0
</div> </div>

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com.vmware.vmc.orgs.sddcs.networks package &mdash; VMware Cloud on AWS Console API 1.8.0 documentation</title> <title>com.vmware.vmc.orgs.sddcs.networks package &mdash; VMware Cloud on AWS Console API 1.9.0 documentation</title>
@ -60,7 +60,7 @@
<div class="version"> <div class="version">
1.8.0 1.9.0
</div> </div>

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Interface definition language to python mapping for enumerated types &mdash; VMware Cloud on AWS Console API 1.8.0 documentation</title> <title>Interface definition language to python mapping for enumerated types &mdash; VMware Cloud on AWS Console API 1.9.0 documentation</title>
@ -58,7 +58,7 @@
<div class="version"> <div class="version">
1.8.0 1.9.0
</div> </div>

View File

@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Index &mdash; VMware Cloud on AWS Console API 1.8.0 documentation</title> <title>Index &mdash; VMware Cloud on AWS Console API 1.9.0 documentation</title>
@ -59,7 +59,7 @@
<div class="version"> <div class="version">
1.8.0 1.9.0
</div> </div>

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Welcome to VMware Cloud on AWS Console APIs documentation! &mdash; VMware Cloud on AWS Console API 1.8.0 documentation</title> <title>Welcome to VMware Cloud on AWS Console APIs documentation! &mdash; VMware Cloud on AWS Console API 1.9.0 documentation</title>
@ -59,7 +59,7 @@
<div class="version"> <div class="version">
1.8.0 1.9.0
</div> </div>

Binary file not shown.

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Python Module Index &mdash; VMware Cloud on AWS Console API 1.8.0 documentation</title> <title>Python Module Index &mdash; VMware Cloud on AWS Console API 1.9.0 documentation</title>
@ -61,7 +61,7 @@
<div class="version"> <div class="version">
1.8.0 1.9.0
</div> </div>

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Search &mdash; VMware Cloud on AWS Console API 1.8.0 documentation</title> <title>Search &mdash; VMware Cloud on AWS Console API 1.9.0 documentation</title>
@ -59,7 +59,7 @@
<div class="version"> <div class="version">
1.8.0 1.9.0
</div> </div>

File diff suppressed because one or more lines are too long

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>vmware package &mdash; VMware Cloud on AWS Console API 1.8.0 documentation</title> <title>vmware package &mdash; VMware Cloud on AWS Console API 1.9.0 documentation</title>
@ -60,7 +60,7 @@
<div class="version"> <div class="version">
1.8.0 1.9.0
</div> </div>

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>vmware.vapi package &mdash; VMware Cloud on AWS Console API 1.8.0 documentation</title> <title>vmware.vapi package &mdash; VMware Cloud on AWS Console API 1.9.0 documentation</title>
@ -60,7 +60,7 @@
<div class="version"> <div class="version">
1.8.0 1.9.0
</div> </div>

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>vmware.vapi.vmc package &mdash; VMware Cloud on AWS Console API 1.8.0 documentation</title> <title>vmware.vapi.vmc package &mdash; VMware Cloud on AWS Console API 1.9.0 documentation</title>
@ -59,7 +59,7 @@
<div class="version"> <div class="version">
1.8.0 1.9.0
</div> </div>