1
0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-22 09:39:58 -05:00

Updating latest python vmc doc (29f3174)

This commit is contained in:
amanp 2020-01-30 06:11:02 +00:00
parent 1e293c33e7
commit 501df276b9
25 changed files with 155 additions and 113 deletions

View File

@ -1,5 +1,5 @@
.. vmc documentation master file, created by
sphinx-quickstart on Fri Jan 17 04:32:20 2020.
sphinx-quickstart on Thu Jan 30 06:10:34 2020.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.

View File

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

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com package &mdash; vmc 1.21.0 documentation</title>
<title>com package &mdash; vmc 1.22.0 documentation</title>
@ -60,7 +60,7 @@
<div class="version">
1.21.0
1.22.0
</div>

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com.vmware package &mdash; vmc 1.21.0 documentation</title>
<title>com.vmware package &mdash; vmc 1.22.0 documentation</title>
@ -60,7 +60,7 @@
<div class="version">
1.21.0
1.22.0
</div>

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com.vmware.vmc package &mdash; vmc 1.21.0 documentation</title>
<title>com.vmware.vmc package &mdash; vmc 1.22.0 documentation</title>
@ -60,7 +60,7 @@
<div class="version">
1.21.0
1.22.0
</div>
@ -4336,6 +4336,26 @@ names.</p>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.PaymentMethodInfo">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">PaymentMethodInfo</code><span class="sig-paren">(</span><em class="sig-param">_default=None</em>, <em class="sig-param">type=None</em>, <em class="sig-param">payment_method_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.PaymentMethodInfo" 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.struct.VapiStruct</span></code></p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>_default</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>) </p></li>
<li><p><strong>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>) </p></li>
<li><p><strong>payment_method_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>) </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.model_client.PopAgentXeniConnection">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">PopAgentXeniConnection</code><span class="sig-paren">(</span><em class="sig-param">default_subnet_route=None</em>, <em class="sig-param">eni_info=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.PopAgentXeniConnection" title="Permalink to this definition"></a></dt>
@ -5839,6 +5859,9 @@ names.</p>
<li><p><a class="reference internal" href="#com.vmware.vmc.model_client.SubscriptionDetails.STATUS_EXPIRED" title="com.vmware.vmc.model_client.SubscriptionDetails.STATUS_EXPIRED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SubscriptionDetails.STATUS_EXPIRED</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.vmc.model_client.SubscriptionDetails.STATUS_PENDING_PROVISIONING" title="com.vmware.vmc.model_client.SubscriptionDetails.STATUS_PENDING_PROVISIONING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SubscriptionDetails.STATUS_PENDING_PROVISIONING</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.vmc.model_client.SubscriptionDetails.STATUS_ORDER_SUBMITTED" title="com.vmware.vmc.model_client.SubscriptionDetails.STATUS_ORDER_SUBMITTED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SubscriptionDetails.STATUS_ORDER_SUBMITTED</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.vmc.model_client.SubscriptionDetails.STATUS_SUSPENDED" title="com.vmware.vmc.model_client.SubscriptionDetails.STATUS_SUSPENDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SubscriptionDetails.STATUS_SUSPENDED</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.vmc.model_client.SubscriptionDetails.STATUS_TERMINATED" title="com.vmware.vmc.model_client.SubscriptionDetails.STATUS_TERMINATED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SubscriptionDetails.STATUS_TERMINATED</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.vmc.model_client.SubscriptionDetails.STATUS_UKNOWN" title="com.vmware.vmc.model_client.SubscriptionDetails.STATUS_UKNOWN"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SubscriptionDetails.STATUS_UKNOWN</span></code></a></p></li>
</ul>
</p></li>
<li><p><strong>anniversary_billing_date</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>) </p></li>
@ -5897,6 +5920,21 @@ values are “Upfront” and “Monthly”</p></li>
<code class="sig-name descname">STATUS_PENDING_PROVISIONING</code><em class="property"> = 'PENDING_PROVISIONING'</em><a class="headerlink" href="#com.vmware.vmc.model_client.SubscriptionDetails.STATUS_PENDING_PROVISIONING" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.SubscriptionDetails.STATUS_SUSPENDED">
<code class="sig-name descname">STATUS_SUSPENDED</code><em class="property"> = 'SUSPENDED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.SubscriptionDetails.STATUS_SUSPENDED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.SubscriptionDetails.STATUS_TERMINATED">
<code class="sig-name descname">STATUS_TERMINATED</code><em class="property"> = 'TERMINATED'</em><a class="headerlink" href="#com.vmware.vmc.model_client.SubscriptionDetails.STATUS_TERMINATED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.model_client.SubscriptionDetails.STATUS_UKNOWN">
<code class="sig-name descname">STATUS_UKNOWN</code><em class="property"> = 'UKNOWN'</em><a class="headerlink" href="#com.vmware.vmc.model_client.SubscriptionDetails.STATUS_UKNOWN" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
@ -6325,7 +6363,7 @@ names.</p>
<dl class="class">
<dt id="com.vmware.vmc.model_client.VpcInfo">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">VpcInfo</code><span class="sig-paren">(</span><em class="sig-param">vpc_cidr=None</em>, <em class="sig-param">vgw_id=None</em>, <em class="sig-param">esx_public_security_group_id=None</em>, <em class="sig-param">vif_ids=None</em>, <em class="sig-param">vm_security_group_id=None</em>, <em class="sig-param">route_table_id=None</em>, <em class="sig-param">edge_subnet_id=None</em>, <em class="sig-param">id=None</em>, <em class="sig-param">api_association_id=None</em>, <em class="sig-param">api_subnet_id=None</em>, <em class="sig-param">private_subnet_id=None</em>, <em class="sig-param">private_association_id=None</em>, <em class="sig-param">esx_security_group_id=None</em>, <em class="sig-param">subnet_id=None</em>, <em class="sig-param">internet_gateway_id=None</em>, <em class="sig-param">security_group_id=None</em>, <em class="sig-param">association_id=None</em>, <em class="sig-param">vgw_route_table_id=None</em>, <em class="sig-param">edge_association_id=None</em>, <em class="sig-param">provider=None</em>, <em class="sig-param">peering_connection_id=None</em>, <em class="sig-param">network_type=None</em>, <em class="sig-param">available_zones=None</em>, <em class="sig-param">routetables=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.VpcInfo" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.model_client.</code><code class="sig-name descname">VpcInfo</code><span class="sig-paren">(</span><em class="sig-param">vpc_cidr=None</em>, <em class="sig-param">vgw_id=None</em>, <em class="sig-param">esx_public_security_group_id=None</em>, <em class="sig-param">vif_ids=None</em>, <em class="sig-param">vm_security_group_id=None</em>, <em class="sig-param">tgw_ips=None</em>, <em class="sig-param">route_table_id=None</em>, <em class="sig-param">edge_subnet_id=None</em>, <em class="sig-param">id=None</em>, <em class="sig-param">api_association_id=None</em>, <em class="sig-param">api_subnet_id=None</em>, <em class="sig-param">private_subnet_id=None</em>, <em class="sig-param">private_association_id=None</em>, <em class="sig-param">esx_security_group_id=None</em>, <em class="sig-param">subnet_id=None</em>, <em class="sig-param">internet_gateway_id=None</em>, <em class="sig-param">security_group_id=None</em>, <em class="sig-param">association_id=None</em>, <em class="sig-param">vgw_route_table_id=None</em>, <em class="sig-param">edge_association_id=None</em>, <em class="sig-param">provider=None</em>, <em class="sig-param">peering_connection_id=None</em>, <em class="sig-param">network_type=None</em>, <em class="sig-param">available_zones=None</em>, <em class="sig-param">routetables=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.model_client.VpcInfo" 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.struct.VapiStruct</span></code></p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
@ -6340,6 +6378,8 @@ names.</p>
<li><p><strong>esx_public_security_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>) </p></li>
<li><p><strong>vif_ids</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <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>) set of virtual interfaces attached to the sddc</p></li>
<li><p><strong>vm_security_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>) </p></li>
<li><p><strong>tgw_ips</strong> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <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>) Mapping from AZ to a list of IP addresses assigned to TGW ENI
thats connected with Vpc</p></li>
<li><p><strong>route_table_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>) (deprecated)</p></li>
<li><p><strong>edge_subnet_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>) Id of the NSX edge associated with this VPC (deprecated)</p></li>
<li><p><strong>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>) vpc id</p></li>
@ -6826,6 +6866,50 @@ Generic Error</p>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.orgs_client.PaymentMethods">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs_client.</code><code class="sig-name descname">PaymentMethods</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs_client.PaymentMethods" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="method">
<dt id="com.vmware.vmc.orgs_client.PaymentMethods.get_org_payment_methods">
<code class="sig-name descname">get_org_payment_methods</code><span class="sig-paren">(</span><em class="sig-param">org</em>, <em class="sig-param">default_flag=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs_client.PaymentMethods.get_org_payment_methods" title="Permalink to this definition"></a></dt>
<dd><p>Get payment methods of organization</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<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>default_flag</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, will only return default payment methods. (optional,
default to false)</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.model_client.PaymentMethodInfo" title="com.vmware.vmc.model_client.PaymentMethodInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.PaymentMethodInfo</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p></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.Unauthenticated</span></code>
Unauthorized</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>
Organization doesnt exist</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.orgs_client.Providers">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs_client.</code><code class="sig-name descname">Providers</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs_client.Providers" title="Permalink to this definition"></a></dt>

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com.vmware.vmc.orgs package &mdash; vmc 1.21.0 documentation</title>
<title>com.vmware.vmc.orgs package &mdash; vmc 1.22.0 documentation</title>
@ -60,7 +60,7 @@
<div class="version">
1.21.0
1.22.0
</div>
@ -259,13 +259,13 @@
</dl>
<dl class="method">
<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>, <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>
<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</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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<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>linked_account_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>) The linked connected account identifier (optional)</p></li>
<li><p><strong>linked_account_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The linked connected account identifier (required)</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>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
@ -331,7 +331,7 @@ Forbidden</p>
</dl>
<dl class="method">
<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>, <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>
<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</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.
The information is returned as a member of the task (found in
task.params[subnet_list_result] when you are notified it is
@ -341,7 +341,7 @@ complete), and its documented under ref
<dt class="field-odd">Parameters</dt>
<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>linked_account_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>) The linked connected account identifier (optional)</p></li>
<li><p><strong>linked_account_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The linked connected account identifier (required)</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>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>

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com.vmware.vmc.orgs.sddcs.clusters package &mdash; vmc 1.21.0 documentation</title>
<title>com.vmware.vmc.orgs.sddcs.clusters package &mdash; vmc 1.22.0 documentation</title>
@ -60,7 +60,7 @@
<div class="version">
1.21.0
1.22.0
</div>

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com.vmware.vmc.orgs.sddcs package &mdash; vmc 1.21.0 documentation</title>
<title>com.vmware.vmc.orgs.sddcs package &mdash; vmc 1.22.0 documentation</title>
@ -60,7 +60,7 @@
<div class="version">
1.21.0
1.22.0
</div>

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com.vmware.vmc.orgs.sddcs.networks.cgws package &mdash; vmc 1.21.0 documentation</title>
<title>com.vmware.vmc.orgs.sddcs.networks.cgws package &mdash; vmc 1.22.0 documentation</title>
@ -60,7 +60,7 @@
<div class="version">
1.21.0
1.22.0
</div>

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com.vmware.vmc.orgs.sddcs.networks.edges.firewall package &mdash; vmc 1.21.0 documentation</title>
<title>com.vmware.vmc.orgs.sddcs.networks.edges.firewall package &mdash; vmc 1.22.0 documentation</title>
@ -60,7 +60,7 @@
<div class="version">
1.21.0
1.22.0
</div>

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com.vmware.vmc.orgs.sddcs.networks.edges package &mdash; vmc 1.21.0 documentation</title>
<title>com.vmware.vmc.orgs.sddcs.networks.edges package &mdash; vmc 1.22.0 documentation</title>
@ -60,7 +60,7 @@
<div class="version">
1.21.0
1.22.0
</div>

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn package &mdash; vmc 1.21.0 documentation</title>
<title>com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn package &mdash; vmc 1.22.0 documentation</title>
@ -60,7 +60,7 @@
<div class="version">
1.21.0
1.22.0
</div>

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com.vmware.vmc.orgs.sddcs.networks.edges.nat package &mdash; vmc 1.21.0 documentation</title>
<title>com.vmware.vmc.orgs.sddcs.networks.edges.nat package &mdash; vmc 1.22.0 documentation</title>
@ -60,7 +60,7 @@
<div class="version">
1.21.0
1.22.0
</div>

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com.vmware.vmc.orgs.sddcs.networks.edges.statistics package &mdash; vmc 1.21.0 documentation</title>
<title>com.vmware.vmc.orgs.sddcs.networks.edges.statistics package &mdash; vmc 1.22.0 documentation</title>
@ -60,7 +60,7 @@
<div class="version">
1.21.0
1.22.0
</div>

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com.vmware.vmc.orgs.sddcs.networks package &mdash; vmc 1.21.0 documentation</title>
<title>com.vmware.vmc.orgs.sddcs.networks package &mdash; vmc 1.22.0 documentation</title>
@ -60,7 +60,7 @@
<div class="version">
1.21.0
1.22.0
</div>

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Interface definition language to python mapping for enumerated types &mdash; vmc 1.21.0 documentation</title>
<title>Interface definition language to python mapping for enumerated types &mdash; vmc 1.22.0 documentation</title>
@ -58,7 +58,7 @@
<div class="version">
1.21.0
1.22.0
</div>

View File

@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Index &mdash; vmc 1.21.0 documentation</title>
<title>Index &mdash; vmc 1.22.0 documentation</title>
@ -59,7 +59,7 @@
<div class="version">
1.21.0
1.22.0
</div>
@ -454,8 +454,6 @@
</li>
</ul></li>
<li><a href="com.vmware.vmc.orgs.sddcs.html#com.vmware.vmc.orgs.sddcs.addons_client.Credentials.CREATE_ADDON_TYPE_HCX">CREATE_ADDON_TYPE_HCX (com.vmware.vmc.orgs.sddcs.addons_client.Credentials attribute)</a>
</li>
<li><a href="vmware.vapi.vmc.html#vmware.vapi.vmc.client.create_vmc_client">create_vmc_client() (in module vmware.vapi.vmc.client)</a>
</li>
<li><a href="com.vmware.vmc.orgs.sddcs.html#com.vmware.vmc.orgs.sddcs.addons_client.Credentials">Credentials (class in com.vmware.vmc.orgs.sddcs.addons_client)</a>
</li>
@ -830,6 +828,8 @@
<li><a href="com.vmware.vmc.orgs.sddcs.html#com.vmware.vmc.orgs.sddcs.addons_client.Credentials.GET_ADDON_TYPE_HCX">GET_ADDON_TYPE_HCX (com.vmware.vmc.orgs.sddcs.addons_client.Credentials attribute)</a>
</li>
<li><a href="vmware.vapi.vmc.html#vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter.get_max_retries">get_max_retries() (vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter method)</a>
</li>
<li><a href="com.vmware.vmc.html#com.vmware.vmc.orgs_client.PaymentMethods.get_org_payment_methods">get_org_payment_methods() (com.vmware.vmc.orgs_client.PaymentMethods method)</a>
</li>
<li><a href="vmware.vapi.vmc.html#vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter.get_security_context">get_security_context() (vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter method)</a>
</li>
@ -1108,6 +1108,10 @@
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.PagingInfo">PagingInfo (class in com.vmware.vmc.model_client)</a>
</li>
<li><a href="com.vmware.vmc.html#com.vmware.vmc.orgs_client.Sddcs.patch">patch() (com.vmware.vmc.orgs_client.Sddcs method)</a>
</li>
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.PaymentMethodInfo">PaymentMethodInfo (class in com.vmware.vmc.model_client)</a>
</li>
<li><a href="com.vmware.vmc.html#com.vmware.vmc.orgs_client.PaymentMethods">PaymentMethods (class in com.vmware.vmc.orgs_client)</a>
</li>
<li><a href="com.vmware.vmc.orgs.sddcs.networks.html#com.vmware.vmc.orgs.sddcs.networks.edges_client.Peerconfig">Peerconfig (class in com.vmware.vmc.orgs.sddcs.networks.edges_client)</a>
</li>
@ -1407,10 +1411,10 @@
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.SddcTemplate.STATE_DELETED">(com.vmware.vmc.model_client.SddcTemplate attribute)</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.SddcTemplate.STATE_DELETING">STATE_DELETING (com.vmware.vmc.model_client.SddcTemplate attribute)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.Vpn.STATE_DISCONNECTED">STATE_DISCONNECTED (com.vmware.vmc.model_client.Vpn attribute)</a>
</li>
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.SddcTemplate.STATE_FAILED">STATE_FAILED (com.vmware.vmc.model_client.SddcTemplate attribute)</a>
@ -1468,6 +1472,12 @@
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.SubscriptionDetails.STATUS_PENDING_PROVISIONING">STATUS_PENDING_PROVISIONING (com.vmware.vmc.model_client.SubscriptionDetails attribute)</a>
</li>
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.Task.STATUS_STARTED">STATUS_STARTED (com.vmware.vmc.model_client.Task attribute)</a>
</li>
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.SubscriptionDetails.STATUS_SUSPENDED">STATUS_SUSPENDED (com.vmware.vmc.model_client.SubscriptionDetails attribute)</a>
</li>
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.SubscriptionDetails.STATUS_TERMINATED">STATUS_TERMINATED (com.vmware.vmc.model_client.SubscriptionDetails attribute)</a>
</li>
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.SubscriptionDetails.STATUS_UKNOWN">STATUS_UKNOWN (com.vmware.vmc.model_client.SubscriptionDetails attribute)</a>
</li>
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.StoragePolicyReconfigInfo">StoragePolicyReconfigInfo (class in com.vmware.vmc.model_client)</a>
</li>
@ -1667,8 +1677,6 @@
<h2 id="V">V</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="vmware.vapi.vmc.html#vmware.vapi.vmc.client.VmcClient">VmcClient (class in vmware.vapi.vmc.client)</a>
</li>
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.VmcLocale">VmcLocale (class in com.vmware.vmc.model_client)</a>
</li>
<li><a href="vmware.html#module-vmware">vmware (module)</a>
@ -1676,8 +1684,6 @@
<li><a href="vmware.vapi.html#module-vmware.vapi">vmware.vapi (module)</a>
</li>
<li><a href="vmware.vapi.vmc.html#module-vmware.vapi.vmc">vmware.vapi.vmc (module)</a>
</li>
<li><a href="vmware.vapi.vmc.html#module-vmware.vapi.vmc.client">vmware.vapi.vmc.client (module)</a>
</li>
<li><a href="vmware.vapi.vmc.html#module-vmware.vapi.vmc.csp_filter">vmware.vapi.vmc.csp_filter (module)</a>
</li>
@ -1701,10 +1707,10 @@
</li>
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_6">VNIC_GROUP_IDS_VNIC_INDEX_6 (com.vmware.vmc.model_client.FirewallRuleScope attribute)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_7">VNIC_GROUP_IDS_VNIC_INDEX_7 (com.vmware.vmc.model_client.FirewallRuleScope attribute)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_8">VNIC_GROUP_IDS_VNIC_INDEX_8 (com.vmware.vmc.model_client.FirewallRuleScope attribute)</a>
</li>
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_9">VNIC_GROUP_IDS_VNIC_INDEX_9 (com.vmware.vmc.model_client.FirewallRuleScope attribute)</a>

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Welcome to vmcs documentation! &mdash; vmc 1.21.0 documentation</title>
<title>Welcome to vmcs documentation! &mdash; vmc 1.22.0 documentation</title>
@ -59,7 +59,7 @@
<div class="version">
1.21.0
1.22.0
</div>
@ -209,7 +209,7 @@
<li class="toctree-l4"><a class="reference internal" href="vmware.vapi.html#subpackages">Subpackages</a><ul>
<li class="toctree-l5"><a class="reference internal" href="vmware.vapi.vmc.html">vmware.vapi.vmc package</a><ul>
<li class="toctree-l6"><a class="reference internal" href="vmware.vapi.vmc.html#submodules">Submodules</a></li>
<li class="toctree-l6"><a class="reference internal" href="vmware.vapi.vmc.html#module-vmware.vapi.vmc.client">vmware.vapi.vmc.client module</a></li>
<li class="toctree-l6"><a class="reference internal" href="vmware.vapi.vmc.html#vmware-vapi-vmc-client-module">vmware.vapi.vmc.client module</a></li>
<li class="toctree-l6"><a class="reference internal" href="vmware.vapi.vmc.html#module-vmware.vapi.vmc.csp_filter">vmware.vapi.vmc.csp_filter module</a></li>
</ul>
</li>

Binary file not shown.

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Python Module Index &mdash; vmc 1.21.0 documentation</title>
<title>Python Module Index &mdash; vmc 1.22.0 documentation</title>
@ -61,7 +61,7 @@
<div class="version">
1.21.0
1.22.0
</div>
@ -391,11 +391,6 @@
<td>&#160;&#160;&#160;
<a href="vmware.vapi.vmc.html#module-vmware.vapi.vmc"><code class="xref">vmware.vapi.vmc</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<td></td>
<td>&#160;&#160;&#160;
<a href="vmware.vapi.vmc.html#module-vmware.vapi.vmc.client"><code class="xref">vmware.vapi.vmc.client</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<td></td>
<td>&#160;&#160;&#160;

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Search &mdash; vmc 1.21.0 documentation</title>
<title>Search &mdash; vmc 1.22.0 documentation</title>
@ -59,7 +59,7 @@
<div class="version">
1.21.0
1.22.0
</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">
<title>vmware package &mdash; vmc 1.21.0 documentation</title>
<title>vmware package &mdash; vmc 1.22.0 documentation</title>
@ -60,7 +60,7 @@
<div class="version">
1.21.0
1.22.0
</div>
@ -168,7 +168,7 @@
<li class="toctree-l2"><a class="reference internal" href="vmware.vapi.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="vmware.vapi.vmc.html">vmware.vapi.vmc package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="vmware.vapi.vmc.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="vmware.vapi.vmc.html#module-vmware.vapi.vmc.client">vmware.vapi.vmc.client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="vmware.vapi.vmc.html#vmware-vapi-vmc-client-module">vmware.vapi.vmc.client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="vmware.vapi.vmc.html#module-vmware.vapi.vmc.csp_filter">vmware.vapi.vmc.csp_filter module</a></li>
</ul>
</li>

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>vmware.vapi package &mdash; vmc 1.21.0 documentation</title>
<title>vmware.vapi package &mdash; vmc 1.22.0 documentation</title>
@ -60,7 +60,7 @@
<div class="version">
1.21.0
1.22.0
</div>
@ -171,7 +171,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="vmware.vapi.vmc.html">vmware.vapi.vmc package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="vmware.vapi.vmc.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vapi.vmc.html#module-vmware.vapi.vmc.client">vmware.vapi.vmc.client module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vapi.vmc.html#vmware-vapi-vmc-client-module">vmware.vapi.vmc.client module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vapi.vmc.html#module-vmware.vapi.vmc.csp_filter">vmware.vapi.vmc.csp_filter module</a></li>
</ul>
</li>

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>vmware.vapi.vmc package &mdash; vmc 1.21.0 documentation</title>
<title>vmware.vapi.vmc package &mdash; vmc 1.22.0 documentation</title>
@ -59,7 +59,7 @@
<div class="version">
1.21.0
1.22.0
</div>
@ -169,51 +169,8 @@
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="module-vmware.vapi.vmc.client">
<span id="vmware-vapi-vmc-client-module"></span><h2>vmware.vapi.vmc.client module<a class="headerlink" href="#module-vmware.vapi.vmc.client" title="Permalink to this headline"></a></h2>
<p>CSP Refresh token based SecurityContextFilter</p>
<dl class="class">
<dt id="vmware.vapi.vmc.client.VmcClient">
<em class="property">class </em><code class="sig-prename descclassname">vmware.vapi.vmc.client.</code><code class="sig-name descname">VmcClient</code><span class="sig-paren">(</span><em class="sig-param">session</em>, <em class="sig-param">refresh_token</em>, <em class="sig-param">vmc_url</em>, <em class="sig-param">csp_url</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.vmc.client.VmcClient" 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.ApiClient</span></code></p>
<p>VMC Client class that providess access to stubs for all the services in the
VMC API</p>
<p>Initialize VmcClient by creating a stub factory instance using a CSP
Security context filter added to the filter chain of the connector</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>session</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">requests.Session</span></code>) Requests HTTP session instance</p></li>
<li><p><strong>refresh_token</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Refresh token obtained from CSP</p></li>
<li><p><strong>vmc_url</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) URL of the VMC service</p></li>
<li><p><strong>csp_url</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) URL of the CSP service</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="function">
<dt id="vmware.vapi.vmc.client.create_vmc_client">
<code class="sig-prename descclassname">vmware.vapi.vmc.client.</code><code class="sig-name descname">create_vmc_client</code><span class="sig-paren">(</span><em class="sig-param">refresh_token</em>, <em class="sig-param">session=None</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.vmc.client.create_vmc_client" title="Permalink to this definition"></a></dt>
<dd><p>Helper method to create an instance of the VMC API client using the public
VMC and CSP URL.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>refresh_token</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Refresh token obtained from CSP</p></li>
<li><p><strong>session</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">requests.Session</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Requests HTTP session instance. If not specified, then one
is automatically created and used</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#vmware.vapi.vmc.client.VmcClient" title="vmware.vapi.vmc.client.VmcClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.vmc.client.VmcClient</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>VMC Client instance</p>
</dd>
</dl>
</dd></dl>
<div class="section" id="vmware-vapi-vmc-client-module">
<h2>vmware.vapi.vmc.client module<a class="headerlink" href="#vmware-vapi-vmc-client-module" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="module-vmware.vapi.vmc.csp_filter">
<span id="vmware-vapi-vmc-csp-filter-module"></span><h2>vmware.vapi.vmc.csp_filter module<a class="headerlink" href="#module-vmware.vapi.vmc.csp_filter" title="Permalink to this headline"></a></h2>