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

748 lines
49 KiB
HTML
Raw Normal View History

add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
<!DOCTYPE html>
Updating latest python vmc doc (a71f566)
2020-09-11 09:36:05 -04:00
<html class="writer-html5" lang="en" >
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
Updating latest python vmc doc (9e1e768)
2020-11-09 23:31:11 -05:00
<title>com.vmware.vmc.orgs.sddcs package &mdash; vmc 1.30.0 documentation</title>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
Updating latest python vmc doc (a71f566)
2020-09-11 09:36:05 -04:00
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
Updating latest python vmc doc (a71f566)
2020-09-11 09:36:05 -04:00
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
reverting vmc docs changes
2019-04-17 00:48:58 -04:00
Updated python vmc binding & docs
2019-04-15 06:06:35 -04:00
Updating latest python vmc docs
2019-05-29 06:01:09 -04:00
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
Updating latest python vmc doc (db99048)
2020-02-11 05:55:07 -05:00
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
Updating latest python vmc docs
2019-05-29 06:01:09 -04:00
<script type="text/javascript" src="_static/js/theme.js"></script>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
Updating latest python vmc docs
2019-05-29 06:01:09 -04:00
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
Updating latest python vmc doc (5e04e9f)
2019-11-20 00:04:03 -05:00
<link rel="next" title="com.vmware.vmc.orgs.sddcs.clusters package" href="com.vmware.vmc.orgs.sddcs.clusters.html" />
Updating latest python vmc doc (a71f566)
2020-09-11 09:36:05 -04:00
<link rel="prev" title="com.vmware.vmc.orgs.aws.resources package" href="com.vmware.vmc.orgs.aws.resources.html" />
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
</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">
Updating latest python vmc docs
2019-05-29 06:01:09 -04:00
<div class="wy-side-nav-search" >
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
Updating latest python vmc doc (a71f566)
2020-09-11 09:36:05 -04:00
<a href="index.html" class="icon icon-home" alt="Documentation Home"> vmc
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
</a>
<div class="version">
Updating latest python vmc doc (9e1e768)
2020-11-09 23:31:11 -05:00
1.30.0
add vsphere, vmc and nsx API docs
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>
Updating latest python vmc doc (a71f566)
2020-09-11 09:36:05 -04:00
add vsphere, vmc and nsx API docs
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>
update vmc doc for new binding 1.3.1
2019-01-16 05:37:32 -05:00
<li class="toctree-l1"><a class="reference internal" href="vmware.html">vmware package</a></li>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
</ul>
</div>
Updating latest python vmc doc (a71f566)
2020-09-11 09:36:05 -04:00
add vsphere, vmc and nsx API docs
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>
Updating latest python vmc doc (1cff1a3)
2019-10-16 07:29:13 -04:00
<a href="index.html">vmc</a>
add vsphere, vmc and nsx API docs
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">
Updating latest python vmc doc (a71f566)
2020-09-11 09:36:05 -04:00
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
add vsphere, vmc and nsx API docs
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><a href="com.vmware.vmc.orgs.html">com.vmware.vmc.orgs package</a> &raquo;</li>
<li>com.vmware.vmc.orgs.sddcs package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/com.vmware.vmc.orgs.sddcs.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.sddcs">
<span id="com-vmware-vmc-orgs-sddcs-package"></span><h1>com.vmware.vmc.orgs.sddcs package<a class="headerlink" href="#module-com.vmware.vmc.orgs.sddcs" 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>
Updating latest python vmc doc (5e04e9f)
2019-11-20 00:04:03 -05:00
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.clusters.html">com.vmware.vmc.orgs.sddcs.clusters package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.clusters.html#submodules">Submodules</a></li>
<li class="toctree-l2"><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>
Updating latest python vmc doc (9e1e768)
2020-11-09 23:31:11 -05:00
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.clusters.html#module-com.vmware.vmc.orgs.sddcs.clusters.esxs_client">com.vmware.vmc.orgs.sddcs.clusters.esxs_client module</a></li>
Updating latest python vmc doc (a71f566)
2020-09-11 09:36:05 -04:00
<li class="toctree-l2"><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>
add vsphere, vmc and nsx API docs
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>
Updating latest python vmc docs
2019-05-29 06:01:09 -04:00
</div>
<div class="section" id="module-com.vmware.vmc.orgs.sddcs.addons_client">
<span id="com-vmware-vmc-orgs-sddcs-addons-client-module"></span><h2>com.vmware.vmc.orgs.sddcs.addons_client module<a class="headerlink" href="#module-com.vmware.vmc.orgs.sddcs.addons_client" title="Permalink to this headline"></a></h2>
Updating latest python vmc doc (ed06abd)
2020-05-15 16:54:03 -04:00
<dl class="py class">
Updating latest python vmc docs
2019-05-29 06:01:09 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.addons_client.Credentials">
Updating latest python vmc doc (ed06abd)
2020-05-15 16:54:03 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs.addons_client.</code><code class="sig-name descname">Credentials</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.addons_client.Credentials" title="Permalink to this definition"></a></dt>
Updating latest python vmc docs
2019-05-29 06:01:09 -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>
Updating latest python vmc docs
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>
Updating latest python vmc doc (ed06abd)
2020-05-15 16:54:03 -04:00
<dl class="py attribute">
Updating latest python vmc docs
2019-05-29 06:01:09 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.addons_client.Credentials.CREATE_ADDON_TYPE_HCX">
Updating latest python vmc docs
2019-06-08 00:29:34 -04:00
<code class="sig-name descname">CREATE_ADDON_TYPE_HCX</code><em class="property"> = 'HCX'</em><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.addons_client.Credentials.CREATE_ADDON_TYPE_HCX" title="Permalink to this definition"></a></dt>
Updating latest python vmc docs
2019-05-29 06:01:09 -04:00
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">addonType</span></code> of method <a class="reference internal" href="#com.vmware.vmc.orgs.sddcs.addons_client.Credentials.create" title="com.vmware.vmc.orgs.sddcs.addons_client.Credentials.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">Credentials.create()</span></code></a>.</p>
</dd></dl>
Updating latest python vmc doc (ed06abd)
2020-05-15 16:54:03 -04:00
<dl class="py attribute">
Updating latest python vmc docs
2019-05-29 06:01:09 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.addons_client.Credentials.GET_ADDON_TYPE_HCX">
Updating latest python vmc docs
2019-06-08 00:29:34 -04:00
<code class="sig-name descname">GET_ADDON_TYPE_HCX</code><em class="property"> = 'HCX'</em><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.addons_client.Credentials.GET_ADDON_TYPE_HCX" title="Permalink to this definition"></a></dt>
Updating latest python vmc docs
2019-05-29 06:01:09 -04:00
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">addonType</span></code> of method <a class="reference internal" href="#com.vmware.vmc.orgs.sddcs.addons_client.Credentials.get" title="com.vmware.vmc.orgs.sddcs.addons_client.Credentials.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">Credentials.get()</span></code></a>.</p>
</dd></dl>
Updating latest python vmc doc (ed06abd)
2020-05-15 16:54:03 -04:00
<dl class="py attribute">
Updating latest python vmc docs
2019-05-29 06:01:09 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.addons_client.Credentials.LIST_ADDON_TYPE_HCX">
Updating latest python vmc docs
2019-06-08 00:29:34 -04:00
<code class="sig-name descname">LIST_ADDON_TYPE_HCX</code><em class="property"> = 'HCX'</em><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.addons_client.Credentials.LIST_ADDON_TYPE_HCX" title="Permalink to this definition"></a></dt>
Updating latest python vmc docs
2019-05-29 06:01:09 -04:00
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">addonType</span></code> of method <a class="reference internal" href="#com.vmware.vmc.orgs.sddcs.addons_client.Credentials.list" title="com.vmware.vmc.orgs.sddcs.addons_client.Credentials.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Credentials.list()</span></code></a>.</p>
</dd></dl>
Updating latest python vmc doc (ed06abd)
2020-05-15 16:54:03 -04:00
<dl class="py attribute">
Updating latest python vmc docs
2019-05-29 06:01:09 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.addons_client.Credentials.UPDATE_ADDON_TYPE_HCX">
Updating latest python vmc docs
2019-06-08 00:29:34 -04:00
<code class="sig-name descname">UPDATE_ADDON_TYPE_HCX</code><em class="property"> = 'HCX'</em><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.addons_client.Credentials.UPDATE_ADDON_TYPE_HCX" title="Permalink to this definition"></a></dt>
Updating latest python vmc docs
2019-05-29 06:01:09 -04:00
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">addonType</span></code> of method <a class="reference internal" href="#com.vmware.vmc.orgs.sddcs.addons_client.Credentials.update" title="com.vmware.vmc.orgs.sddcs.addons_client.Credentials.update"><code class="xref py py-func docutils literal notranslate"><span class="pre">Credentials.update()</span></code></a>.</p>
</dd></dl>
Updating latest python vmc doc (ed06abd)
2020-05-15 16:54:03 -04:00
<dl class="py method">
Updating latest python vmc docs
2019-05-29 06:01:09 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.addons_client.Credentials.create">
Updating latest python vmc doc (ed06abd)
2020-05-15 16:54:03 -04:00
<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_id</span></em>, <em class="sig-param"><span class="n">addon_type</span></em>, <em class="sig-param"><span class="n">credentials</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.addons_client.Credentials.create" title="Permalink to this definition"></a></dt>
Updating latest python vmc docs
2019-05-29 06:01:09 -04:00
<dd><p>Associated a new add on credentials with the SDDC such as HCX</p>
Updating latest python vmc docs
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>) – Org id of the associated SDDC (required)</p></li>
<li><p><strong>sddc_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Id of the SDDC (required)</p></li>
<li><p><strong>addon_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Add on type (required)</p></li>
<li><p><strong>credentials</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.NewCredentials" title="com.vmware.vmc.model_client.NewCredentials"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.NewCredentials</span></code></a>) – Credentials creation payload (required)</p></li>
Updating latest python vmc docs
2019-05-29 06:01:09 -04:00
</ul>
Updating latest python vmc docs
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.NewCredentials" title="com.vmware.vmc.model_client.NewCredentials"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.NewCredentials</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.vmc.model.NewCredentials</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.ConcurrentChange</span></code>
Updating latest python vmc docs
2019-05-29 06:01:09 -04:00
Credentials with same name exists with in the scope of addOnType</p>
Updating latest python vmc docs
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>
Updating latest python vmc docs
2019-05-29 06:01:09 -04:00
Invalid input</p>
Updating latest python vmc docs
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>
Updating latest python vmc docs
2019-05-29 06:01:09 -04:00
Forbidden</p>
Updating latest python vmc docs
2019-06-08 00:29:34 -04:00
</dd>
</dl>
Updating latest python vmc docs
2019-05-29 06:01:09 -04:00
</dd></dl>
Updating latest python vmc doc (ed06abd)
2020-05-15 16:54:03 -04:00
<dl class="py method">
Updating latest python vmc docs
2019-05-29 06:01:09 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.addons_client.Credentials.get">
Updating latest python vmc doc (ed06abd)
2020-05-15 16:54:03 -04:00
<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_id</span></em>, <em class="sig-param"><span class="n">addon_type</span></em>, <em class="sig-param"><span class="n">name</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.addons_client.Credentials.get" title="Permalink to this definition"></a></dt>
Updating latest python vmc docs
2019-05-29 06:01:09 -04:00
<dd><p>Get credential details by name</p>
Updating latest python vmc docs
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>) – Org id of the associated SDDC (required)</p></li>
<li><p><strong>sddc_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Id of the SDDC (required)</p></li>
<li><p><strong>addon_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Add on type (required)</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – name of the credentials (required)</p></li>
Updating latest python vmc docs
2019-05-29 06:01:09 -04:00
</ul>
Updating latest python vmc docs
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.NewCredentials" title="com.vmware.vmc.model_client.NewCredentials"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.NewCredentials</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.vmc.model.NewCredentials</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.Unauthorized</span></code>
Updating latest python vmc docs
2019-05-29 06:01:09 -04:00
Forbidden</p>
Updating latest python vmc docs
2019-06-08 00:29:34 -04:00
</dd>
</dl>
Updating latest python vmc docs
2019-05-29 06:01:09 -04:00
</dd></dl>
Updating latest python vmc doc (ed06abd)
2020-05-15 16:54:03 -04:00
<dl class="py method">
Updating latest python vmc docs
2019-05-29 06:01:09 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.addons_client.Credentials.list">
Updating latest python vmc doc (ed06abd)
2020-05-15 16:54:03 -04:00
<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">sddc_id</span></em>, <em class="sig-param"><span class="n">addon_type</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.addons_client.Credentials.list" title="Permalink to this definition"></a></dt>
Updating latest python vmc docs
2019-05-29 06:01:09 -04:00
<dd><p>List all the credentials assoicated with an addon type with in a SDDC</p>
Updating latest python vmc docs
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>) – Org id of the associated SDDC (required)</p></li>
<li><p><strong>sddc_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Id of the SDDC (required)</p></li>
<li><p><strong>addon_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Add on type (required)</p></li>
Updating latest python vmc docs
2019-05-29 06:01:09 -04:00
</ul>
Updating latest python vmc docs
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.sddcs.addons_client.Credentials.list" title="com.vmware.vmc.orgs.sddcs.addons_client.Credentials.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.NewCredentials" title="com.vmware.vmc.model_client.NewCredentials"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.NewCredentials</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.Unauthorized</span></code>
Updating latest python vmc docs
2019-05-29 06:01:09 -04:00
Forbidden</p>
Updating latest python vmc docs
2019-06-08 00:29:34 -04:00
</dd>
</dl>
Updating latest python vmc docs
2019-05-29 06:01:09 -04:00
</dd></dl>
Updating latest python vmc doc (ed06abd)
2020-05-15 16:54:03 -04:00
<dl class="py method">
Updating latest python vmc docs
2019-05-29 06:01:09 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.addons_client.Credentials.update">
Updating latest python vmc doc (ed06abd)
2020-05-15 16:54:03 -04:00
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc_id</span></em>, <em class="sig-param"><span class="n">addon_type</span></em>, <em class="sig-param"><span class="n">name</span></em>, <em class="sig-param"><span class="n">credentials</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.addons_client.Credentials.update" title="Permalink to this definition"></a></dt>
Updating latest python vmc docs
2019-05-29 06:01:09 -04:00
<dd><p>Update credential details</p>
Updating latest python vmc docs
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>) – Org id of the associated SDDC (required)</p></li>
<li><p><strong>sddc_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Id of the SDDC (required)</p></li>
<li><p><strong>addon_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Add on type (required)</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – name of the credentials (required)</p></li>
<li><p><strong>credentials</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.UpdateCredentials" title="com.vmware.vmc.model_client.UpdateCredentials"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.UpdateCredentials</span></code></a>) – Credentials update payload (required)</p></li>
Updating latest python vmc docs
2019-05-29 06:01:09 -04:00
</ul>
Updating latest python vmc docs
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.NewCredentials" title="com.vmware.vmc.model_client.NewCredentials"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.NewCredentials</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.vmc.model.NewCredentials</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.InvalidRequest</span></code>
Updating latest python vmc docs
2019-05-29 06:01:09 -04:00
Bad request</p>
Updating latest python vmc docs
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>
Updating latest python vmc docs
2019-05-29 06:01:09 -04:00
Forbidden</p>
Updating latest python vmc docs
2019-06-08 00:29:34 -04:00
</dd>
</dl>
Updating latest python vmc docs
2019-05-29 06:01:09 -04:00
</dd></dl>
</dd></dl>
Updating latest python vmc doc (ed06abd)
2020-05-15 16:54:03 -04:00
<dl class="py class">
Updating latest python vmc docs
2019-05-29 06:01:09 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.addons_client.StubFactory">
Updating latest python vmc doc (ed06abd)
2020-05-15 16:54:03 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs.addons_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.addons_client.StubFactory" title="Permalink to this definition"></a></dt>
Updating latest python vmc docs
2019-05-29 06:01:09 -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>
Updating latest python vmc docs
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>
Updating latest python vmc docs
2019-05-29 06:01:09 -04:00
</dd></dl>
Updating latest python vmc doc (5e04e9f)
2019-11-20 00:04:03 -05:00
</div>
<div class="section" id="module-com.vmware.vmc.orgs.sddcs.clusters_client">
<span id="com-vmware-vmc-orgs-sddcs-clusters-client-module"></span><h2>com.vmware.vmc.orgs.sddcs.clusters_client module<a class="headerlink" href="#module-com.vmware.vmc.orgs.sddcs.clusters_client" title="Permalink to this headline"></a></h2>
Updating latest python vmc doc (ed06abd)
2020-05-15 16:54:03 -04:00
<dl class="py class">
Updating latest python vmc doc (5e04e9f)
2019-11-20 00:04:03 -05:00
<dt id="com.vmware.vmc.orgs.sddcs.clusters_client.Reconfigure">
Updating latest python vmc doc (ed06abd)
2020-05-15 16:54:03 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs.clusters_client.</code><code class="sig-name descname">Reconfigure</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.clusters_client.Reconfigure" title="Permalink to this definition"></a></dt>
Updating latest python vmc doc (5e04e9f)
2019-11-20 00:04:03 -05:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
Updating latest python vmc doc (ed06abd)
2020-05-15 16:54:03 -04:00
<dl class="py method">
Updating latest python vmc doc (5e04e9f)
2019-11-20 00:04:03 -05:00
<dt id="com.vmware.vmc.orgs.sddcs.clusters_client.Reconfigure.cluster_reconfig">
Updating latest python vmc doc (ed06abd)
2020-05-15 16:54:03 -04:00
<code class="sig-name descname">cluster_reconfig</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>, <em class="sig-param"><span class="n">cluster_reconfigure_params</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.clusters_client.Reconfigure.cluster_reconfig" title="Permalink to this definition"></a></dt>
Updating latest python vmc doc (5e04e9f)
2019-11-20 00:04:03 -05:00
<dd><p>This reconfiguration will handle changing both the number of hosts and
the cluster storage capacity.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
Updating latest python vmc doc (a71f566)
2020-09-11 09:36:05 -04:00
<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>
Updating latest python vmc doc (5e04e9f)
2019-11-20 00:04:03 -05: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>
<li><p><strong>cluster_reconfigure_params</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.ClusterReconfigureParams" title="com.vmware.vmc.model_client.ClusterReconfigureParams"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.ClusterReconfigureParams</span></code></a>) – clusterReconfigureParams (required)</p></li>
</ul>
</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>
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.InvalidRequest</span></code>
Bad Request. The SDDC is not in a valid state. , Method not allowed</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.Unauthorized</span></code>
Access not allowed to the operation for the current user</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.NotFound</span></code>
Cannot find the cluster with the given id</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
Updating latest python vmc doc (ed06abd)
2020-05-15 16:54:03 -04:00
<dl class="py class">
Updating latest python vmc doc (5e04e9f)
2019-11-20 00:04:03 -05:00
<dt id="com.vmware.vmc.orgs.sddcs.clusters_client.StubFactory">
Updating latest python vmc doc (ed06abd)
2020-05-15 16:54:03 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs.clusters_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.clusters_client.StubFactory" title="Permalink to this definition"></a></dt>
Updating latest python vmc doc (5e04e9f)
2019-11-20 00:04:03 -05:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
</div>
<div class="section" id="module-com.vmware.vmc.orgs.sddcs.dns_client">
<span id="com-vmware-vmc-orgs-sddcs-dns-client-module"></span><h2>com.vmware.vmc.orgs.sddcs.dns_client module<a class="headerlink" href="#module-com.vmware.vmc.orgs.sddcs.dns_client" title="Permalink to this headline"></a></h2>
Updating latest python vmc doc (ed06abd)
2020-05-15 16:54:03 -04:00
<dl class="py class">
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.dns_client.Private">
Updating latest python vmc doc (ed06abd)
2020-05-15 16:54:03 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs.dns_client.</code><code class="sig-name descname">Private</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.dns_client.Private" title="Permalink to this definition"></a></dt>
add vsphere, vmc and nsx API docs
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>
Updating latest python vmc docs
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>
Updating latest python vmc doc (ed06abd)
2020-05-15 16:54:03 -04:00
<dl class="py method">
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.dns_client.Private.update">
Updating latest python vmc doc (ed06abd)
2020-05-15 16:54:03 -04:00
<code class="sig-name descname">update</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.dns_client.Private.update" title="Permalink to this definition"></a></dt>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
<dd><p>Update the DNS records of management VMs to use private IP addresses</p>
Updating latest python vmc docs
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">
Updating latest python vmc doc (a71f566)
2020-09-11 09:36:05 -04:00
<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>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
</ul>
Updating latest python vmc docs
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>
update vmc doc for new binding 1.3.1
2019-01-16 05:37:32 -05:00
Unauthorized</p>
Updating latest python vmc docs
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>
update vmc doc for new binding 1.3.1
2019-01-16 05:37:32 -05:00
The sddc is not in a state that’s valid for updates or invalid body</p>
Updating latest python vmc docs
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>
update vmc doc for new binding 1.3.1
2019-01-16 05:37:32 -05:00
Forbidden</p>
Updating latest python vmc docs
2019-06-08 00:29:34 -04:00
</dd>
</dl>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
</dd></dl>
</dd></dl>
Updating latest python vmc doc (ed06abd)
2020-05-15 16:54:03 -04:00
<dl class="py class">
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.dns_client.Public">
Updating latest python vmc doc (ed06abd)
2020-05-15 16:54:03 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs.dns_client.</code><code class="sig-name descname">Public</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.dns_client.Public" title="Permalink to this definition"></a></dt>
add vsphere, vmc and nsx API docs
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>
Updating latest python vmc docs
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>
Updating latest python vmc doc (ed06abd)
2020-05-15 16:54:03 -04:00
<dl class="py method">
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.dns_client.Public.update">
Updating latest python vmc doc (ed06abd)
2020-05-15 16:54:03 -04:00
<code class="sig-name descname">update</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.dns_client.Public.update" title="Permalink to this definition"></a></dt>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
<dd><p>Update the DNS records of management VMs to use public IP addresses</p>
Updating latest python vmc docs
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">
Updating latest python vmc doc (a71f566)
2020-09-11 09:36:05 -04:00
<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>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
</ul>
Updating latest python vmc docs
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>
update vmc doc for new binding 1.3.1
2019-01-16 05:37:32 -05:00
Unauthorized</p>
Updating latest python vmc docs
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>
update vmc doc for new binding 1.3.1
2019-01-16 05:37:32 -05:00
The sddc is not in a state that’s valid for updates or invalid body</p>
Updating latest python vmc docs
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>
update vmc doc for new binding 1.3.1
2019-01-16 05:37:32 -05:00
Forbidden</p>
Updating latest python vmc docs
2019-06-08 00:29:34 -04:00
</dd>
</dl>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
</dd></dl>
</dd></dl>
Updating latest python vmc doc (ed06abd)
2020-05-15 16:54:03 -04:00
<dl class="py class">
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.dns_client.StubFactory">
Updating latest python vmc doc (ed06abd)
2020-05-15 16:54:03 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs.dns_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.dns_client.StubFactory" title="Permalink to this definition"></a></dt>
add vsphere, vmc and nsx API docs
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>
Updating latest python vmc docs
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>
Updating latest python vmc docs
2019-06-04 08:24:55 -04:00
</dd></dl>
</div>
<div class="section" id="module-com.vmware.vmc.orgs.sddcs.management_vms_client">
<span id="com-vmware-vmc-orgs-sddcs-management-vms-client-module"></span><h2>com.vmware.vmc.orgs.sddcs.management_vms_client module<a class="headerlink" href="#module-com.vmware.vmc.orgs.sddcs.management_vms_client" title="Permalink to this headline"></a></h2>
Updating latest python vmc doc (ed06abd)
2020-05-15 16:54:03 -04:00
<dl class="py class">
Updating latest python vmc docs
2019-06-04 08:24:55 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.management_vms_client.Dns">
Updating latest python vmc doc (ed06abd)
2020-05-15 16:54:03 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs.management_vms_client.</code><code class="sig-name descname">Dns</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.management_vms_client.Dns" title="Permalink to this definition"></a></dt>
Updating latest python vmc docs
2019-06-04 08:24:55 -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>
Updating latest python vmc docs
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>
Updating latest python vmc doc (ed06abd)
2020-05-15 16:54:03 -04:00
<dl class="py attribute">
Updating latest python vmc docs
2019-06-04 08:24:55 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.management_vms_client.Dns.UPDATE_IP_TYPE_PRIVATE">
Updating latest python vmc docs
2019-06-08 00:29:34 -04:00
<code class="sig-name descname">UPDATE_IP_TYPE_PRIVATE</code><em class="property"> = 'private'</em><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.management_vms_client.Dns.UPDATE_IP_TYPE_PRIVATE" title="Permalink to this definition"></a></dt>
Updating latest python vmc docs
2019-06-04 08:24:55 -04:00
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">ipType</span></code> of method <a class="reference internal" href="#com.vmware.vmc.orgs.sddcs.management_vms_client.Dns.update" title="com.vmware.vmc.orgs.sddcs.management_vms_client.Dns.update"><code class="xref py py-func docutils literal notranslate"><span class="pre">Dns.update()</span></code></a>.</p>
</dd></dl>
Updating latest python vmc doc (ed06abd)
2020-05-15 16:54:03 -04:00
<dl class="py attribute">
Updating latest python vmc docs
2019-06-04 08:24:55 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.management_vms_client.Dns.UPDATE_IP_TYPE_PUBLIC">
Updating latest python vmc docs
2019-06-08 00:29:34 -04:00
<code class="sig-name descname">UPDATE_IP_TYPE_PUBLIC</code><em class="property"> = 'public'</em><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.management_vms_client.Dns.UPDATE_IP_TYPE_PUBLIC" title="Permalink to this definition"></a></dt>
Updating latest python vmc docs
2019-06-04 08:24:55 -04:00
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">ipType</span></code> of method <a class="reference internal" href="#com.vmware.vmc.orgs.sddcs.management_vms_client.Dns.update" title="com.vmware.vmc.orgs.sddcs.management_vms_client.Dns.update"><code class="xref py py-func docutils literal notranslate"><span class="pre">Dns.update()</span></code></a>.</p>
</dd></dl>
Updating latest python vmc doc (ed06abd)
2020-05-15 16:54:03 -04:00
<dl class="py method">
Updating latest python vmc docs
2019-06-04 08:24:55 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.management_vms_client.Dns.update">
Updating latest python vmc doc (ed06abd)
2020-05-15 16:54:03 -04:00
<code class="sig-name descname">update</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">management_vm_id</span></em>, <em class="sig-param"><span class="n">ip_type</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.management_vms_client.Dns.update" title="Permalink to this definition"></a></dt>
Updating latest python vmc docs
2019-06-04 08:24:55 -04:00
<dd><p>Update the DNS records of management VMs to use public or private IP
addresses</p>
Updating latest python vmc docs
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">
Updating latest python vmc doc (a71f566)
2020-09-11 09:36:05 -04:00
<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>
Updating latest python vmc docs
2019-06-08 00:29:34 -04:00
<li><p><strong>management_vm_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – the management VM ID (required)</p></li>
<li><p><strong>ip_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – the ip type to associate with FQDN in DNS (required)</p></li>
Updating latest python vmc docs
2019-06-04 08:24:55 -04:00
</ul>
Updating latest python vmc docs
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>
Updating latest python vmc docs
2019-06-04 08:24:55 -04:00
Unauthorized</p>
Updating latest python vmc docs
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>
Updating latest python vmc docs
2019-06-04 08:24:55 -04:00
The sddc is not in a state that’s valid for updates or invalid body</p>
Updating latest python vmc docs
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>
Updating latest python vmc docs
2019-06-04 08:24:55 -04:00
Forbidden</p>
Updating latest python vmc docs
2019-06-08 00:29:34 -04:00
</dd>
</dl>
Updating latest python vmc docs
2019-06-04 08:24:55 -04:00
</dd></dl>
</dd></dl>
Updating latest python vmc doc (ed06abd)
2020-05-15 16:54:03 -04:00
<dl class="py class">
Updating latest python vmc docs
2019-06-04 08:24:55 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.management_vms_client.StubFactory">
Updating latest python vmc doc (ed06abd)
2020-05-15 16:54:03 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs.management_vms_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.management_vms_client.StubFactory" title="Permalink to this definition"></a></dt>
Updating latest python vmc docs
2019-06-04 08:24:55 -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>
Updating latest python vmc docs
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>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
</dd></dl>
</div>
API doc for VMware Cloud on AWS 1.5 release
2018-09-20 17:27:25 -04:00
<div class="section" id="module-com.vmware.vmc.orgs.sddcs.networking_client">
<span id="com-vmware-vmc-orgs-sddcs-networking-client-module"></span><h2>com.vmware.vmc.orgs.sddcs.networking_client module<a class="headerlink" href="#module-com.vmware.vmc.orgs.sddcs.networking_client" title="Permalink to this headline"></a></h2>
Updating latest python vmc doc (ed06abd)
2020-05-15 16:54:03 -04:00
<dl class="py class">
API doc for VMware Cloud on AWS 1.5 release
2018-09-20 17:27:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.networking_client.ConnectivityTests">
Updating latest python vmc doc (ed06abd)
2020-05-15 16:54:03 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs.networking_client.</code><code class="sig-name descname">ConnectivityTests</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.networking_client.ConnectivityTests" title="Permalink to this definition"></a></dt>
add vsphere, vmc and nsx API docs
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>
Updating latest python vmc docs
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>
Updating latest python vmc doc (ed06abd)
2020-05-15 16:54:03 -04:00
<dl class="py method">
API doc for VMware Cloud on AWS 1.5 release
2018-09-20 17:27:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.networking_client.ConnectivityTests.get">
Updating latest python vmc doc (ed06abd)
2020-05-15 16:54:03 -04:00
<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.networking_client.ConnectivityTests.get" title="Permalink to this definition"></a></dt>
API doc for VMware Cloud on AWS 1.5 release
2018-09-20 17:27:25 -04:00
<dd><p>Retrieve metadata for connectivity tests.</p>
Updating latest python vmc docs
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">
Updating latest python vmc doc (a71f566)
2020-09-11 09:36:05 -04:00
<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>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
</ul>
Updating latest python vmc docs
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.ConnectivityValidationGroups" title="com.vmware.vmc.model_client.ConnectivityValidationGroups"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.ConnectivityValidationGroups</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.vmc.model.ConnectivityValidationGroups</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>
update vmc doc for new binding 1.3.1
2019-01-16 05:37:32 -05:00
Unauthorized</p>
Updating latest python vmc docs
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>
update vmc doc for new binding 1.3.1
2019-01-16 05:37:32 -05:00
Forbidden</p>
Updating latest python vmc docs
2019-06-08 00:29:34 -04:00
</dd>
</dl>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
</dd></dl>
Updating latest python vmc doc (ed06abd)
2020-05-15 16:54:03 -04:00
<dl class="py method">
API doc for VMware Cloud on AWS 1.5 release
2018-09-20 17:27:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.networking_client.ConnectivityTests.post">
Updating latest python vmc doc (ed06abd)
2020-05-15 16:54:03 -04:00
<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</span></em>, <em class="sig-param"><span class="n">request_info</span></em>, <em class="sig-param"><span class="n">action</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networking_client.ConnectivityTests.post" title="Permalink to this definition"></a></dt>
API doc for VMware Cloud on AWS 1.5 release
2018-09-20 17:27:25 -04:00
<dd><p>ConnectivityValidationGroupResultWrapper will be available at
task.params[‘test_result’].</p>
Updating latest python vmc docs
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">
Updating latest python vmc doc (a71f566)
2020-09-11 09:36:05 -04:00
<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>
Updating latest python vmc docs
2019-06-08 00:29:34 -04:00
<li><p><strong>request_info</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.ConnectivityValidationGroup" title="com.vmware.vmc.model_client.ConnectivityValidationGroup"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.ConnectivityValidationGroup</span></code></a>) – request information (required)</p></li>
<li><p><strong>action</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – If = ‘start’, start connectivity tests. (required)</p></li>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
</ul>
Updating latest python vmc docs
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>
update vmc doc for new binding 1.3.1
2019-01-16 05:37:32 -05:00
Unauthorized</p>
Updating latest python vmc docs
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>
update vmc doc for new binding 1.3.1
2019-01-16 05:37:32 -05:00
Bad Request</p>
Updating latest python vmc docs
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>
update vmc doc for new binding 1.3.1
2019-01-16 05:37:32 -05:00
Forbidden</p>
Updating latest python vmc docs
2019-06-08 00:29:34 -04:00
</dd>
</dl>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
</dd></dl>
</dd></dl>
Updating latest python vmc doc (ed06abd)
2020-05-15 16:54:03 -04:00
<dl class="py class">
API doc for VMware Cloud on AWS 1.5 release
2018-09-20 17:27:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.networking_client.StubFactory">
Updating latest python vmc doc (ed06abd)
2020-05-15 16:54:03 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs.networking_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.networking_client.StubFactory" title="Permalink to this definition"></a></dt>
add vsphere, vmc and nsx API docs
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>
Updating latest python vmc docs
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>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
</dd></dl>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
Updating latest python vmc doc (5e04e9f)
2019-11-20 00:04:03 -05:00
<a href="com.vmware.vmc.orgs.sddcs.clusters.html" class="btn btn-neutral float-right" title="com.vmware.vmc.orgs.sddcs.clusters package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
Updating latest python vmc doc (a71f566)
2020-09-11 09:36:05 -04:00
<a href="com.vmware.vmc.orgs.aws.resources.html" class="btn btn-neutral float-left" title="com.vmware.vmc.orgs.aws.resources package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
</div>
<hr/>
<div role="contentinfo">
<p>
Updating latest python vmc doc (a71f566)
2020-09-11 09:36:05 -04:00
Updating latest python vmc doc (4b14fb6)
2020-01-16 23:32:45 -05:00
&copy; Copyright 2020, VMware, Inc.
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
</p>
</div>
Updating latest python vmc doc (a71f566)
2020-09-11 09:36:05 -04:00
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
Updating latest python vmc docs
2019-05-29 06:01:09 -04:00
</script>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
</body>
</html>
Copy Permalink