<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"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.hvc.links_client.</span></code><codeclass="sig-name descname"><spanclass="pre">StubFactory</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">stub_config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.hvc.links_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.hvc.links_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Sync</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.hvc.links_client.Sync"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Sync</span></code> class provides methods to create a sync session, get
information on Sync. Usage beyond VMware Cloud on AWS is not supported.
<strong>Warning:</strong> This class is available as Technology Preview. These are early
access APIs provided to test, automate and provide feedback on the feature.
Since this can change based on feedback, VMware does not guarantee
backwards compatibility and recommends against using them in production
environments. Some Technology Preview APIs might only be applicable to
specific environments.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</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"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Credentials</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">user_name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">password</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.hvc.links_client.Sync.Credentials"title="Permalink to this definition">¶</a></dt>
<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 Technology Preview. These are early access APIs
provided to test, automate and provide feedback on the feature.
Since this can change based on feedback, VMware does not guarantee
backwards compatibility and recommends against using them in
production environments. Some Technology Preview APIs might only be
applicable to specific environments.</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
Technology Preview. These are early access APIs provided to test,
automate and provide feedback on the feature. Since this can change
based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production
environments. Some Technology Preview APIs might only be applicable
<codeclass="sig-name descname"><spanclass="pre">reset</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">link</span></span></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. Usage beyond VMware Cloud on AWS is not supported.
<strong>Warning:</strong> This method is available as Technology Preview. These are
early access APIs provided to test, automate and provide feedback on
the feature. Since this can change based on feedback, VMware does not
guarantee backwards compatibility and recommends against using them in
production environments. Some Technology Preview APIs might only be
applicable to specific environments.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>link</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Unique identifier of the link.
The parameter must be an identifier for the resource type:
<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"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.hvc.management_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Administrators</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.hvc.management_client.Administrators"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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.
Usage beyond VMware Cloud on AWS is not supported. <strong>Warning:</strong> This class
is available as Technology Preview. These are early access APIs provided to
test, automate and provide feedback on the feature. Since this can change
based on feedback, VMware does not guarantee backwards compatibility and
recommends against using them in production environments. Some Technology
Preview APIs might only be applicable to specific environments.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</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="sig-name descname"><spanclass="pre">add</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">group_name</span></span></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. Usage beyond VMware Cloud
on AWS is not supported. <strong>Warning:</strong> This method is available as
Technology Preview. These are early access APIs provided to test,
automate and provide feedback on the feature. Since this can change
based on feedback, VMware does not guarantee backwards compatibility
and recommends against using them in production environments. Some
Technology Preview APIs might only be applicable to specific
environments.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<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="sig-name descname"><spanclass="pre">get</span></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. Usage
beyond VMware Cloud on AWS is not supported. <strong>Warning:</strong> This method
is available as Technology Preview. These are early access APIs
provided to test, automate and provide feedback on the feature. Since
this can change based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production
environments. Some Technology Preview APIs might only be applicable to
<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="sig-name descname"><spanclass="pre">remove</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">group_name</span></span></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. Usage beyond VMware Cloud on
AWS is not supported. <strong>Warning:</strong> This method is available as
Technology Preview. These are early access APIs provided to test,
automate and provide feedback on the feature. Since this can change
based on feedback, VMware does not guarantee backwards compatibility
and recommends against using them in production environments. Some
Technology Preview APIs might only be applicable to specific
environments.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<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="sig-name descname"><spanclass="pre">set</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">group_names</span></span></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. Usage beyond VMware Cloud on
AWS is not supported. <strong>Warning:</strong> This method is available as
Technology Preview. These are early access APIs provided to test,
automate and provide feedback on the feature. Since this can change
based on feedback, VMware does not guarantee backwards compatibility
and recommends against using them in production environments. Some
Technology Preview APIs might only be applicable to specific
environments.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<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"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.hvc.management_client.</span></code><codeclass="sig-name descname"><spanclass="pre">StubFactory</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">stub_config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.hvc.management_client.StubFactory"title="Permalink to this definition">¶</a></dt>