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

1345 lines
94 KiB
HTML
Raw Normal View History

2018-08-07 19:42:25 -04:00
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
2018-08-07 19:42:25 -04:00
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com.vmware.vmc.orgs package &mdash; vmc 1.27.0 documentation</title>
2018-08-07 19:42:25 -04:00
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
2018-08-07 19:42:25 -04:00
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
2019-04-17 00:48:58 -04:00
2019-04-15 06:06:35 -04:00
2019-05-29 06:01:09 -04:00
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
2019-05-29 06:01:09 -04:00
<script type="text/javascript" src="_static/js/theme.js"></script>
2018-08-07 19:42:25 -04:00
2019-05-29 06:01:09 -04:00
2018-08-07 19:42:25 -04:00
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="com.vmware.vmc.orgs.aws package" href="com.vmware.vmc.orgs.aws.html" />
2018-08-07 19:42:25 -04:00
<link rel="prev" title="com.vmware.vmc package" href="com.vmware.vmc.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">
2019-05-29 06:01:09 -04:00
<div class="wy-side-nav-search" >
2018-08-07 19:42:25 -04:00
<a href="index.html" class="icon icon-home" alt="Documentation Home"> vmc
2018-08-07 19:42:25 -04:00
</a>
<div class="version">
1.27.0
2018-08-07 19:42:25 -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>
2018-08-07 19:42:25 -04:00
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vmc_client">com.vmware.vmc_client module</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
2019-01-16 05:37:32 -05:00
<li class="toctree-l1"><a class="reference internal" href="vmware.html">vmware package</a></li>
2018-08-07 19:42:25 -04:00
</ul>
</div>
2018-08-07 19:42:25 -04:00
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">vmc</a>
2018-08-07 19:42:25 -04:00
</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" class="icon icon-home"></a> &raquo;</li>
2018-08-07 19:42:25 -04:00
<li><a href="com.html">com package</a> &raquo;</li>
<li><a href="com.vmware.html">com.vmware package</a> &raquo;</li>
<li><a href="com.vmware.vmc.html">com.vmware.vmc package</a> &raquo;</li>
<li>com.vmware.vmc.orgs package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/com.vmware.vmc.orgs.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.vmc.orgs">
<span id="com-vmware-vmc-orgs-package"></span><h1>com.vmware.vmc.orgs package<a class="headerlink" href="#module-com.vmware.vmc.orgs" title="Permalink to this headline"></a></h1>
<div class="section" id="subpackages">
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vmc.orgs.aws.html">com.vmware.vmc.orgs.aws package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vmc.orgs.aws.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vmc.orgs.aws.resources.html">com.vmware.vmc.orgs.aws.resources package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vmc.orgs.aws.resources.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vmc.orgs.aws.resources.html#module-com.vmware.vmc.orgs.aws.resources.servicequotas_client">com.vmware.vmc.orgs.aws.resources.servicequotas_client module</a></li>
2018-08-07 19:42:25 -04:00
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.html">com.vmware.vmc.orgs.sddcs package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.clusters.html">com.vmware.vmc.orgs.sddcs.clusters package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.clusters.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.clusters.html#module-com.vmware.vmc.orgs.sddcs.clusters.config_client">com.vmware.vmc.orgs.sddcs.clusters.config_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.clusters.html#module-com.vmware.vmc.orgs.sddcs.clusters.msft_licensing_client">com.vmware.vmc.orgs.sddcs.clusters.msft_licensing_client module</a></li>
2018-08-07 19:42:25 -04:00
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.html#submodules">Submodules</a></li>
2019-05-29 06:01:09 -04:00
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.html#module-com.vmware.vmc.orgs.sddcs.addons_client">com.vmware.vmc.orgs.sddcs.addons_client module</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.html#module-com.vmware.vmc.orgs.sddcs.clusters_client">com.vmware.vmc.orgs.sddcs.clusters_client module</a></li>
2018-08-07 19:42:25 -04:00
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.html#module-com.vmware.vmc.orgs.sddcs.dns_client">com.vmware.vmc.orgs.sddcs.dns_client module</a></li>
2019-06-04 08:24:55 -04:00
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.html#module-com.vmware.vmc.orgs.sddcs.management_vms_client">com.vmware.vmc.orgs.sddcs.management_vms_client module</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.html#module-com.vmware.vmc.orgs.sddcs.networking_client">com.vmware.vmc.orgs.sddcs.networking_client module</a></li>
2018-08-07 19:42:25 -04:00
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
2019-01-16 05:37:32 -05:00
</div>
<div class="section" id="module-com.vmware.vmc.orgs.account_link_client">
<span id="com-vmware-vmc-orgs-account-link-client-module"></span><h2>com.vmware.vmc.orgs.account_link_client module<a class="headerlink" href="#module-com.vmware.vmc.orgs.account_link_client" title="Permalink to this headline"></a></h2>
<dl class="py class">
2019-01-16 05:37:32 -05:00
<dt id="com.vmware.vmc.orgs.account_link_client.CompatibleSubnets">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.account_link_client.</code><code class="sig-name descname">CompatibleSubnets</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.account_link_client.CompatibleSubnets" title="Permalink to this definition"></a></dt>
2019-01-16 05:37:32 -05:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
2019-06-08 00:29:34 -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>
<dl class="py method">
2019-01-16 05:37:32 -05:00
<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"><span class="n">org</span></em>, <em class="sig-param"><span class="n">linked_account_id</span></em>, <em class="sig-param"><span class="n">region</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sddc</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">force_refresh</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">instance_type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sddc_type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">num_of_hosts</span><span class="o">=</span><span class="default_value">None</span></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>
2019-01-16 05:37:32 -05:00
<dd><p>Gets a customers compatible subnets for account linking</p>
2019-06-08 00:29:34 -04:00
<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>) The linked connected account identifier (required)</p></li>
2019-06-08 00:29:34 -04:00
<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
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>
2019-07-15 08:32:15 -04:00
<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>
2019-01-16 05:37:32 -05:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.AwsCompatibleSubnets" title="com.vmware.vmc.model_client.AwsCompatibleSubnets"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.AwsCompatibleSubnets</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.vmc.model.AwsCompatibleSubnets</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>
2019-01-16 05:37:32 -05:00
Unauthorized</p>
2019-06-08 00:29:34 -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>
2019-01-16 05:37:32 -05:00
Forbidden</p>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2019-01-16 05:37:32 -05:00
</dd></dl>
<dl class="py method">
2019-01-16 05:37:32 -05:00
<dt id="com.vmware.vmc.orgs.account_link_client.CompatibleSubnets.post">
<code class="sig-name descname">post</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.account_link_client.CompatibleSubnets.post" title="Permalink to this definition"></a></dt>
2019-01-16 05:37:32 -05:00
<dd><p>Sets which subnet to use to link accounts and finishes the linking
process</p>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Organization identifier (required)</p>
2019-06-08 00:29:34 -04:00
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.AwsSubnet" title="com.vmware.vmc.model_client.AwsSubnet"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.AwsSubnet</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.vmc.model.AwsSubnet</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>
</dl>
2019-01-16 05:37:32 -05:00
</dd></dl>
</dd></dl>
<dl class="py class">
2019-01-16 05:37:32 -05:00
<dt id="com.vmware.vmc.orgs.account_link_client.CompatibleSubnetsAsync">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.account_link_client.</code><code class="sig-name descname">CompatibleSubnetsAsync</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.account_link_client.CompatibleSubnetsAsync" title="Permalink to this definition"></a></dt>
2019-01-16 05:37:32 -05:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
2019-06-08 00:29:34 -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>
<dl class="py method">
2019-01-16 05:37:32 -05:00
<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"><span class="n">org</span></em>, <em class="sig-param"><span class="n">linked_account_id</span></em>, <em class="sig-param"><span class="n">region</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sddc</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">instance_type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sddc_type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">num_of_hosts</span><span class="o">=</span><span class="default_value">None</span></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>
2019-01-16 05:37:32 -05:00
<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
complete), and its documented under ref
/definitions/AwsCompatibleSubnets</p>
2019-06-08 00:29:34 -04:00
<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>) The linked connected account identifier (required)</p></li>
2019-06-08 00:29:34 -04:00
<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>
2019-07-15 08:32:15 -04:00
<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>
2019-01-16 05:37:32 -05:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#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>
<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>
2019-01-16 05:37:32 -05:00
Unauthorized</p>
2019-06-08 00:29:34 -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>
2019-01-16 05:37:32 -05:00
Forbidden</p>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2019-01-16 05:37:32 -05:00
</dd></dl>
<dl class="py method">
2019-01-16 05:37:32 -05:00
<dt id="com.vmware.vmc.orgs.account_link_client.CompatibleSubnetsAsync.post">
<code class="sig-name descname">post</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">aws_subnet</span></em>, <em class="sig-param"><span class="n">org</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.account_link_client.CompatibleSubnetsAsync.post" title="Permalink to this definition"></a></dt>
2019-01-16 05:37:32 -05:00
<dd><p>Sets which subnet to use to link accounts and finishes the linking
process via a task</p>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>aws_subnet</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.AwsSubnet" title="com.vmware.vmc.model_client.AwsSubnet"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.AwsSubnet</span></code></a>) The subnet chosen by the customer (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>
2019-01-16 05:37:32 -05:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#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>
<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>
2019-01-16 05:37:32 -05:00
Unauthorized</p>
2019-06-08 00:29:34 -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>
2019-01-16 05:37:32 -05:00
Forbidden</p>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2019-01-16 05:37:32 -05:00
</dd></dl>
</dd></dl>
<dl class="py class">
2019-01-16 05:37:32 -05:00
<dt id="com.vmware.vmc.orgs.account_link_client.ConnectedAccounts">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.account_link_client.</code><code class="sig-name descname">ConnectedAccounts</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.account_link_client.ConnectedAccounts" title="Permalink to this definition"></a></dt>
2019-01-16 05:37:32 -05:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
2019-06-08 00:29:34 -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>
<dl class="py method">
2019-01-16 05:37:32 -05:00
<dt id="com.vmware.vmc.orgs.account_link_client.ConnectedAccounts.delete">
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">linked_account_path_id</span></em>, <em class="sig-param"><span class="n">force_even_when_sddc_present</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.account_link_client.ConnectedAccounts.delete" title="Permalink to this definition"></a></dt>
2019-01-16 05:37:32 -05:00
<dd><p>Delete a particular connected (linked) account.</p>
2019-06-08 00:29:34 -04:00
<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>
2019-06-08 00:29:34 -04:00
<li><p><strong>linked_account_path_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>force_even_when_sddc_present</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, forcibly removes a connected account even when SDDCs
are still linked to it. (optional)</p></li>
2019-01-16 05:37:32 -05:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.AwsCustomerConnectedAccount" title="com.vmware.vmc.model_client.AwsCustomerConnectedAccount"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.AwsCustomerConnectedAccount</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.vmc.model.AwsCustomerConnectedAccount</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>
2019-01-16 05:37:32 -05:00
Unauthorized</p>
2019-06-08 00:29:34 -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>
2019-01-16 05:37:32 -05:00
An invalid connected account ID was specified, or the connection
still has SDDCs active on it.</p>
2019-06-08 00:29:34 -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.Unauthorized</span></code>
2019-01-16 05:37:32 -05:00
Forbidden</p>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2019-01-16 05:37:32 -05:00
</dd></dl>
<dl class="py method">
2019-01-16 05:37:32 -05:00
<dt id="com.vmware.vmc.orgs.account_link_client.ConnectedAccounts.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">provider</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.account_link_client.ConnectedAccounts.get" title="Permalink to this definition"></a></dt>
2019-01-16 05:37:32 -05:00
<dd><p>Get a list of connected accounts</p>
2019-06-08 00:29:34 -04:00
<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>
2019-06-08 00:29:34 -04:00
<li><p><strong>provider</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 cloud provider of the SDDC (AWS or ZeroCloud). Default value is
AWS. (optional)</p></li>
2019-05-29 06:01:09 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</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.html#com.vmware.vmc.model_client.AwsCustomerConnectedAccount" title="com.vmware.vmc.model_client.AwsCustomerConnectedAccount"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.AwsCustomerConnectedAccount</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>
2019-05-29 06:01:09 -04:00
Unauthorized</p>
2019-06-08 00:29:34 -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>
2019-05-29 06:01:09 -04:00
Forbidden</p>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2019-01-16 05:37:32 -05:00
</dd></dl>
</dd></dl>
<dl class="py class">
2019-01-16 05:37:32 -05:00
<dt id="com.vmware.vmc.orgs.account_link_client.MapCustomerZones">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.account_link_client.</code><code class="sig-name descname">MapCustomerZones</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.account_link_client.MapCustomerZones" title="Permalink to this definition"></a></dt>
2019-01-16 05:37:32 -05:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
2019-06-08 00:29:34 -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>
<dl class="py method">
2019-01-16 05:37:32 -05:00
<dt id="com.vmware.vmc.orgs.account_link_client.MapCustomerZones.post">
<code class="sig-name descname">post</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">map_zones_request</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.account_link_client.MapCustomerZones.post" title="Permalink to this definition"></a></dt>
2019-01-16 05:37:32 -05:00
<dd><p>Creates a task to re-map customers datacenters across zones.</p>
2019-06-08 00:29:34 -04:00
<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>
2019-06-08 00:29:34 -04:00
<li><p><strong>map_zones_request</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.MapZonesRequest" title="com.vmware.vmc.model_client.MapZonesRequest"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.MapZonesRequest</span></code></a>) The zones request information about who to map and what to map.
(required)</p></li>
2019-01-16 05:37:32 -05:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#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>
<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>
2019-01-16 05:37:32 -05:00
Unauthorized</p>
2019-06-08 00:29:34 -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>
2019-01-16 05:37:32 -05:00
Forbidden</p>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2019-01-16 05:37:32 -05:00
</dd></dl>
</dd></dl>
<dl class="py class">
2019-01-16 05:37:32 -05:00
<dt id="com.vmware.vmc.orgs.account_link_client.SddcConnections">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.account_link_client.</code><code class="sig-name descname">SddcConnections</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.account_link_client.SddcConnections" title="Permalink to this definition"></a></dt>
2019-01-16 05:37:32 -05:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
2019-06-08 00:29:34 -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>
<dl class="py method">
2019-01-16 05:37:32 -05:00
<dt id="com.vmware.vmc.orgs.account_link_client.SddcConnections.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.account_link_client.SddcConnections.get" title="Permalink to this definition"></a></dt>
2019-01-16 05:37:32 -05:00
<dd><p>Get a list of SDDC connections currently setup for the customers
organization.</p>
2019-06-08 00:29:34 -04:00
<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>
2019-06-08 00:29:34 -04:00
<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>
2019-01-16 05:37:32 -05:00
</ul>
2019-06-08 00:29:34 -04:00
</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.html#com.vmware.vmc.model_client.AwsSddcConnection" title="com.vmware.vmc.model_client.AwsSddcConnection"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.AwsSddcConnection</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>
2019-01-16 05:37:32 -05:00
Unauthorized</p>
2019-06-08 00:29:34 -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>
2019-01-16 05:37:32 -05:00
Forbidden</p>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2019-01-16 05:37:32 -05:00
</dd></dl>
</dd></dl>
<dl class="py class">
2019-01-16 05:37:32 -05:00
<dt id="com.vmware.vmc.orgs.account_link_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.account_link_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.account_link_client.StubFactory" title="Permalink to this definition"></a></dt>
2019-01-16 05:37:32 -05:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
2019-06-08 00:29:34 -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>
2019-01-16 05:37:32 -05:00
</dd></dl>
</div>
<div class="section" id="module-com.vmware.vmc.orgs.reservations_client">
<span id="com-vmware-vmc-orgs-reservations-client-module"></span><h2>com.vmware.vmc.orgs.reservations_client module<a class="headerlink" href="#module-com.vmware.vmc.orgs.reservations_client" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="com.vmware.vmc.orgs.reservations_client.Mw">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.reservations_client.</code><code class="sig-name descname">Mw</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.reservations_client.Mw" 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>
2019-06-08 00:29:34 -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>
<dl class="py method">
<dt id="com.vmware.vmc.orgs.reservations_client.Mw.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">reservation</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.reservations_client.Mw.get" title="Permalink to this definition"></a></dt>
<dd><p>get the maintenance window for this SDDC</p>
2019-06-08 00:29:34 -04:00
<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>
2019-06-08 00:29:34 -04:00
<li><p><strong>reservation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Reservation Identifier (required)</p></li>
</ul>
2019-06-08 00:29:34 -04:00
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.MaintenanceWindowGet" title="com.vmware.vmc.model_client.MaintenanceWindowGet"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.MaintenanceWindowGet</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.vmc.model.MaintenanceWindowGet</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>
2019-06-08 00:29:34 -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>
2019-01-16 05:37:32 -05:00
Access not allowed to the operation for the current user</p>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vmc.orgs.reservations_client.Mw.put">
<code class="sig-name descname">put</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">reservation</span></em>, <em class="sig-param"><span class="n">window</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.reservations_client.Mw.put" title="Permalink to this definition"></a></dt>
<dd><p>update the maintenance window for this SDDC</p>
2019-06-08 00:29:34 -04:00
<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>
2019-06-08 00:29:34 -04:00
<li><p><strong>reservation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Reservation Identifier (required)</p></li>
<li><p><strong>window</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.MaintenanceWindow" title="com.vmware.vmc.model_client.MaintenanceWindow"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.MaintenanceWindow</span></code></a>) Maintenance Window (required)</p></li>
</ul>
2019-06-08 00:29:34 -04:00
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.MaintenanceWindow" title="com.vmware.vmc.model_client.MaintenanceWindow"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.MaintenanceWindow</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.vmc.model.MaintenanceWindow</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>
2019-01-16 05:37:32 -05:00
Unauthorized</p>
2019-06-08 00:29:34 -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.ConcurrentChange</span></code>
Conflict with exiting reservation</p>
2019-06-08 00:29:34 -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.InvalidRequest</span></code>
2019-01-16 05:37:32 -05:00
The reservation is not in a state thats valid for updates</p>
2019-06-08 00:29:34 -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>
2019-01-16 05:37:32 -05:00
Access not allowed to the operation for the current user</p>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vmc.orgs.reservations_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.reservations_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.reservations_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>
2019-06-08 00:29:34 -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>
</dd></dl>
2018-08-07 19:42:25 -04:00
</div>
<div class="section" id="module-com.vmware.vmc.orgs.sddcs_client">
<span id="com-vmware-vmc-orgs-sddcs-client-module"></span><h2>com.vmware.vmc.orgs.sddcs_client module<a class="headerlink" href="#module-com.vmware.vmc.orgs.sddcs_client" title="Permalink to this headline"></a></h2>
<dl class="py class">
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs_client.Clusters">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs_client.</code><code class="sig-name descname">Clusters</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs_client.Clusters" title="Permalink to this definition"></a></dt>
2018-08-07 19:42:25 -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>
2019-06-08 00:29:34 -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>
<dl class="py method">
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs_client.Clusters.create">
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc</span></em>, <em class="sig-param"><span class="n">cluster_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs_client.Clusters.create" title="Permalink to this definition"></a></dt>
<dd><p>Creates a new cluster in customers sddcs with passed clusterConfig.</p>
2019-06-08 00:29:34 -04:00
<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>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Sddc identifier (required)</p></li>
2019-06-08 00:29:34 -04:00
<li><p><strong>cluster_config</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.ClusterConfig" title="com.vmware.vmc.model_client.ClusterConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.ClusterConfig</span></code></a>) clusterConfig (required)</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#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>
<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>
2019-01-16 05:37:32 -05:00
Unauthorized</p>
2019-06-08 00:29:34 -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>
2018-08-07 19:42:25 -04:00
The sddc is not in a state thats valid for updates</p>
2019-06-08 00:29:34 -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.Unauthorized</span></code>
2018-08-07 19:42:25 -04:00
Access not allowed to the operation for the current user</p>
2019-06-08 00:29:34 -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.NotFound</span></code>
2018-08-07 19:42:25 -04:00
Cannot find the cluster with the given identifier</p>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="py method">
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs_client.Clusters.delete">
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc</span></em>, <em class="sig-param"><span class="n">cluster</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs_client.Clusters.delete" title="Permalink to this definition"></a></dt>
2018-08-07 19:42:25 -04:00
<dd><p>This is a force operation which will delete the cluster even if there
can be a data loss. Before calling this operation, all the VMs should
be powered off.</p>
2019-06-08 00:29:34 -04:00
<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>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Sddc identifier (required)</p></li>
2019-06-08 00:29:34 -04:00
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) cluster identifier (required)</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#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>
<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>
2019-01-16 05:37:32 -05:00
Unauthorized</p>
2019-06-08 00:29:34 -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>
2018-08-07 19:42:25 -04:00
The sddc is not in a state thats valid for updates</p>
2019-06-08 00:29:34 -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.Unauthorized</span></code>
2018-08-07 19:42:25 -04:00
Access not allowed to the operation for the current user</p>
2019-06-08 00:29:34 -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.NotFound</span></code>
2018-08-07 19:42:25 -04:00
Cannot find the cluster with the given id</p>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
</dd></dl>
<dl class="py class">
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs_client.Convert">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs_client.</code><code class="sig-name descname">Convert</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs_client.Convert" title="Permalink to this definition"></a></dt>
2018-08-07 19:42:25 -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>
2019-06-08 00:29:34 -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>
<dl class="py method">
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs_client.Convert.create">
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs_client.Convert.create" title="Permalink to this definition"></a></dt>
2018-08-07 19:42:25 -04:00
<dd><p>This API converts a one host SDDC to a four node DEFAULT SDDC. It takes
care of configuring and upgrading the vCenter configurations on the
SDDC for high availability and data redundancy.</p>
2019-06-08 00:29:34 -04:00
<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>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Sddc identifier (required)</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#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>
<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>
2019-01-16 05:37:32 -05:00
Unauthorized</p>
2019-06-08 00:29:34 -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>
2018-08-07 19:42:25 -04:00
The sddc is not in a state thats valid for updates, Method not
allowed</p>
2019-06-08 00:29:34 -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.Unauthorized</span></code>
2018-08-07 19:42:25 -04:00
Access not allowed to the operation for the current user</p>
2019-06-08 00:29:34 -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.NotFound</span></code>
2018-08-07 19:42:25 -04:00
Cannot find the SDDC with given identifier</p>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
</dd></dl>
<dl class="py class">
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs_client.Esxs">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs_client.</code><code class="sig-name descname">Esxs</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs_client.Esxs" title="Permalink to this definition"></a></dt>
2018-08-07 19:42:25 -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>
2019-06-08 00:29:34 -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>
<dl class="py method">
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs_client.Esxs.create">
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc</span></em>, <em class="sig-param"><span class="n">esx_config</span></em>, <em class="sig-param"><span class="n">action</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs_client.Esxs.create" title="Permalink to this definition"></a></dt>
2018-08-07 19:42:25 -04:00
<dd><p>Add/Remove one or more ESX hosts in the target cloud</p>
2019-06-08 00:29:34 -04:00
<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>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Sddc identifier (required)</p></li>
2019-06-08 00:29:34 -04:00
<li><p><strong>esx_config</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.EsxConfig" title="com.vmware.vmc.model_client.EsxConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.EsxConfig</span></code></a>) esxConfig (required)</p></li>
<li><p><strong>action</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>) If = add, will add the esx. If = remove, will delete the
2018-08-07 19:42:25 -04:00
esx/esxs bound to a single cluster (Cluster Id is mandatory for non
cluster 1 esx remove). If = force-remove, will delete the esx
even if it can lead to data loss (This is an privileged operation).
If = addToAll, will add esxs to all clusters in the SDDC (This is
an privileged operation). If = removeFromAll, will delete the
esxs from all clusters in the SDDC (This is an privileged
2019-05-29 06:01:09 -04:00
operation). If = attach-diskgroup, will attach the provided
2019-07-04 06:14:34 -04:00
diskgroups to a given host (privileged). If = detach-diskgroup,
will detach the diskgroups of a given host (privileged). Default
behaviour is add (optional)</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#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>
<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>
2019-01-16 05:37:32 -05:00
Unauthorized</p>
2019-06-08 00:29:34 -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>
2018-08-07 19:42:25 -04:00
The sddc is not in a state thats valid for updates</p>
2019-06-08 00:29:34 -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.Unauthorized</span></code>
2018-08-07 19:42:25 -04:00
Access not allowed to the operation for the current user</p>
2019-06-08 00:29:34 -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.NotFound</span></code>
2018-08-07 19:42:25 -04:00
Cannot find the SDDC with the given identifier</p>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vmc.orgs.sddcs_client.Primarycluster">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs_client.</code><code class="sig-name descname">Primarycluster</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs_client.Primarycluster" title="Permalink to this definition"></a></dt>
2018-08-07 19:42:25 -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>
2019-06-08 00:29:34 -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>
<dl class="py method">
<dt id="com.vmware.vmc.orgs.sddcs_client.Primarycluster.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs_client.Primarycluster.get" title="Permalink to this definition"></a></dt>
<dd><p>Retrieves the primary cluster in provided customer sddc UUID</p>
2019-06-08 00:29:34 -04:00
<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>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Sddc identifier (required)</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.Cluster" title="com.vmware.vmc.model_client.Cluster"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Cluster</span></code></a></p>
2019-06-08 00:29:34 -04:00
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.vmc.model.Cluster</p>
2019-06-08 00:29:34 -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.Unauthenticated</span></code>
2019-01-16 05:37:32 -05:00
Unauthorized</p>
2019-06-08 00:29:34 -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>
The sddc is not in a state thats valid for fetching the primary
cluster.</p>
2019-06-08 00:29:34 -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.Unauthorized</span></code>
2018-08-07 19:42:25 -04:00
Access not allowed to the operation for the current user</p>
2019-06-08 00:29:34 -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.NotFound</span></code>
Cannot find the sddc with the given identifier to fetch the primary
cluster</p>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vmc.orgs.sddcs_client.ProvisionSpec">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs_client.</code><code class="sig-name descname">ProvisionSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs_client.ProvisionSpec" 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>
2019-06-08 00:29:34 -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>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
<dl class="py method">
<dt id="com.vmware.vmc.orgs.sddcs_client.ProvisionSpec.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs_client.ProvisionSpec.get" title="Permalink to this definition"></a></dt>
<dd><p>Get sddc provision spec for an org</p>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Organization identifier (required)</p>
2019-06-08 00:29:34 -04:00
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.ProvisionSpec" title="com.vmware.vmc.model_client.ProvisionSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.ProvisionSpec</span></code></a></p>
2019-06-08 00:29:34 -04:00
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.vmc.model.ProvisionSpec</p>
2019-06-08 00:29:34 -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.Unauthenticated</span></code>
2019-01-16 05:37:32 -05:00
Unauthorized</p>
2019-06-08 00:29:34 -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>
BadRequest</p>
2019-06-08 00:29:34 -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.Unauthorized</span></code>
Forbidden</p>
2019-06-08 00:29:34 -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.InternalServerError</span></code>
Internal server error.</p>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
</dd></dl>
<dl class="py class">
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs_client.SddcTemplate">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs_client.</code><code class="sig-name descname">SddcTemplate</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs_client.SddcTemplate" title="Permalink to this definition"></a></dt>
2018-08-07 19:42:25 -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>
2019-06-08 00:29:34 -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>
<dl class="py method">
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs_client.SddcTemplate.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs_client.SddcTemplate.get" title="Permalink to this definition"></a></dt>
2018-08-07 19:42:25 -04:00
<dd><p>Get configuration template for an SDDC</p>
2019-06-08 00:29:34 -04:00
<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>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Sddc identifier (required)</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.SddcTemplate" title="com.vmware.vmc.model_client.SddcTemplate"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.SddcTemplate</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.vmc.model.SddcTemplate</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>
2019-01-16 05:37:32 -05:00
Unauthorized</p>
2019-06-08 00:29:34 -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>
2018-08-07 19:42:25 -04:00
SDDC is in a state that cannot be use for generating configuration
template</p>
2019-06-08 00:29:34 -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.Unauthorized</span></code>
2018-08-07 19:42:25 -04:00
Forbidden</p>
2019-06-08 00:29:34 -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.NotFound</span></code>
2018-08-07 19:42:25 -04:00
Cannot find the SDDC with given identifier</p>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2019-01-16 05:37:32 -05:00
</dd></dl>
</dd></dl>
<dl class="py class">
2019-01-16 05:37:32 -05:00
<dt id="com.vmware.vmc.orgs.sddcs_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs_client.StubFactory" title="Permalink to this definition"></a></dt>
2019-01-16 05:37:32 -05:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
2019-06-08 00:29:34 -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>
2019-01-16 05:37:32 -05:00
</dd></dl>
</div>
<div class="section" id="module-com.vmware.vmc.orgs.storage_client">
<span id="com-vmware-vmc-orgs-storage-client-module"></span><h2>com.vmware.vmc.orgs.storage_client module<a class="headerlink" href="#module-com.vmware.vmc.orgs.storage_client" title="Permalink to this headline"></a></h2>
<dl class="py class">
2019-01-16 05:37:32 -05:00
<dt id="com.vmware.vmc.orgs.storage_client.ClusterConstraints">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.storage_client.</code><code class="sig-name descname">ClusterConstraints</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.storage_client.ClusterConstraints" title="Permalink to this definition"></a></dt>
2019-01-16 05:37:32 -05:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
2019-06-08 00:29:34 -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>
<dl class="py method">
2019-01-16 05:37:32 -05:00
<dt id="com.vmware.vmc.orgs.storage_client.ClusterConstraints.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">provider</span></em>, <em class="sig-param"><span class="n">num_hosts</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.storage_client.ClusterConstraints.get" title="Permalink to this definition"></a></dt>
2019-01-16 05:37:32 -05:00
<dd><p>Get constraints on cluster storage size for EBS-backed clusters.</p>
2019-06-08 00:29:34 -04:00
<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>
2019-06-08 00:29:34 -04:00
<li><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Cloud storage provider ID (example AWS) (required)</p></li>
<li><p><strong>num_hosts</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) Number of hosts in cluster (required)</p></li>
2019-01-16 05:37:32 -05:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.VsanConfigConstraints" title="com.vmware.vmc.model_client.VsanConfigConstraints"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.VsanConfigConstraints</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.vmc.model.VsanConfigConstraints</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>
2018-08-07 19:42:25 -04:00
Unauthorized</p>
2019-06-08 00:29:34 -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>
2019-01-16 05:37:32 -05:00
Invalid or missing parameters</p>
2019-06-08 00:29:34 -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.Unauthorized</span></code>
2019-01-16 05:37:32 -05:00
Forbidden</p>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
</dd></dl>
<dl class="py class">
2019-01-16 05:37:32 -05:00
<dt id="com.vmware.vmc.orgs.storage_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.storage_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.storage_client.StubFactory" title="Permalink to this definition"></a></dt>
2019-01-16 05:37:32 -05:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
2019-06-08 00:29:34 -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>
2019-01-16 05:37:32 -05:00
</dd></dl>
</div>
<div class="section" id="module-com.vmware.vmc.orgs.subscriptions_client">
<span id="com-vmware-vmc-orgs-subscriptions-client-module"></span><h2>com.vmware.vmc.orgs.subscriptions_client module<a class="headerlink" href="#module-com.vmware.vmc.orgs.subscriptions_client" title="Permalink to this headline"></a></h2>
<dl class="py class">
2019-01-16 05:37:32 -05:00
<dt id="com.vmware.vmc.orgs.subscriptions_client.OfferInstances">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.subscriptions_client.</code><code class="sig-name descname">OfferInstances</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.subscriptions_client.OfferInstances" title="Permalink to this definition"></a></dt>
2019-01-16 05:37:32 -05:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
2019-06-08 00:29:34 -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>
<dl class="py method">
2019-01-16 05:37:32 -05:00
<dt id="com.vmware.vmc.orgs.subscriptions_client.OfferInstances.list">
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">region</span></em>, <em class="sig-param"><span class="n">product_type</span></em>, <em class="sig-param"><span class="n">product</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">type</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.subscriptions_client.OfferInstances.list" title="Permalink to this definition"></a></dt>
2019-01-16 05:37:32 -05:00
<dd><p>List all offers available for the specific product type in the specific
region</p>
2019-06-08 00:29:34 -04:00
<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>
2019-06-08 00:29:34 -04:00
<li><p><strong>region</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Region for the offer (required)</p></li>
<li><p><strong>product_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Type of the product in offers. *This has been deprecated*. Please
use product &amp; type parameters (required)</p></li>
<li><p><strong>product</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 product that you are trying to purchase, eg. host. This needs
to be accompanied by the type parameter (optional)</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>) The type/flavor of the product you are trying it purchase,eg. an
\`r5.metal\` host. This needs to be accompanied by the
2019-06-08 00:29:34 -04:00
product parameter. (optional)</p></li>
2019-01-16 05:37:32 -05:00
</ul>
2019-06-08 00:29:34 -04:00
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.OfferInstancesHolder" title="com.vmware.vmc.model_client.OfferInstancesHolder"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.OfferInstancesHolder</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.vmc.model.OfferInstancesHolder</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>
2019-01-16 05:37:32 -05:00
Unauthorized</p>
2019-06-08 00:29:34 -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>
2019-01-16 05:37:32 -05:00
Bad Request. Type of the product not supported.</p>
2019-06-08 00:29:34 -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.Unauthorized</span></code>
2019-01-16 05:37:32 -05:00
Forbidden</p>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
2019-01-16 05:37:32 -05:00
</dd></dl>
</dd></dl>
<dl class="py class">
2019-01-16 05:37:32 -05:00
<dt id="com.vmware.vmc.orgs.subscriptions_client.Products">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.subscriptions_client.</code><code class="sig-name descname">Products</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.subscriptions_client.Products" title="Permalink to this definition"></a></dt>
2019-01-16 05:37:32 -05:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
2019-06-08 00:29:34 -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>
<dl class="py method">
2019-01-16 05:37:32 -05:00
<dt id="com.vmware.vmc.orgs.subscriptions_client.Products.list">
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.subscriptions_client.Products.list" title="Permalink to this definition"></a></dt>
2019-01-16 05:37:32 -05:00
<dd><p>List of all the products that are available for purchase.</p>
2019-06-08 00:29:34 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Organization identifier (required)</p>
2019-06-08 00:29:34 -04:00
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vmc.orgs.subscriptions_client.Products.list" title="com.vmware.vmc.orgs.subscriptions_client.Products.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.SubscriptionProducts" title="com.vmware.vmc.model_client.SubscriptionProducts"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.SubscriptionProducts</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.InternalServerError</span></code>
Internal server error</p>
</dd>
</dl>
2019-01-16 05:37:32 -05:00
</dd></dl>
</dd></dl>
<dl class="py class">
2019-01-16 05:37:32 -05:00
<dt id="com.vmware.vmc.orgs.subscriptions_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.subscriptions_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.subscriptions_client.StubFactory" title="Permalink to this definition"></a></dt>
2018-08-07 19:42:25 -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>
2019-06-08 00:29:34 -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>
2018-08-07 19:42:25 -04:00
</dd></dl>
</div>
<div class="section" id="module-com.vmware.vmc.orgs.tbrs_client">
<span id="com-vmware-vmc-orgs-tbrs-client-module"></span><h2>com.vmware.vmc.orgs.tbrs_client module<a class="headerlink" href="#module-com.vmware.vmc.orgs.tbrs_client" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="com.vmware.vmc.orgs.tbrs_client.Reservation">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.tbrs_client.</code><code class="sig-name descname">Reservation</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.tbrs_client.Reservation" 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>
2019-06-08 00:29:34 -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>
<dl class="py method">
<dt id="com.vmware.vmc.orgs.tbrs_client.Reservation.post">
<code class="sig-name descname">post</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc_state</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.tbrs_client.Reservation.post" title="Permalink to this definition"></a></dt>
<dd><p>Retreive all reservations for all SDDCs in this org</p>
2019-06-08 00:29:34 -04:00
<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>
2019-06-08 00:29:34 -04:00
<li><p><strong>sddc_state</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.SddcStateRequest" title="com.vmware.vmc.model_client.SddcStateRequest"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.SddcStateRequest</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) SDDCs and/or states to query (optional)</p></li>
</ul>
2019-06-08 00:29:34 -04:00
</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">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 <a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.ReservationWindow" title="com.vmware.vmc.model_client.ReservationWindow"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.ReservationWindow</span></code></a></p>
2019-06-08 00:29:34 -04:00
</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>
2019-01-16 05:37:32 -05:00
Unauthorized</p>
2019-06-08 00:29:34 -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>
2019-01-16 05:37:32 -05:00
Bad Call</p>
2019-06-08 00:29:34 -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.Unauthorized</span></code>
2019-01-16 05:37:32 -05:00
Forbidden</p>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vmc.orgs.tbrs_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.tbrs_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.tbrs_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>
2019-06-08 00:29:34 -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>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vmc.orgs.tbrs_client.SupportWindow">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.tbrs_client.</code><code class="sig-name descname">SupportWindow</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.tbrs_client.SupportWindow" 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>
2019-06-08 00:29:34 -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>
<dl class="py method">
<dt id="com.vmware.vmc.orgs.tbrs_client.SupportWindow.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">minimum_seats_available</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">created_by</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.tbrs_client.SupportWindow.get" title="Permalink to this definition"></a></dt>
<dd><p>Get all available support windows</p>
2019-06-08 00:29:34 -04:00
<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>
2019-06-08 00:29:34 -04:00
<li><p><strong>minimum_seats_available</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>) minimum seats available (used as a filter) (optional)</p></li>
<li><p><strong>created_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>) user name which was used to create the support window (used as a
filter) (optional)</p></li>
2019-05-29 06:01:09 -04:00
</ul>
2019-06-08 00:29:34 -04:00
</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.html#com.vmware.vmc.model_client.SupportWindow" title="com.vmware.vmc.model_client.SupportWindow"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.SupportWindow</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>
2019-05-29 06:01:09 -04:00
Unauthorized</p>
2019-06-08 00:29:34 -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>
2019-05-29 06:01:09 -04:00
Invalid request</p>
2019-06-08 00:29:34 -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.Unauthorized</span></code>
2019-05-29 06:01:09 -04:00
Forbidden</p>
2019-06-08 00:29:34 -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.NotFound</span></code>
2019-05-29 06:01:09 -04:00
No support windows are available</p>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vmc.orgs.tbrs_client.SupportWindow.put">
<code class="sig-name descname">put</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">id</span></em>, <em class="sig-param"><span class="n">sddc_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.tbrs_client.SupportWindow.put" title="Permalink to this definition"></a></dt>
<dd><p>Move Sddc to new support window</p>
2019-06-08 00:29:34 -04:00
<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>
2019-06-08 00:29:34 -04:00
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Target Support Window ID (required)</p></li>
<li><p><strong>sddc_id</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.SddcId" title="com.vmware.vmc.model_client.SddcId"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.SddcId</span></code></a>) SDDC to move (required)</p></li>
</ul>
2019-06-08 00:29:34 -04:00
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.SupportWindowId" title="com.vmware.vmc.model_client.SupportWindowId"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.SupportWindowId</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.vmc.model.SupportWindowId</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>
2019-01-16 05:37:32 -05:00
Unauthorized</p>
2019-06-08 00:29:34 -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>
Invalid request</p>
2019-06-08 00:29:34 -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.Unauthorized</span></code>
Forbidden</p>
2019-06-08 00:29:34 -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.NotFound</span></code>
Feature does not exist</p>
2019-06-08 00:29:34 -04:00
</dd>
</dl>
</dd></dl>
</dd></dl>
2018-08-07 19:42:25 -04:00
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="com.vmware.vmc.orgs.aws.html" class="btn btn-neutral float-right" title="com.vmware.vmc.orgs.aws package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
2018-08-07 19:42:25 -04:00
2019-05-29 06:01:09 -04:00
<a href="com.vmware.vmc.html" class="btn btn-neutral float-left" title="com.vmware.vmc package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
2018-08-07 19:42:25 -04:00
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2020, VMware, Inc.
2018-08-07 19:42:25 -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>.
2018-08-07 19:42:25 -04:00
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
2019-05-29 06:01:09 -04:00
</script>
2018-08-07 19:42:25 -04:00
</body>
</html>