vsphere-automation-sdk-python/vsphere/cloud/com.vmware.vcenter.hvc.html



<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>com.vmware.vcenter.hvc package &mdash; vSphere Automation SDK for Python. 6.9.1 documentation</title>
  

  <script type="text/javascript" src="_static/js/modernizr.min.js"></script>
  
    
      <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
        <script type="text/javascript" src="_static/jquery.js"></script>
        <script type="text/javascript" src="_static/underscore.js"></script>
        <script type="text/javascript" src="_static/doctools.js"></script>
        <script type="text/javascript" src="_static/language_data.js"></script>
    
    <script type="text/javascript" src="_static/js/theme.js"></script>

    
  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="com.vmware.vcenter.hvc.links package" href="com.vmware.vcenter.hvc.links.html" />
    <link rel="prev" title="com.vmware.vcenter.deployment.install.initial_config package" href="com.vmware.vcenter.deployment.install.initial_config.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" >
          

            <a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python.
          

          </a>

          
              <div class="version">
                6.9.1
              </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>

        <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.appliance_client">com.vmware.appliance_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_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>
      </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">vSphere Automation SDK for Python.</a>
        
      </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">Docs</a> &raquo;</li>
        
          <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.vcenter.html">com.vmware.vcenter package</a> &raquo;</li>
        
      <li>com.vmware.vcenter.hvc package</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
            <a href="_sources/com.vmware.vcenter.hvc.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.vcenter.hvc">
<span id="com-vmware-vcenter-hvc-package"></span><h1>com.vmware.vcenter.hvc package<a class="headerlink" href="#module-com.vmware.vcenter.hvc" 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.vcenter.hvc.links.html">com.vmware.vcenter.hvc.links package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.hvc.links.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.hvc.links.html#module-com.vmware.vcenter.hvc.links.sync_client">com.vmware.vcenter.hvc.links.sync_client module</a></li>
</ul>
</li>
</ul>
</div>
</div>
<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.vcenter.hvc.links_client">
<span id="com-vmware-vcenter-hvc-links-client-module"></span><h2>com.vmware.vcenter.hvc.links_client module<a class="headerlink" href="#module-com.vmware.vcenter.hvc.links_client" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="com.vmware.vcenter.hvc.links_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.hvc.links_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc.links_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>

<dl class="class">
<dt id="com.vmware.vcenter.hvc.links_client.Sync">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.hvc.links_client.</code><code class="sig-name descname">Sync</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc.links_client.Sync" 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>
<p>The <code class="docutils literal notranslate"><span class="pre">Sync</span></code> class provides methods to create a sync session, get
information on Sync. <strong>Warning:</strong> This class is available as technical
preview. It may be changed in a future release.</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="class">
<dt id="com.vmware.vcenter.hvc.links_client.Sync.Credentials">
<em class="property">class </em><code class="sig-name descname">Credentials</code><span class="sig-paren">(</span><em class="sig-param">user_name=None</em>, <em class="sig-param">password=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc.links_client.Sync.Credentials" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Sync.Credentials</span></code> class specifies user credentials to make a
successful connection to remote endpoint. <strong>Warning:</strong> This class is
available as technical preview. It may be changed in a future release.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>user_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the user to authenticate. <strong>Warning:</strong> This attribute is
available as technical preview. It may be changed in a future
release.</p></li>
<li><p><strong>password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Password for the user. <strong>Warning:</strong> This attribute is available as
technical preview. It may be changed in a future release.</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="method">
<dt id="com.vmware.vcenter.hvc.links_client.Sync.reset">
<code class="sig-name descname">reset</code><span class="sig-paren">(</span><em class="sig-param">link</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc.links_client.Sync.reset" title="Permalink to this definition">¶</a></dt>
<dd><p>Resets the sync state between the linked domains by initiating a fresh
sync for all providers. If an existing sync is in progress this cancels
the sync. <strong>Warning:</strong> This method is available as technical preview.
It may be changed in a future release.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>link</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Unique identifier of the link.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.hvc.Links</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a> 
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a> 
if the link Identifier associated with <code class="docutils literal notranslate"><span class="pre">link</span></code> does not exist.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a> 
if the user is not authorized to perform this operation.</p>
</dd>
</dl>
</dd></dl>

</dd></dl>

</div>
<div class="section" id="module-com.vmware.vcenter.hvc.management_client">
<span id="com-vmware-vcenter-hvc-management-client-module"></span><h2>com.vmware.vcenter.hvc.management_client module<a class="headerlink" href="#module-com.vmware.vcenter.hvc.management_client" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="com.vmware.vcenter.hvc.management_client.Administrators">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.hvc.management_client.</code><code class="sig-name descname">Administrators</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc.management_client.Administrators" 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>
<p>The <code class="docutils literal notranslate"><span class="pre">Administrators</span></code> provides methods to update, delete, and list groups
in the local sso group. This is limited to the Hybrid Linked Mode service.
<strong>Warning:</strong> This class is available as technical preview. It may be
changed in a future release.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="method">
<dt id="com.vmware.vcenter.hvc.management_client.Administrators.add">
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">group_name</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc.management_client.Administrators.add" title="Permalink to this definition">¶</a></dt>
<dd><p>Add the local sso group with the new group. <strong>Warning:</strong> This method is
available as technical preview. It may be changed in a future release.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>group_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the new group to be added. Ex - xyz\&#64;abc.com where xyz
is the group name and abc.com is the domain name</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a> 
If the user is not authorized.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a> 
if the system reports an error while responding to the request.</p>
</dd>
</dl>
</dd></dl>

<dl class="method">
<dt id="com.vmware.vcenter.hvc.management_client.Administrators.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc.management_client.Administrators.get" title="Permalink to this definition">¶</a></dt>
<dd><p>Enumerates the set of all the groups in the local sso group.
<strong>Warning:</strong> This method is available as technical preview. It may be
changed in a future release.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.hvc.management_client.Administrators.set" title="com.vmware.vcenter.hvc.management_client.Administrators.set"><code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code></a> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>The <a class="reference internal" href="#com.vmware.vcenter.hvc.management_client.Administrators.set" title="com.vmware.vcenter.hvc.management_client.Administrators.set"><code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code></a> of all the groups.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a> 
if the system reports an error while responding to the request.</p>
</dd>
</dl>
</dd></dl>

<dl class="method">
<dt id="com.vmware.vcenter.hvc.management_client.Administrators.remove">
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">group_name</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc.management_client.Administrators.remove" title="Permalink to this definition">¶</a></dt>
<dd><p>Remove the group from the local sso group. <strong>Warning:</strong> This method is
available as technical preview. It may be changed in a future release.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>group_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the group to be removed. Ex - xyz\&#64;abc.com where xyz is
the group name and abc.com is the domain name</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a> 
If the user is not authorized.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a> 
if the system reports an error while responding to the request.</p>
</dd>
</dl>
</dd></dl>

<dl class="method">
<dt id="com.vmware.vcenter.hvc.management_client.Administrators.set">
<code class="sig-name descname">set</code><span class="sig-paren">(</span><em class="sig-param">group_names</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc.management_client.Administrators.set" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the groups in the local sso group. <strong>Warning:</strong> This method is
available as technical preview. It may be changed in a future release.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>group_names</strong> (<a class="reference internal" href="#com.vmware.vcenter.hvc.management_client.Administrators.set" title="com.vmware.vcenter.hvc.management_client.Administrators.set"><code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code></a> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Names the groups to be in the CloudAdminGroup Ex - xyz\&#64;abc.com
where xyz is the group name and abc.com is the domain name</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a> 
If the user is not authorized.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a> 
if the system reports an error while responding to the request.</p>
</dd>
</dl>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="com.vmware.vcenter.hvc.management_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.hvc.management_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc.management_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>

</div>
</div>


           </div>
           
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="com.vmware.vcenter.hvc.links.html" class="btn btn-neutral float-right" title="com.vmware.vcenter.hvc.links package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="com.vmware.vcenter.deployment.install.initial_config.html" class="btn btn-neutral float-left" title="com.vmware.vcenter.deployment.install.initial_config package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2019, VMware, Inc.

    </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>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  

  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>

  
</body>
</html>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
 								<!DOCTYPE html>
 								<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
 								<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
 								<head>
 								  <meta charset="utf-8">
 								  <meta name="viewport" content="width=device-width, initial-scale=1.0">
-												Documentation change for M8 release

Signed-off-by: Kunal Singh<singhk@vmware.com>

											
										
										
											2019-08-29 02:53:26 -04:00
+								  <title>com.vmware.vcenter.hvc package &mdash; vSphere Automation SDK for Python. 6.9.1 documentation</title>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
-												vSphere API reference for VMware Cloud on AWS 1.7

Signed-off-by: Tianhao He <het@vmware.com>

											
										
										
											2019-05-28 13:52:35 -04:00
+								  <script type="text/javascript" src="_static/js/modernizr.min.js"></script>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
-												vSphere API reference for VMware Cloud on AWS 1.7

Signed-off-by: Tianhao He <het@vmware.com>

											
										
										
											2019-05-28 13:52:35 -04:00
+								      <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
 								        <script type="text/javascript" src="_static/jquery.js"></script>
 								        <script type="text/javascript" src="_static/underscore.js"></script>
 								        <script type="text/javascript" src="_static/doctools.js"></script>
 								        <script type="text/javascript" src="_static/language_data.js"></script>
 								    <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
-												vSphere API reference for VMware Cloud on AWS 1.7

Signed-off-by: Tianhao He <het@vmware.com>

											
										
										
											2019-05-28 13:52:35 -04:00
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
-												vSphere API reference for VMware Cloud on AWS 1.7

Signed-off-by: Tianhao He <het@vmware.com>

											
										
										
											2019-05-28 13:52:35 -04:00
-												API doc for VMware Cloud on AWS 1.5 release

											
										
										
											2018-09-20 17:27:25 -04:00
+								  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								  <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
 								    <link rel="index" title="Index" href="genindex.html" />
 								    <link rel="search" title="Search" href="search.html" />
 								    <link rel="next" title="com.vmware.vcenter.hvc.links package" href="com.vmware.vcenter.hvc.links.html" />
 								    <link rel="prev" title="com.vmware.vcenter.deployment.install.initial_config package" href="com.vmware.vcenter.deployment.install.initial_config.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">
-												vSphere API reference for VMware Cloud on AWS 1.7

Signed-off-by: Tianhao He <het@vmware.com>

											
										
										
											2019-05-28 13:52:35 -04:00
+								        <div class="wy-side-nav-search" >
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
-												vSphere API reference for VMware Cloud on AWS 1.7

Signed-off-by: Tianhao He <het@vmware.com>

											
										
										
											2019-05-28 13:52:35 -04:00
+								            <a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python.
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
 								          </a>
 								              <div class="version">
-												Documentation change for M8 release

Signed-off-by: Kunal Singh<singhk@vmware.com>

											
										
										
											2019-08-29 02:53:26 -04:00
+.9.1
-												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>
 								        <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.appliance_client">com.vmware.appliance_client module</a></li>
 								<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
 								<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
-												vSphere API reference for VMware Cloud on AWS 1.7

Signed-off-by: Tianhao He <het@vmware.com>

											
										
										
											2019-05-28 13:52:35 -04:00
+								<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_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>
 								      </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>
-												vSphere API reference for VMware Cloud on AWS 1.7

Signed-off-by: Tianhao He <het@vmware.com>

											
										
										
											2019-05-28 13:52:35 -04:00
+								          <a href="index.html">vSphere Automation SDK for Python.</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">
 								      <li><a href="index.html">Docs</a> &raquo;</li>
 								          <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.vcenter.html">com.vmware.vcenter package</a> &raquo;</li>
 								      <li>com.vmware.vcenter.hvc package</li>
 								      <li class="wy-breadcrumbs-aside">
 								            <a href="_sources/com.vmware.vcenter.hvc.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.vcenter.hvc">
 								<span id="com-vmware-vcenter-hvc-package"></span><h1>com.vmware.vcenter.hvc package<a class="headerlink" href="#module-com.vmware.vcenter.hvc" 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.vcenter.hvc.links.html">com.vmware.vcenter.hvc.links package</a><ul>
 								<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.hvc.links.html#submodules">Submodules</a></li>
 								<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.hvc.links.html#module-com.vmware.vcenter.hvc.links.sync_client">com.vmware.vcenter.hvc.links.sync_client module</a></li>
 								</ul>
 								</li>
 								</ul>
 								</div>
 								</div>
 								<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.vcenter.hvc.links_client">
 								<span id="com-vmware-vcenter-hvc-links-client-module"></span><h2>com.vmware.vcenter.hvc.links_client module<a class="headerlink" href="#module-com.vmware.vcenter.hvc.links_client" title="Permalink to this headline">¶</a></h2>
 								<dl class="class">
 								<dt id="com.vmware.vcenter.hvc.links_client.StubFactory">
-												Documentation change for M8 release

Signed-off-by: Kunal Singh<singhk@vmware.com>

											
										
										
											2019-08-29 02:53:26 -04:00
+								<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.hvc.links_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc.links_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>
-												vSphere API reference for VMware Cloud on AWS 1.7

Signed-off-by: Tianhao He <het@vmware.com>

											
										
										
											2019-05-28 13:52:35 -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>
 								<dl class="class">
 								<dt id="com.vmware.vcenter.hvc.links_client.Sync">
-												Documentation change for M8 release

Signed-off-by: Kunal Singh<singhk@vmware.com>

											
										
										
											2019-08-29 02:53:26 -04:00
+								<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.hvc.links_client.</code><code class="sig-name descname">Sync</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc.links_client.Sync" 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>
 								<p>The <code class="docutils literal notranslate"><span class="pre">Sync</span></code> class provides methods to create a sync session, get
 								information on Sync. <strong>Warning:</strong> This class is available as technical
 								preview. It may be changed in a future release.</p>
-												vSphere API reference for VMware Cloud on AWS 1.7

Signed-off-by: Tianhao He <het@vmware.com>

											
										
										
											2019-05-28 13:52:35 -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="class">
 								<dt id="com.vmware.vcenter.hvc.links_client.Sync.Credentials">
-												Documentation change for M8 release

Signed-off-by: Kunal Singh<singhk@vmware.com>

											
										
										
											2019-08-29 02:53:26 -04:00
+								<em class="property">class </em><code class="sig-name descname">Credentials</code><span class="sig-paren">(</span><em class="sig-param">user_name=None</em>, <em class="sig-param">password=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc.links_client.Sync.Credentials" title="Permalink to this definition">¶</a></dt>
-												vSphere API reference for VMware Cloud on AWS 1.7

Signed-off-by: Tianhao He <het@vmware.com>

											
										
										
											2019-05-28 13:52:35 -04:00
+								<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
 								<p>The <code class="docutils literal notranslate"><span class="pre">Sync.Credentials</span></code> class specifies user credentials to make a
 								successful connection to remote endpoint. <strong>Warning:</strong> This class is
 								available as technical preview. It may be changed in a future release.</p>
 								<div class="admonition tip">
 								<p class="admonition-title">Tip</p>
 								<p>The arguments are used to initialize data attributes with the same
 								names.</p>
 								</div>
 								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>user_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the user to authenticate. <strong>Warning:</strong> This attribute is
 								available as technical preview. It may be changed in a future
 								release.</p></li>
 								<li><p><strong>password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Password for the user. <strong>Warning:</strong> This attribute is available as
 								technical preview. It may be changed in a future release.</p></li>
 								</ul>
 								</dd>
 								</dl>
 								</dd></dl>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								<dl class="method">
 								<dt id="com.vmware.vcenter.hvc.links_client.Sync.reset">
-												Documentation change for M8 release

Signed-off-by: Kunal Singh<singhk@vmware.com>

											
										
										
											2019-08-29 02:53:26 -04:00
+								<code class="sig-name descname">reset</code><span class="sig-paren">(</span><em class="sig-param">link</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc.links_client.Sync.reset" title="Permalink to this definition">¶</a></dt>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								<dd><p>Resets the sync state between the linked domains by initiating a fresh
 								sync for all providers. If an existing sync is in progress this cancels
 								the sync. <strong>Warning:</strong> This method is available as technical preview.
 								It may be changed in a future release.</p>
-												vSphere API reference for VMware Cloud on AWS 1.7

Signed-off-by: Tianhao He <het@vmware.com>

											
										
										
											2019-05-28 13:52:35 -04:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><p><strong>link</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Unique identifier of the link.
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								The parameter must be an identifier for the resource type:
-												vSphere API reference for VMware Cloud on AWS 1.7

Signed-off-by: Tianhao He <het@vmware.com>

											
										
										
											2019-05-28 13:52:35 -04:00
+								<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.hvc.Links</span></code>.</p>
 								</dd>
 								<dt class="field-even">Raise</dt>
 								<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
 								if the system reports an error while responding to the request.</p>
 								</dd>
 								<dt class="field-odd">Raise</dt>
 								<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
 								if the link Identifier associated with <code class="docutils literal notranslate"><span class="pre">link</span></code> does not exist.</p>
 								</dd>
 								<dt class="field-even">Raise</dt>
 								<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
 								if the user is not authorized to perform this operation.</p>
 								</dd>
 								</dl>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								</dd></dl>
 								</dd></dl>
 								</div>
 								<div class="section" id="module-com.vmware.vcenter.hvc.management_client">
 								<span id="com-vmware-vcenter-hvc-management-client-module"></span><h2>com.vmware.vcenter.hvc.management_client module<a class="headerlink" href="#module-com.vmware.vcenter.hvc.management_client" title="Permalink to this headline">¶</a></h2>
 								<dl class="class">
 								<dt id="com.vmware.vcenter.hvc.management_client.Administrators">
-												Documentation change for M8 release

Signed-off-by: Kunal Singh<singhk@vmware.com>

											
										
										
											2019-08-29 02:53:26 -04:00
+								<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.hvc.management_client.</code><code class="sig-name descname">Administrators</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc.management_client.Administrators" 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>
 								<p>The <code class="docutils literal notranslate"><span class="pre">Administrators</span></code> provides methods to update, delete, and list groups
 								in the local sso group. This is limited to the Hybrid Linked Mode service.
 								<strong>Warning:</strong> This class is available as technical preview. It may be
 								changed in a future release.</p>
-												vSphere API reference for VMware Cloud on AWS 1.7

Signed-off-by: Tianhao He <het@vmware.com>

											
										
										
											2019-05-28 13:52:35 -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>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								<dl class="method">
 								<dt id="com.vmware.vcenter.hvc.management_client.Administrators.add">
-												Documentation change for M8 release

Signed-off-by: Kunal Singh<singhk@vmware.com>

											
										
										
											2019-08-29 02:53:26 -04:00
+								<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">group_name</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc.management_client.Administrators.add" title="Permalink to this definition">¶</a></dt>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								<dd><p>Add the local sso group with the new group. <strong>Warning:</strong> This method is
 								available as technical preview. It may be changed in a future release.</p>
-												vSphere API reference for VMware Cloud on AWS 1.7

Signed-off-by: Tianhao He <het@vmware.com>

											
										
										
											2019-05-28 13:52:35 -04:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><p><strong>group_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the new group to be added. Ex - xyz\&#64;abc.com where xyz
 								is the group name and abc.com is the domain name</p>
 								</dd>
 								<dt class="field-even">Raise</dt>
 								<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
 								If the user is not authorized.</p>
 								</dd>
 								<dt class="field-odd">Raise</dt>
 								<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
 								if the system reports an error while responding to the request.</p>
 								</dd>
 								</dl>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								</dd></dl>
 								<dl class="method">
 								<dt id="com.vmware.vcenter.hvc.management_client.Administrators.get">
-												Documentation change for M8 release

Signed-off-by: Kunal Singh<singhk@vmware.com>

											
										
										
											2019-08-29 02:53:26 -04:00
+								<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc.management_client.Administrators.get" title="Permalink to this definition">¶</a></dt>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								<dd><p>Enumerates the set of all the groups in the local sso group.
 								<strong>Warning:</strong> This method is available as technical preview. It may be
 								changed in a future release.</p>
-												vSphere API reference for VMware Cloud on AWS 1.7

Signed-off-by: Tianhao He <het@vmware.com>

											
										
										
											2019-05-28 13:52:35 -04:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Return type</dt>
 								<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.hvc.management_client.Administrators.set" title="com.vmware.vcenter.hvc.management_client.Administrators.set"><code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code></a> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
 								</dd>
 								<dt class="field-even">Returns</dt>
 								<dd class="field-even"><p>The <a class="reference internal" href="#com.vmware.vcenter.hvc.management_client.Administrators.set" title="com.vmware.vcenter.hvc.management_client.Administrators.set"><code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code></a> of all the groups.</p>
 								</dd>
 								<dt class="field-odd">Raise</dt>
 								<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
 								if the system reports an error while responding to the request.</p>
 								</dd>
 								</dl>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								</dd></dl>
 								<dl class="method">
 								<dt id="com.vmware.vcenter.hvc.management_client.Administrators.remove">
-												Documentation change for M8 release

Signed-off-by: Kunal Singh<singhk@vmware.com>

											
										
										
											2019-08-29 02:53:26 -04:00
+								<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">group_name</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc.management_client.Administrators.remove" title="Permalink to this definition">¶</a></dt>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								<dd><p>Remove the group from the local sso group. <strong>Warning:</strong> This method is
 								available as technical preview. It may be changed in a future release.</p>
-												vSphere API reference for VMware Cloud on AWS 1.7

Signed-off-by: Tianhao He <het@vmware.com>

											
										
										
											2019-05-28 13:52:35 -04:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><p><strong>group_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the group to be removed. Ex - xyz\&#64;abc.com where xyz is
 								the group name and abc.com is the domain name</p>
 								</dd>
 								<dt class="field-even">Raise</dt>
 								<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
 								If the user is not authorized.</p>
 								</dd>
 								<dt class="field-odd">Raise</dt>
 								<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
 								if the system reports an error while responding to the request.</p>
 								</dd>
 								</dl>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								</dd></dl>
 								<dl class="method">
 								<dt id="com.vmware.vcenter.hvc.management_client.Administrators.set">
-												Documentation change for M8 release

Signed-off-by: Kunal Singh<singhk@vmware.com>

											
										
										
											2019-08-29 02:53:26 -04:00
+								<code class="sig-name descname">set</code><span class="sig-paren">(</span><em class="sig-param">group_names</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc.management_client.Administrators.set" title="Permalink to this definition">¶</a></dt>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								<dd><p>Sets the groups in the local sso group. <strong>Warning:</strong> This method is
 								available as technical preview. It may be changed in a future release.</p>
-												vSphere API reference for VMware Cloud on AWS 1.7

Signed-off-by: Tianhao He <het@vmware.com>

											
										
										
											2019-05-28 13:52:35 -04:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters</dt>
 								<dd class="field-odd"><p><strong>group_names</strong> (<a class="reference internal" href="#com.vmware.vcenter.hvc.management_client.Administrators.set" title="com.vmware.vcenter.hvc.management_client.Administrators.set"><code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code></a> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Names the groups to be in the CloudAdminGroup Ex - xyz\&#64;abc.com
 								where xyz is the group name and abc.com is the domain name</p>
 								</dd>
 								<dt class="field-even">Raise</dt>
 								<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
 								If the user is not authorized.</p>
 								</dd>
 								<dt class="field-odd">Raise</dt>
 								<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
 								if the system reports an error while responding to the request.</p>
 								</dd>
 								</dl>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
+								</dd></dl>
 								</dd></dl>
 								<dl class="class">
 								<dt id="com.vmware.vcenter.hvc.management_client.StubFactory">
-												Documentation change for M8 release

Signed-off-by: Kunal Singh<singhk@vmware.com>

											
										
										
											2019-08-29 02:53:26 -04:00
+								<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.hvc.management_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc.management_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>
-												vSphere API reference for VMware Cloud on AWS 1.7

Signed-off-by: Tianhao He <het@vmware.com>

											
										
										
											2019-05-28 13:52:35 -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">
 								        <a href="com.vmware.vcenter.hvc.links.html" class="btn btn-neutral float-right" title="com.vmware.vcenter.hvc.links package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
-												vSphere API reference for VMware Cloud on AWS 1.7

Signed-off-by: Tianhao He <het@vmware.com>

											
										
										
											2019-05-28 13:52:35 -04:00
+								        <a href="com.vmware.vcenter.deployment.install.initial_config.html" class="btn btn-neutral float-left" title="com.vmware.vcenter.deployment.install.initial_config 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>
-												vSphere API reference for VMware Cloud on AWS 1.7

Signed-off-by: Tianhao He <het@vmware.com>

											
										
										
											2019-05-28 13:52:35 -04:00
+								        &copy; Copyright 2019, VMware, Inc.
-												add vsphere, vmc and nsx API docs

											
										
										
											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>.
 								</footer>
 								        </div>
 								      </div>
 								    </section>
 								  </div>
 								  <script type="text/javascript">
 								      jQuery(function () {
 								          SphinxRtdTheme.Navigation.enable(true);
 								      });
-												vSphere API reference for VMware Cloud on AWS 1.7

Signed-off-by: Tianhao He <het@vmware.com>

											
										
										
											2019-05-28 13:52:35 -04:00
+								  </script>
-												add vsphere, vmc and nsx API docs

											
										
										
											2018-08-07 19:42:25 -04:00
 								</body>
 								</html>