Mirrors/vsphere-automation-sdk-python
1
0
Fork 0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-22 17:39:59 -05:00
Code
8ccc089bd0
vsphere-automation-sdk-python/vmc/com.vmware.vmc.orgs.sddcs.clusters.html

361 lines
17 KiB
HTML
Raw Normal View History

Updating latest python vmc doc (5e04e9f)
2019-11-20 00:04:03 -05:00
<!DOCTYPE html>
Updating latest python vmc doc (a71f566)
2020-09-11 09:36:05 -04:00
<html class="writer-html5" lang="en" >
Updating latest python vmc doc (5e04e9f)
2019-11-20 00:04:03 -05:00
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
Updating latest python vmc doc (ae815a2)
2020-09-30 04:07:23 -04:00
<title>com.vmware.vmc.orgs.sddcs.clusters package &mdash; vmc 1.29.0 documentation</title>
Updating latest python vmc doc (5e04e9f)
2019-11-20 00:04:03 -05: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" />
Updating latest python vmc doc (5e04e9f)
2019-11-20 00:04:03 -05: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]-->
Updating latest python vmc doc (5e04e9f)
2019-11-20 00:04:03 -05: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 doc (5e04e9f)
2019-11-20 00:04:03 -05:00
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
Updating latest python vmc doc (a71f566)
2020-09-11 09:36:05 -04:00
<link rel="next" title="vmware package" href="vmware.html" />
Updating latest python vmc doc (5e04e9f)
2019-11-20 00:04:03 -05:00
<link rel="prev" title="com.vmware.vmc.orgs.sddcs package" href="com.vmware.vmc.orgs.sddcs.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">
<div class="wy-side-nav-search" >
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
Updating latest python vmc doc (5e04e9f)
2019-11-20 00:04:03 -05:00
</a>
<div class="version">
Updating latest python vmc doc (ae815a2)
2020-09-30 04:07:23 -04:00
1.29.0
Updating latest python vmc doc (5e04e9f)
2019-11-20 00:04:03 -05: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
Updating latest python vmc doc (5e04e9f)
2019-11-20 00:04:03 -05: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>
<li class="toctree-l1"><a class="reference internal" href="vmware.html">vmware package</a></li>
</ul>
</div>
Updating latest python vmc doc (a71f566)
2020-09-11 09:36:05 -04:00
Updating latest python vmc doc (5e04e9f)
2019-11-20 00:04:03 -05: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>
</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>
Updating latest python vmc doc (5e04e9f)
2019-11-20 00:04:03 -05: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><a href="com.vmware.vmc.orgs.sddcs.html">com.vmware.vmc.orgs.sddcs package</a> &raquo;</li>
<li>com.vmware.vmc.orgs.sddcs.clusters package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/com.vmware.vmc.orgs.sddcs.clusters.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.clusters">
<span id="com-vmware-vmc-orgs-sddcs-clusters-package"></span><h1>com.vmware.vmc.orgs.sddcs.clusters package<a class="headerlink" href="#module-com.vmware.vmc.orgs.sddcs.clusters" title="Permalink to this headline"></a></h1>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="module-com.vmware.vmc.orgs.sddcs.clusters.config_client">
<span id="com-vmware-vmc-orgs-sddcs-clusters-config-client-module"></span><h2>com.vmware.vmc.orgs.sddcs.clusters.config_client module<a class="headerlink" href="#module-com.vmware.vmc.orgs.sddcs.clusters.config_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.config_client.Constraints">
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.config_client.</code><code class="sig-name descname">Constraints</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.config_client.Constraints" 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.config_client.Constraints.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>, <em class="sig-param"><span class="n">cluster</span></em>, <em class="sig-param"><span class="n">expected_num_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.sddcs.clusters.config_client.Constraints.get" title="Permalink to this definition"></a></dt>
Updating latest python vmc doc (5e04e9f)
2019-11-20 00:04:03 -05:00
<dd><p>This API provides the storage choices available when reconfiguring
storage in a cluster. The constraints returned will give vSAN
reconfiguration biases and available vSAN capacities per
reconfiguration bias. The constraints also indicate the default vSAN
capacity per reconfiguration biases as well as the default
reconfiguration bias.</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>expected_num_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 expected number of hosts in the cluster. If not specified,
returned is based on current number of hosts in the cluster.
(optional)</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.VsanClusterReconfigConstraints" title="com.vmware.vmc.model_client.VsanClusterReconfigConstraints"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.VsanClusterReconfigConstraints</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.vmc.model.VsanClusterReconfigConstraints</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>
Invalid or missing parameters</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>
Forbidden</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.config_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.config_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.config_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>
Updating latest python vmc doc (a71f566)
2020-09-11 09:36:05 -04:00
</div>
<div class="section" id="module-com.vmware.vmc.orgs.sddcs.clusters.msft_licensing_client">
<span id="com-vmware-vmc-orgs-sddcs-clusters-msft-licensing-client-module"></span><h2>com.vmware.vmc.orgs.sddcs.clusters.msft_licensing_client module<a class="headerlink" href="#module-com.vmware.vmc.orgs.sddcs.clusters.msft_licensing_client" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="com.vmware.vmc.orgs.sddcs.clusters.msft_licensing_client.Publish">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs.clusters.msft_licensing_client.</code><code class="sig-name descname">Publish</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.msft_licensing_client.Publish" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py method">
<dt id="com.vmware.vmc.orgs.sddcs.clusters.msft_licensing_client.Publish.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</span></em>, <em class="sig-param"><span class="n">cluster</span></em>, <em class="sig-param"><span class="n">config_change</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.clusters.msft_licensing_client.Publish.post" title="Permalink to this definition"></a></dt>
<dd><p>Sets the current Microsoft license status of the given SDDC’s cluster.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier (required)</p></li>
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc identifier (required)</p></li>
<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>config_change</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.MsftLicensingConfig" title="com.vmware.vmc.model_client.MsftLicensingConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.MsftLicensingConfig</span></code></a>) – The license data to set for the clusters. (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.Unauthorized</span></code>
Forbidden</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vmc.orgs.sddcs.clusters.msft_licensing_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs.clusters.msft_licensing_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.msft_licensing_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
Updating latest python vmc doc (5e04e9f)
2019-11-20 00:04:03 -05:00
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
Updating latest python vmc doc (a71f566)
2020-09-11 09:36:05 -04:00
<a href="vmware.html" class="btn btn-neutral float-right" title="vmware package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
Updating latest python vmc doc (5e04e9f)
2019-11-20 00:04:03 -05:00
<a href="com.vmware.vmc.orgs.sddcs.html" class="btn btn-neutral float-left" title="com.vmware.vmc.orgs.sddcs package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</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.
Updating latest python vmc doc (5e04e9f)
2019-11-20 00:04:03 -05: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>.
Updating latest python vmc doc (5e04e9f)
2019-11-20 00:04:03 -05:00
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
Copy Permalink