<spanid="com-vmware-vcenter-hvc-package"></span><h1>com.vmware.vcenter.hvc package<aclass="headerlink"href="#module-com.vmware.vcenter.hvc"title="Permalink to this headline">¶</a></h1>
<divclass="section"id="subpackages">
<h2>Subpackages<aclass="headerlink"href="#subpackages"title="Permalink to this headline">¶</a></h2>
<spanid="com-vmware-vcenter-hvc-links-client-module"></span><h2>com.vmware.vcenter.hvc.links_client module<aclass="headerlink"href="#module-com.vmware.vcenter.hvc.links_client"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.hvc.links_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.hvc.links_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.hvc.links_client.</code><codeclass="descname">Sync</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.hvc.links_client.Sync"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property">class </em><codeclass="descname">Credentials</code><spanclass="sig-paren">(</span><em>user_name=None</em>, <em>password=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.hvc.links_client.Sync.Credentials"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>user_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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>
<codeclass="descname">reset</code><spanclass="sig-paren">(</span><em>link</em><spanclass="sig-paren">)</span><aclass="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.
<spanid="com-vmware-vcenter-hvc-management-client-module"></span><h2>com.vmware.vcenter.hvc.management_client module<aclass="headerlink"href="#module-com.vmware.vcenter.hvc.management_client"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.hvc.management_client.</code><codeclass="descname">Administrators</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.hvc.management_client.Administrators"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<codeclass="descname">add</code><spanclass="sig-paren">(</span><em>group_name</em><spanclass="sig-paren">)</span><aclass="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>
<ddclass="field-odd"><p><strong>group_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the new group to be added. Ex - xyz\@abc.com where xyz
is the group name and abc.com is the domain name</p>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="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
<ddclass="field-even"><p>The <aclass="reference internal"href="#com.vmware.vcenter.hvc.management_client.Administrators.set"title="com.vmware.vcenter.hvc.management_client.Administrators.set"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code></a> of all the groups.</p>
<codeclass="descname">remove</code><spanclass="sig-paren">(</span><em>group_name</em><spanclass="sig-paren">)</span><aclass="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>
<ddclass="field-odd"><p><strong>group_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the group to be removed. Ex - xyz\@abc.com where xyz is
<codeclass="descname">set</code><spanclass="sig-paren">(</span><em>group_names</em><spanclass="sig-paren">)</span><aclass="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>
<ddclass="field-odd"><p><strong>group_names</strong> (<aclass="reference internal"href="#com.vmware.vcenter.hvc.management_client.Administrators.set"title="com.vmware.vcenter.hvc.management_client.Administrators.set"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code></a> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Names the groups to be in the CloudAdminGroup Ex - xyz\@abc.com
where xyz is the group name and abc.com is the domain name</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.hvc.management_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.hvc.management_client.StubFactory"title="Permalink to this definition">¶</a></dt>
Built with <ahref="http://sphinx-doc.org/">Sphinx</a> using a <ahref="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <ahref="https://readthedocs.org">Read the Docs</a>.