<spanid="com-vmware-appliance-client-module"></span><h2>com.vmware.appliance_client module<aclass="headerlink"href="#module-com.vmware.appliance_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.appliance_client</span></code> module provides classes for managing
vCenter Appliance configuration. The module is available starting in vSphere
6.7.</p>
<dlclass="class">
<dtid="com.vmware.appliance_client.Health">
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance_client.</code><codeclass="descname">Health</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Health"title="Permalink to this definition">¶</a></dt>
information. This class was added in vSphere API 6.7.</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="descname">messages</code><spanclass="sig-paren">(</span><em>item</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Health.messages"title="Permalink to this definition">¶</a></dt>
<dd><p>Get health messages. This method was added in vSphere API 6.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>item</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – ID of the data item
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance_client.</code><codeclass="descname">LocalAccounts</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.LocalAccounts"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>
<li><p><strong>password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Password. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>old_password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Old password of the user (required in case of the password change,
user). This attribute was added in vSphere API 6.7.
If None, user may not have password set.</p></li>
<li><p><strong>full_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Full name of the user. This attribute was added in vSphere API 6.7.
If None, user will have no fullname.</p></li>
<li><p><strong>email</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Email address of the local account. This attribute was added in
vSphere API 6.7.
If None, user will have no email.</p></li>
<li><p><strong>roles</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – User roles. This attribute was added in vSphere API 6.7.
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.appliance.roles</span></code>.</p></li>
<li><p><strong>enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating if the account is enabled. This attribute was added
in vSphere API 6.7.
If None, defaults to True</p></li>
<li><p><strong>password_expires</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating if the account password expires. This attribute was
added in vSphere API 6.7.
If None, defaults to True.</p></li>
<li><p><strong>password_expires_at</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Date when the account’s password will expire. This attribute was
<li><p><strong>inactive_after_password_expiration</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating if the account will be locked after password
expiration. This attribute was added in vSphere API 6.7.
If None, defaults to True.</p></li>
<li><p><strong>days_after_password_expiration</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Number of days after password expiration before the account will be
locked. This attribute was added in vSphere API 6.7.
<li><p><strong>min_days_between_password_change</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Minimum number of days between password change. This attribute was
<li><p><strong>max_days_between_password_change</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Maximum number of days between password change. This attribute was
<li><p><strong>warn_days_before_password_expiration</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Number of days of warning before password expires. This attribute
<li><p><strong>fullname</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Full name of the user. This attribute was added in vSphere API 6.7.
If None, the value was never set.</p></li>
<li><p><strong>email</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Email address of the local account. This attribute was added in
vSphere API 6.7.
If None, the value was never set.</p></li>
<li><p><strong>roles</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – User roles. This attribute was added in vSphere API 6.7.
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.appliance.roles</span></code>.</p></li>
<li><p><strong>enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag indicating if the account is enabled. This attribute was added
in vSphere API 6.7.</p></li>
<li><p><strong>has_password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Is the user password set. This attribute was added in vSphere API
6.7.</p></li>
<li><p><strong>last_password_change</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Date and time password was changed. This attribute was added in
vSphere API 6.7.
If None, the password was never set.</p></li>
<li><p><strong>password_expires_at</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Date when the account’s password will expire. This attribute was
added in vSphere API 6.7.
If None, the password never expires.</p></li>
<li><p><strong>inactive_at</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Date and time account will be locked after password expiration.
This attribute was added in vSphere API 6.7.
If None, account will not be locked.</p></li>
<li><p><strong>min_days_between_password_change</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Minimum number of days between password change. This attribute was
added in vSphere API 6.7.
If None, pasword can be changed any time.</p></li>
<li><p><strong>max_days_between_password_change</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Maximum number of days between password change. This attribute was
added in vSphere API 6.7.
If None, password never expires.</p></li>
<li><p><strong>warn_days_before_password_expiration</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Number of days of warning before password expires. This attribute
<li><p><strong>password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Password. This attribute was added in vSphere API 6.7.
If None, value will not be changed</p></li>
<li><p><strong>old_password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Old password of the user (required in case of the password change,
user). This attribute was added in vSphere API 6.7.
If None, user may not have password set.</p></li>
<li><p><strong>full_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Full name of the user. This attribute was added in vSphere API 6.7.
If None, value will not be changed</p></li>
<li><p><strong>email</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Email address of the local account. This attribute was added in
vSphere API 6.7.
If None, value will not be changed</p></li>
<li><p><strong>roles</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – User roles. This attribute was added in vSphere API 6.7.
<li><p><strong>enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating if the account is enabled. This attribute was added
in vSphere API 6.7.
If None, value will not be changed</p></li>
<li><p><strong>password_expires</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating if the account password expires. This attribute was
added in vSphere API 6.7.
If None, value will not be changed</p></li>
<li><p><strong>password_expires_at</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Date when the account’s password will expire. This attribute was
added in vSphere API 6.7.
If None, value will not be changed</p></li>
<li><p><strong>inactive_after_password_expiration</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating if the account will be locked after password
expiration. This attribute was added in vSphere API 6.7.
If None, value will not be changed</p></li>
<li><p><strong>days_after_password_expiration</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Number of days after password expiration before the account will be
locked. This attribute was added in vSphere API 6.7.
If None, value will not be changed</p></li>
<li><p><strong>min_days_between_password_change</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Minimum number of days between password change. This attribute was
added in vSphere API 6.7.
If None, value will not be changed</p></li>
<li><p><strong>max_days_between_password_change</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Maximum number of days between password change. This attribute was
added in vSphere API 6.7.
If None, value will not be changed</p></li>
<li><p><strong>warn_days_before_password_expiration</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Number of days of warning before password expires. This attribute
<codeclass="descname">create</code><spanclass="sig-paren">(</span><em>username</em>, <em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.LocalAccounts.create"title="Permalink to this definition">¶</a></dt>
<dd><p>Create a new local user account. This method was added in vSphere API
<codeclass="descname">delete</code><spanclass="sig-paren">(</span><em>username</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.LocalAccounts.delete"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>username</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.LocalAccounts.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Get the local user account information. This method was added in
<codeclass="descname">list</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.LocalAccounts.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Get a list of the local user accounts. This method was added in vSphere
<codeclass="descname">set</code><spanclass="sig-paren">(</span><em>username</em>, <em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.LocalAccounts.set"title="Permalink to this definition">¶</a></dt>
<dd><p>Set local user account properties. This method was added in vSphere API
<codeclass="descname">update</code><spanclass="sig-paren">(</span><em>username</em>, <em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.LocalAccounts.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Update selected fields in local user account properties. This method
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance_client.</code><codeclass="descname">Monitoring</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Monitoring"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">FunctionType</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Monitoring.FunctionType"title="Permalink to this definition">¶</a></dt>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">AVG</code><emclass="property"> = FunctionType(string='AVG')</em><aclass="headerlink"href="#com.vmware.appliance_client.Monitoring.FunctionType.AVG"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">COUNT</code><emclass="property"> = FunctionType(string='COUNT')</em><aclass="headerlink"href="#com.vmware.appliance_client.Monitoring.FunctionType.COUNT"title="Permalink to this definition">¶</a></dt>
<dd><p>Aggregation takes count per period (sum)</p>
<codeclass="descname">MAX</code><emclass="property"> = FunctionType(string='MAX')</em><aclass="headerlink"href="#com.vmware.appliance_client.Monitoring.FunctionType.MAX"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">MIN</code><emclass="property"> = FunctionType(string='MIN')</em><aclass="headerlink"href="#com.vmware.appliance_client.Monitoring.FunctionType.MIN"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descname">IntervalType</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Monitoring.IntervalType"title="Permalink to this definition">¶</a></dt>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">DAY1</code><emclass="property"> = IntervalType(string='DAY1')</em><aclass="headerlink"href="#com.vmware.appliance_client.Monitoring.IntervalType.DAY1"title="Permalink to this definition">¶</a></dt>
<dd><p>24 hours interval between values. One year has 365 values.</p>
<codeclass="descname">HOURS2</code><emclass="property"> = IntervalType(string='HOURS2')</em><aclass="headerlink"href="#com.vmware.appliance_client.Monitoring.IntervalType.HOURS2"title="Permalink to this definition">¶</a></dt>
<dd><p>Two hours interval between values. One month has 360 values.</p>
<codeclass="descname">HOURS6</code><emclass="property"> = IntervalType(string='HOURS6')</em><aclass="headerlink"href="#com.vmware.appliance_client.Monitoring.IntervalType.HOURS6"title="Permalink to this definition">¶</a></dt>
<dd><p>Six hour interval between values. One quarter is 360 values.</p>
<codeclass="descname">MINUTES30</code><emclass="property"> = IntervalType(string='MINUTES30')</em><aclass="headerlink"href="#com.vmware.appliance_client.Monitoring.IntervalType.MINUTES30"title="Permalink to this definition">¶</a></dt>
<dd><p>Thirty minutes interval between values. One week is 336 values.</p>
<codeclass="descname">MINUTES5</code><emclass="property"> = IntervalType(string='MINUTES5')</em><aclass="headerlink"href="#com.vmware.appliance_client.Monitoring.IntervalType.MINUTES5"title="Permalink to this definition">¶</a></dt>
<dd><p>Five minutes interval between values (finest). One day would have 288
<emclass="property">class </em><codeclass="descname">MonitoredItem</code><spanclass="sig-paren">(</span><em>id=None</em>, <em>name=None</em>, <em>units=None</em>, <em>category=None</em>, <em>instance=None</em>, <em>description=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Monitoring.MonitoredItem"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descname">MonitoredItemData</code><spanclass="sig-paren">(</span><em>name=None</em>, <em>interval=None</em>, <em>function=None</em>, <em>start_time=None</em>, <em>end_time=None</em>, <em>data=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Monitoring.MonitoredItemData"title="Permalink to this definition">¶</a></dt>
<li><p><strong>start_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Start time in UTC</p></li>
<li><p><strong>end_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – End time in UTC</p></li>
<li><p><strong>data</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – list of values</p></li>
<emclass="property">class </em><codeclass="descname">MonitoredItemDataRequest</code><spanclass="sig-paren">(</span><em>names=None</em>, <em>interval=None</em>, <em>function=None</em>, <em>start_time=None</em>, <em>end_time=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Monitoring.MonitoredItemDataRequest"title="Permalink to this definition">¶</a></dt>
<li><p><strong>start_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Start time in UTC</p></li>
<li><p><strong>end_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – End time in UTC</p></li>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>stat_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Monitoring.get"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">list</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Monitoring.list"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">query</code><spanclass="sig-paren">(</span><em>item</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Monitoring.query"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance_client.</code><codeclass="descname">Networking</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Networking"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">DNSInfo</code><spanclass="sig-paren">(</span><em>mode=None</em>, <em>hostname=None</em>, <em>servers=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Networking.DNSInfo"title="Permalink to this definition">¶</a></dt>
<li><p><strong>mode</strong> (<aclass="reference internal"href="#com.vmware.appliance_client.Networking.DNSInfo.DNSMode"title="com.vmware.appliance_client.Networking.DNSInfo.DNSMode"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Networking.DNSInfo.DNSMode</span></code></a>) – DNS mode. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>hostname</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Hostname. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>servers</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Servers. This attribute was added in vSphere API 6.7.</p></li>
<emclass="property">class </em><codeclass="descname">DNSMode</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Networking.DNSInfo.DNSMode"title="Permalink to this definition">¶</a></dt>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">DHCP</code><emclass="property"> = DNSMode(string='DHCP')</em><aclass="headerlink"href="#com.vmware.appliance_client.Networking.DNSInfo.DNSMode.DHCP"title="Permalink to this definition">¶</a></dt>
<dd><p>The DNS servers addresses are obtained from a DHCP server. This class
<codeclass="descname">STATIC</code><emclass="property"> = DNSMode(string='STATIC')</em><aclass="headerlink"href="#com.vmware.appliance_client.Networking.DNSInfo.DNSMode.STATIC"title="Permalink to this definition">¶</a></dt>
<dd><p>The DNS servers addresses are specified explicitly. This class attribute
<emclass="property">class </em><codeclass="descname">Info</code><spanclass="sig-paren">(</span><em>dns=None</em>, <em>interfaces=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Networking.Info"title="Permalink to this definition">¶</a></dt>
<li><p><strong>dns</strong> (<aclass="reference internal"href="#com.vmware.appliance_client.Networking.DNSInfo"title="com.vmware.appliance_client.Networking.DNSInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Networking.DNSInfo</span></code></a>) – DNS configuration. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>interfaces</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="com.vmware.appliance.html#com.vmware.appliance.networking_client.Interfaces.InterfaceInfo"title="com.vmware.appliance.networking_client.Interfaces.InterfaceInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.appliance.networking_client.Interfaces.InterfaceInfo</span></code></a>) – Interface configuration as a key-value map where key is a network
<emclass="property">class </em><codeclass="descname">UpdateSpec</code><spanclass="sig-paren">(</span><em>ipv6_enabled=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Networking.UpdateSpec"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>ipv6_enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – IPv6 Enabled or not. This attribute was added in vSphere API 6.7.
If unspecified, leaves the current state of Ipv6.</p>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Networking.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Get Networking information for all configured interfaces. This method
<codeclass="descname">reset</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Networking.reset"title="Permalink to this definition">¶</a></dt>
<dd><p>Reset and restarts network configuration on all interfaces, also this
will renew the DHCP lease for DHCP IP address. This method was added in
<codeclass="descname">update</code><spanclass="sig-paren">(</span><em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Networking.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Enable or Disable ipv6 on all interfaces. This method was added in
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance_client.</code><codeclass="descname">Notification</code><spanclass="sig-paren">(</span><em>id=None</em>, <em>time=None</em>, <em>message=None</em>, <em>resolution=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Notification"title="Permalink to this definition">¶</a></dt>
<li><p><strong>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The notification id. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The time the notification was raised/found. This attribute was
added in vSphere API 6.7.
Only if the time information is available.</p></li>
<li><p><strong>message</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – The notification message. This attribute was added in vSphere API
6.7.</p></li>
<li><p><strong>resolution</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The resolution message, if any. This attribute was added in vSphere
API 6.7.
Only <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> for warnings and errors.</p></li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance_client.</code><codeclass="descname">Notifications</code><spanclass="sig-paren">(</span><em>info=None</em>, <em>warnings=None</em>, <em>errors=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Notifications"title="Permalink to this definition">¶</a></dt>
<li><p><strong>info</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.appliance_client.Notification"title="com.vmware.appliance_client.Notification"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Notification</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Info notification messages reported. This attribute was added in
vSphere API 6.7.
Only <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> if an info was reported by the appliance task.</p></li>
<li><p><strong>warnings</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.appliance_client.Notification"title="com.vmware.appliance_client.Notification"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Notification</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Warning notification messages reported. This attribute was added in
vSphere API 6.7.
Only <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> if an warning was reported by the appliance task.</p></li>
<li><p><strong>errors</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.appliance_client.Notification"title="com.vmware.appliance_client.Notification"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Notification</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Error notification messages reported. This attribute was added in
vSphere API 6.7.
Only <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> if an error was reported by the appliance task.</p></li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance_client.</code><codeclass="descname">Ntp</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Ntp"title="Permalink to this definition">¶</a></dt>
connection to ntp servers. This class was added in vSphere API 6.7.</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">class </em><codeclass="descname">LocalizableMessage</code><spanclass="sig-paren">(</span><em>id=None</em>, <em>default_message=None</em>, <em>args=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Ntp.LocalizableMessage"title="Permalink to this definition">¶</a></dt>
<li><p><strong>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – id in message bundle. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>default_message</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – text in english. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>args</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – nested data. This attribute was added in vSphere API 6.7.</p></li>
<emclass="property">class </em><codeclass="descname">ServerStatus</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Ntp.ServerStatus"title="Permalink to this definition">¶</a></dt>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">SERVER_REACHABLE</code><emclass="property"> = ServerStatus(string='SERVER_REACHABLE')</em><aclass="headerlink"href="#com.vmware.appliance_client.Ntp.ServerStatus.SERVER_REACHABLE"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">SERVER_UNREACHABLE</code><emclass="property"> = ServerStatus(string='SERVER_UNREACHABLE')</em><aclass="headerlink"href="#com.vmware.appliance_client.Ntp.ServerStatus.SERVER_UNREACHABLE"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descname">TestRunStatus</code><spanclass="sig-paren">(</span><em>server=None</em>, <em>status=None</em>, <em>message=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Ntp.TestRunStatus"title="Permalink to this definition">¶</a></dt>
<li><p><strong>server</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Server name associated with the test run. This attribute was added
in vSphere API 6.7.</p></li>
<li><p><strong>status</strong> (<aclass="reference internal"href="#com.vmware.appliance_client.Ntp.ServerStatus"title="com.vmware.appliance_client.Ntp.ServerStatus"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Ntp.ServerStatus</span></code></a>) – Server status. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>message</strong> (<aclass="reference internal"href="#com.vmware.appliance_client.Ntp.LocalizableMessage"title="com.vmware.appliance_client.Ntp.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Ntp.LocalizableMessage</span></code></a>) – Message associated with status. This attribute was added in vSphere
<codeclass="descname">get</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Ntp.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Get the NTP configuration status. If you run the ‘timesync.get’
command, you can retrieve the current time synchronization method (NTP-
or VMware Tools-based). The ‘ntp’ command always returns the NTP server
information, even when the time synchronization mode is not set to NTP.
If the time synchronization mode is not NTP-based, the NTP server
<codeclass="descname">set</code><spanclass="sig-paren">(</span><em>servers</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Ntp.set"title="Permalink to this definition">¶</a></dt>
<dd><p>Set NTP servers. This method updates old NTP servers from configuration
and sets the input NTP servers in the configuration. If NTP based time
synchronization is used internally, the NTP daemon will be restarted to
reload given NTP configuration. In case NTP based time synchronization
is not used, this method only replaces servers in the NTP
configuration. This method was added in vSphere API 6.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>servers</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – List of host names or ip addresses of ntp servers.</p>
<codeclass="descname">test</code><spanclass="sig-paren">(</span><em>servers</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Ntp.test"title="Permalink to this definition">¶</a></dt>
<dd><p>Test the connection to a list of ntp servers. This method was added in
<ddclass="field-odd"><p><strong>servers</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – List of host names or IP addresses of NTP servers.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance_client.</code><codeclass="descname">Recovery</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Recovery"title="Permalink to this definition">¶</a></dt>
(backup and restore). This class was added in vSphere API 6.7.</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">class </em><codeclass="descname">Info</code><spanclass="sig-paren">(</span><em>supported=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Recovery.Info"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>supported</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Is recovery supported in this appliance. This attribute was added
<codeclass="descname">get</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Recovery.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Gets the properties of the appliance Recovery subsystem. This method
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance_client.</code><codeclass="descname">Services</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Services"title="Permalink to this definition">¶</a></dt>
services. This class was added in vSphere API 6.7.</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">class </em><codeclass="descname">Info</code><spanclass="sig-paren">(</span><em>description=None</em>, <em>state=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Services.Info"title="Permalink to this definition">¶</a></dt>
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Service description. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>state</strong> (<aclass="reference internal"href="#com.vmware.appliance_client.Services.State"title="com.vmware.appliance_client.Services.State"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Services.State</span></code></a>) – Running State. This attribute was added in vSphere API 6.7.</p></li>
<emclass="property">class </em><codeclass="descname">State</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Services.State"title="Permalink to this definition">¶</a></dt>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">STARTED</code><emclass="property"> = State(string='STARTED')</em><aclass="headerlink"href="#com.vmware.appliance_client.Services.State.STARTED"title="Permalink to this definition">¶</a></dt>
<dd><p>Service Run State is Started, it is fully functional. This class attribute
<codeclass="descname">STARTING</code><emclass="property"> = State(string='STARTING')</em><aclass="headerlink"href="#com.vmware.appliance_client.Services.State.STARTING"title="Permalink to this definition">¶</a></dt>
<dd><p>Service Run State is Starting, it is still not functional. This class
<codeclass="descname">STOPPED</code><emclass="property"> = State(string='STOPPED')</em><aclass="headerlink"href="#com.vmware.appliance_client.Services.State.STOPPED"title="Permalink to this definition">¶</a></dt>
<dd><p>Service Run State is Stopped. This class attribute was added in vSphere API
<codeclass="descname">STOPPING</code><emclass="property"> = State(string='STOPPING')</em><aclass="headerlink"href="#com.vmware.appliance_client.Services.State.STOPPING"title="Permalink to this definition">¶</a></dt>
<dd><p>Service Run State is Stopping, it is not functional. This class attribute
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>service</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Services.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the state of a service. This method was added in vSphere API
<ddclass="field-odd"><p><strong>service</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – identifier of the service whose state is being queried.
<codeclass="descname">list</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Services.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Lists details of vCenter services. This method was added in vSphere API
<codeclass="descname">restart</code><spanclass="sig-paren">(</span><em>service</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Services.restart"title="Permalink to this definition">¶</a></dt>
<dd><p>Restarts a service. This method was added in vSphere API 6.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>service</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – identifier of the service to restart
<codeclass="descname">start</code><spanclass="sig-paren">(</span><em>service</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Services.start"title="Permalink to this definition">¶</a></dt>
<dd><p>Starts a service. This method was added in vSphere API 6.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>service</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – identifier of the service to start
<codeclass="descname">stop</code><spanclass="sig-paren">(</span><em>service</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Services.stop"title="Permalink to this definition">¶</a></dt>
<dd><p>Stops a service. This method was added in vSphere API 6.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>service</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – identifier of the service to stop
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance_client.</code><codeclass="descname">Shutdown</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Shutdown"title="Permalink to this definition">¶</a></dt>
appliance. This class was added in vSphere API 6.7.</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">class </em><codeclass="descname">ShutdownConfig</code><spanclass="sig-paren">(</span><em>shutdown_time=None</em>, <em>action=None</em>, <em>reason=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Shutdown.ShutdownConfig"title="Permalink to this definition">¶</a></dt>
<li><p><strong>shutdown_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Shutdown time. This attribute was added in vSphere API 6.7.
shutdownTime Optional value of pending shutdown time</p></li>
<li><p><strong>action</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The pending shutdown operation. The string values for pending
<li><p><strong>reason</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The reason behind the shutdown action. This attribute was added in
<codeclass="descname">cancel</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Shutdown.cancel"title="Permalink to this definition">¶</a></dt>
<dd><p>Cancel pending shutdown action. This method was added in vSphere API
<codeclass="descname">get</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Shutdown.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Get details about the pending shutdown action. This method was added in
<codeclass="descname">poweroff</code><spanclass="sig-paren">(</span><em>delay</em>, <em>reason</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Shutdown.poweroff"title="Permalink to this definition">¶</a></dt>
<dd><p>Power off the appliance. This method was added in vSphere API 6.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>delay</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Minutes after which poweroff should start. If 0 is specified,
<codeclass="descname">reboot</code><spanclass="sig-paren">(</span><em>delay</em>, <em>reason</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Shutdown.reboot"title="Permalink to this definition">¶</a></dt>
<dd><p>Reboot the appliance. This method was added in vSphere API 6.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>delay</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Minutes after which reboot should start. If 0 is specified, reboot
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<li><p><strong>progress</strong> (<aclass="reference internal"href="com.vmware.cis.html#com.vmware.cis.task_client.Progress"title="com.vmware.cis.task_client.Progress"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.cis.task_client.Progress</span></code></a>) – Progress of the operation. This attribute was added in vSphere API
<li><p><strong>result</strong> (<aclass="reference internal"href="#com.vmware.appliance_client.Notifications"title="com.vmware.appliance_client.Notifications"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Notifications</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Result of the operation. If an operation reports partial results
before it completes, this attribute could be <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> before
the null has the value
<aclass="reference internal"href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED"title="com.vmware.cis.task_client.Status.SUCCEEDED"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a>. The value
could change as the operation progresses. This attribute was added
<li><p><strong>description</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Description of the operation associated with the task.</p></li>
<li><p><strong>service</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the service containing the operation.
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.service</span></code>.</p></li>
<li><p><strong>operation</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the operation associated with the task.
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.operation</span></code>.</p></li>
<li><p><strong>parent</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Parent of the current task.
This attribute will be None if the task has no parent.</p></li>
<li><p><strong>target</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID"title="com.vmware.vapi.std_client.DynamicID"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifier of the target created by the operation or an existing
<li><p><strong>status</strong> (<aclass="reference internal"href="com.vmware.cis.html#com.vmware.cis.task_client.Status"title="com.vmware.cis.task_client.Status"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.cis.task_client.Status</span></code></a>) – Status of the operation associated with the task.</p></li>
<li><p><strong>cancelable</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag to indicate whether or not the operation can be cancelled. The
value may change as the operation progresses.</p></li>
<li><p><strong>error</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Exception</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Description of the error if the operation status is “FAILED”.
<li><p><strong>start_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Time when the operation is started.
<li><p><strong>end_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Time when the operation is completed.
<li><p><strong>user</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name of the user who performed the operation.
<li><p><strong>progress</strong> (<aclass="reference internal"href="com.vmware.cis.html#com.vmware.cis.task_client.Progress"title="com.vmware.cis.task_client.Progress"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.cis.task_client.Progress</span></code></a>) – Progress of the task. This attribute was added in vSphere API 6.7.
<li><p><strong>subtask_order</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – List of tasks that make up this appliance task in the order they
are being run. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>subtasks</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.appliance_client.SubtaskInfo"title="com.vmware.appliance_client.SubtaskInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SubtaskInfo</span></code></a>) – Information about the subtasks that this appliance task consists
of. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>description</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Description of the operation associated with the task.</p></li>
<li><p><strong>service</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the service containing the operation.
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.service</span></code>.</p></li>
<li><p><strong>operation</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the operation associated with the task.
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.operation</span></code>.</p></li>
<li><p><strong>parent</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Parent of the current task.
This attribute will be None if the task has no parent.</p></li>
<li><p><strong>target</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID"title="com.vmware.vapi.std_client.DynamicID"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifier of the target created by the operation or an existing
<li><p><strong>status</strong> (<aclass="reference internal"href="com.vmware.cis.html#com.vmware.cis.task_client.Status"title="com.vmware.cis.task_client.Status"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.cis.task_client.Status</span></code></a>) – Status of the operation associated with the task.</p></li>
<li><p><strong>cancelable</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag to indicate whether or not the operation can be cancelled. The
value may change as the operation progresses.</p></li>
<li><p><strong>error</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Exception</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Description of the error if the operation status is “FAILED”.
<li><p><strong>start_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Time when the operation is started.
<li><p><strong>end_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Time when the operation is completed.
<li><p><strong>user</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name of the user who performed the operation.
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance_client.</code><codeclass="descname">Timesync</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Timesync"title="Permalink to this definition">¶</a></dt>
configuration. This class was added in vSphere API 6.7.</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">class </em><codeclass="descname">TimeSyncMode</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Timesync.TimeSyncMode"title="Permalink to this definition">¶</a></dt>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">DISABLED</code><emclass="property"> = TimeSyncMode(string='DISABLED')</em><aclass="headerlink"href="#com.vmware.appliance_client.Timesync.TimeSyncMode.DISABLED"title="Permalink to this definition">¶</a></dt>
<dd><p>Time synchronization is disabled. This class attribute was added in vSphere
<codeclass="descname">HOST</code><emclass="property"> = TimeSyncMode(string='HOST')</em><aclass="headerlink"href="#com.vmware.appliance_client.Timesync.TimeSyncMode.HOST"title="Permalink to this definition">¶</a></dt>
<dd><p>VMware Tool-based time synchronization. This class attribute was added in
<codeclass="descname">NTP</code><emclass="property"> = TimeSyncMode(string='NTP')</em><aclass="headerlink"href="#com.vmware.appliance_client.Timesync.TimeSyncMode.NTP"title="Permalink to this definition">¶</a></dt>
<dd><p>NTP-based time synchronization. This class attribute was added in vSphere
<codeclass="descname">get</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Timesync.get"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">set</code><spanclass="sig-paren">(</span><em>mode</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Timesync.set"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance_client.</code><codeclass="descname">Update</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Update"title="Permalink to this definition">¶</a></dt>
update. This class was added in vSphere API 6.7.</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">class </em><codeclass="descname">Info</code><spanclass="sig-paren">(</span><em>state=None</em>, <em>task=None</em>, <em>version=None</em>, <em>latest_query_time=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Update.Info"title="Permalink to this definition">¶</a></dt>
<li><p><strong>state</strong> (<aclass="reference internal"href="#com.vmware.appliance_client.Update.State"title="com.vmware.appliance_client.Update.State"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Update.State</span></code></a>) – State of the appliance update. This attribute was added in vSphere
API 6.7.</p></li>
<li><p><strong>task</strong> (<aclass="reference internal"href="#com.vmware.appliance_client.TaskInfo"title="com.vmware.appliance_client.TaskInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">TaskInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The running or completed update task. This attribute was added in
vSphere API 6.7.</p></li>
<li><p><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Version of base appliance if state is UP_TO_DATE Version of update
<li><p><strong>latest_query_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Timestamp of latest query to update repository. This attribute was
<emclass="property">class </em><codeclass="descname">State</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Update.State"title="Permalink to this definition">¶</a></dt>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">INSTALL_FAILED</code><emclass="property"> = State(string='INSTALL_FAILED')</em><aclass="headerlink"href="#com.vmware.appliance_client.Update.State.INSTALL_FAILED"title="Permalink to this definition">¶</a></dt>
<dd><p>The appliance update failed and cannot recover. This class attribute was
<codeclass="descname">INSTALL_IN_PROGRESS</code><emclass="property"> = State(string='INSTALL_IN_PROGRESS')</em><aclass="headerlink"href="#com.vmware.appliance_client.Update.State.INSTALL_IN_PROGRESS"title="Permalink to this definition">¶</a></dt>
<dd><p>The appliance update is in progress of installing an update. This class
<codeclass="descname">ROLLBACK_IN_PROGRESS</code><emclass="property"> = State(string='ROLLBACK_IN_PROGRESS')</em><aclass="headerlink"href="#com.vmware.appliance_client.Update.State.ROLLBACK_IN_PROGRESS"title="Permalink to this definition">¶</a></dt>
<dd><p>The appliance update failed and recovery is in progress. This class
<codeclass="descname">STAGE_IN_PROGRESS</code><emclass="property"> = State(string='STAGE_IN_PROGRESS')</em><aclass="headerlink"href="#com.vmware.appliance_client.Update.State.STAGE_IN_PROGRESS"title="Permalink to this definition">¶</a></dt>
<dd><p>The appliance update is in progress of downloading an update. This class
<codeclass="descname">UPDATES_PENDING</code><emclass="property"> = State(string='UPDATES_PENDING')</em><aclass="headerlink"href="#com.vmware.appliance_client.Update.State.UPDATES_PENDING"title="Permalink to this definition">¶</a></dt>
<dd><p>A new update is available. This class attribute was added in vSphere API
<codeclass="descname">UP_TO_DATE</code><emclass="property"> = State(string='UP_TO_DATE')</em><aclass="headerlink"href="#com.vmware.appliance_client.Update.State.UP_TO_DATE"title="Permalink to this definition">¶</a></dt>
<dd><p>The appliance is up to date. This class attribute was added in vSphere API
<codeclass="descname">cancel</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Update.cancel"title="Permalink to this definition">¶</a></dt>
<dd><p>Request the cancellation the update operation that is currently in
<codeclass="descname">get</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance_client.Update.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Gets the current status of the appliance update. This method was added
<spanid="com-vmware-cis-client-module"></span><h2>com.vmware.cis_client module<aclass="headerlink"href="#module-com.vmware.cis_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.cis_client</span></code> module provides VMware common infrastructure
classes.</p>
<dlclass="class">
<dtid="com.vmware.cis_client.Session">
<emclass="property">class </em><codeclass="descclassname">com.vmware.cis_client.</code><codeclass="descname">Session</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis_client.Session"title="Permalink to this definition">¶</a></dt>
<li><p>The <aclass="reference internal"href="#com.vmware.cis_client.Session.get"title="com.vmware.cis_client.Session.get"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Session.get()</span></code></a> retrieves information about a session token.</p></li>
<p>The call to the <aclass="reference internal"href="#com.vmware.cis_client.Session.create"title="com.vmware.cis_client.Session.create"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Session.create()</span></code></a> method is part of the overall
authentication process for API clients. For example, the sequence of steps
for establishing a session with SAML token is:</p>
<p>To use session based authentication a client should supply the session
token obtained through the <aclass="reference internal"href="#com.vmware.cis_client.Session.create"title="com.vmware.cis_client.Session.create"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Session.create()</span></code></a> method. The client should
add the session token in the security context when using SDK classes.
Clients using the REST API should supply the session token as a HTTP
<p>A session begins with call to the <aclass="reference internal"href="#com.vmware.cis_client.Session.create"title="com.vmware.cis_client.Session.create"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Session.create()</span></code></a> method to exchange
a SAML token for a API session token. A session ends under the following
for all exceptions caused by internal service failure.</p></li>
</ul>
<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">class </em><codeclass="descname">Info</code><spanclass="sig-paren">(</span><em>user=None</em>, <em>created_time=None</em>, <em>last_accessed_time=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis_client.Session.Info"title="Permalink to this definition">¶</a></dt>
<li><p><strong>user</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Fully qualified name of the end user that created the session, for
systems to visualize the identity of the current user.</p></li>
<li><p><strong>created_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Time when the session was created.</p></li>
<li><p><strong>last_accessed_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Last time this session was used by passing the session key for
<codeclass="descname">create</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis_client.Session.create"title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a session with the API. This is the equivalent of login. This
method exchanges user credentials supplied in the security context for
a session identifier that is to be used for authenticating subsequent
calls. To authenticate subsequent calls clients are expected to include
<codeclass="descname">delete</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis_client.Session.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Terminates the validity of a session token. This is the equivalent of
<codeclass="descname">get</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis_client.Session.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about the current session. This method expects a
valid session identifier to be supplied.</p>
<p>A side effect of invoking this method may be a change to the session’s
last accessed time to the current time if this is supported by the
session implementation. Invoking any other method in the API will also
update the session’s last accessed time.</p>
<p>This API is meant to serve the needs of various front end projects that
may want to display the name of the user. Examples of this include
various web based user interfaces and logging facilities.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.cis_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.cis_client.</code><codeclass="descname">Tasks</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis_client.Tasks"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Tasks</span></code> class provides methods for managing the task related to a
long running operation. This class was added in vSphere API 6.7.1.</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>
</dd>
</dl>
<dlclass="class">
<dtid="com.vmware.cis_client.Tasks.FilterSpec">
<emclass="property">class </em><codeclass="descname">FilterSpec</code><spanclass="sig-paren">(</span><em>tasks=None</em>, <em>services=None</em>, <em>status=None</em>, <em>targets=None</em>, <em>users=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis_client.Tasks.FilterSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Tasks.FilterSpec</span></code> class contains attributes used to filter the
results when listing tasks (see <aclass="reference internal"href="#com.vmware.cis_client.Tasks.list"title="com.vmware.cis_client.Tasks.list"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Tasks.list()</span></code></a>). If multiple attributes
are specified, only tasks matching all of the attributes match the filter.
This class was added in vSphere API 6.7.1.</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>tasks</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifiers of tasks that can match the filter. This attribute was
added in vSphere API 6.7.1.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.cis.task</span></code>. When methods return a value of this class
as a return value, the attribute will contain identifiers for the
This attribute may be None if <codeclass="docutils literal notranslate"><spanclass="pre">services</span></code> is specified. Currently
all tasks must be from the same provider. If None or empty, tasks
with any identifier will match the filter.</p></li>
<li><p><strong>services</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifiers of services. Tasks created by operations in these
services match the filter (see
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">com.vmware.cis.task_client.CommonInfo.service</span></code>). This
attribute was added in vSphere API 6.7.1.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.service</span></code>. When methods return a value of this
class as a return value, the attribute will contain identifiers for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.service</span></code>.
This attribute may be None if <codeclass="docutils literal notranslate"><spanclass="pre">tasks</span></code> is specified. Currently all
services must be from the same provider. If this attribute is None
or empty, tasks for all services will match the filter.</p></li>
<li><p><strong>status</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <aclass="reference internal"href="com.vmware.cis.html#com.vmware.cis.task_client.Status"title="com.vmware.cis.task_client.Status"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.cis.task_client.Status</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Status that a task must have to match the filter (see
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">com.vmware.cis.task_client.CommonInfo.status</span></code>). This
attribute was added in vSphere API 6.7.1.
If None or empty, tasks with any status match the filter.</p></li>
<li><p><strong>targets</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID"title="com.vmware.vapi.std_client.DynamicID"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifiers of the targets the operation for the associated task
created or was performed on (see
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">com.vmware.cis.task_client.CommonInfo.target</span></code>). This
attribute was added in vSphere API 6.7.1.
If None or empty, tasks associated with operations on any target
match the filter.</p></li>
<li><p><strong>users</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Users who must have initiated the operation for the associated task
to match the filter (see
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">com.vmware.cis.task_client.CommonInfo.user</span></code>). This attribute
was added in vSphere API 6.7.1.
If None or empty, tasks associated with operations initiated by any
user match the filter.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.cis_client.Tasks.GetSpec">
<emclass="property">class </em><codeclass="descname">GetSpec</code><spanclass="sig-paren">(</span><em>return_all=None</em>, <em>exclude_result=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis_client.Tasks.GetSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Tasks.GetSpec</span></code> class describes what data should be included when
retrieving information about a task. This class was added in vSphere API
6.7.1.</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>return_all</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – If true, all data, including operation-specific data, will be
returned, otherwise only the data described in
<aclass="reference internal"href="com.vmware.cis.html#com.vmware.cis.task_client.Info"title="com.vmware.cis.task_client.Info"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.cis.task_client.Info</span></code></a> will be returned. This
attribute was added in vSphere API 6.7.1.
If None, only the data described in
<aclass="reference internal"href="com.vmware.cis.html#com.vmware.cis.task_client.Info"title="com.vmware.cis.task_client.Info"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.cis.task_client.Info</span></code></a> will be returned.</p></li>
<li><p><strong>exclude_result</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – If true, the result will not be included in the task information,
otherwise it will be included. This attribute was added in vSphere
API 6.7.1.
If None, the result of the operation will be included in the task
<codeclass="descname">RESOURCE_TYPE</code><emclass="property"> = 'com.vmware.cis.task'</em><aclass="headerlink"href="#com.vmware.cis_client.Tasks.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<dd><p>Resource type for task. This class attribute was added in vSphere API 6.7.1.</p>
</dd></dl>
<dlclass="method">
<dtid="com.vmware.cis_client.Tasks.cancel">
<codeclass="descname">cancel</code><spanclass="sig-paren">(</span><em>task</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis_client.Tasks.cancel"title="Permalink to this definition">¶</a></dt>
<dd><p>Cancel a running operation associated with the task. This is the best
effort attempt. Operation may not be cancelled anymore once it reaches
certain stage. This method was added in vSphere API 6.7.1.</p>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>task</em>, <em>spec=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis_client.Tasks.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about a task. This method was added in vSphere API
<li><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.cis_client.Tasks.GetSpec"title="com.vmware.cis_client.Tasks.GetSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Tasks.GetSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specification on what to get for a task.
If None, the behavior is equivalent to a <aclass="reference internal"href="#com.vmware.cis_client.Tasks.GetSpec"title="com.vmware.cis_client.Tasks.GetSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Tasks.GetSpec</span></code></a>
with all attributes None which means only the data described in
<aclass="reference internal"href="com.vmware.cis.html#com.vmware.cis.task_client.Info"title="com.vmware.cis.task_client.Info"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.cis.task_client.Info</span></code></a> will be returned and the
if the user doesn’t have the required privileges.</p>
</dd>
</dl>
</dd></dl>
<dlclass="method">
<dtid="com.vmware.cis_client.Tasks.list">
<codeclass="descname">list</code><spanclass="sig-paren">(</span><em>filter_spec=None</em>, <em>result_spec=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.cis_client.Tasks.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about at most 1000 visible (subject to permission
checks) tasks matching the <aclass="reference internal"href="#com.vmware.cis_client.Tasks.FilterSpec"title="com.vmware.cis_client.Tasks.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Tasks.FilterSpec</span></code></a>. All tasks must be
in the same provider. This method was added in vSphere API 6.7.1.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>filter_spec</strong> (<aclass="reference internal"href="#com.vmware.cis_client.Tasks.FilterSpec"title="com.vmware.cis_client.Tasks.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Tasks.FilterSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specification of matching tasks.
This is currently required. In the future, if it is None, the
behavior is equivalent to a <aclass="reference internal"href="#com.vmware.cis_client.Tasks.FilterSpec"title="com.vmware.cis_client.Tasks.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Tasks.FilterSpec</span></code></a> with all
attributes None which means all tasks match the filter.</p></li>
<li><p><strong>result_spec</strong> (<aclass="reference internal"href="#com.vmware.cis_client.Tasks.GetSpec"title="com.vmware.cis_client.Tasks.GetSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Tasks.GetSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specification of what to return for a task.
If None, the behavior is equivalent to a <aclass="reference internal"href="#com.vmware.cis_client.Tasks.GetSpec"title="com.vmware.cis_client.Tasks.GetSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Tasks.GetSpec</span></code></a>
with all attributes None which means only the data describe in
<aclass="reference internal"href="com.vmware.cis.html#com.vmware.cis.task_client.Info"title="com.vmware.cis.task_client.Info"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.cis.task_client.Info</span></code></a> will be returned and the
<spanid="com-vmware-content-client-module"></span><h2>com.vmware.content_client module<aclass="headerlink"href="#module-com.vmware.content_client"title="Permalink to this headline">¶</a></h2>
<p>The Content module provides classes and classes for configuring global settings
and permissions, and for managing libraries in the Content Library Service.</p>
<dlclass="class">
<dtid="com.vmware.content_client.Configuration">
<emclass="property">class </em><codeclass="descclassname">com.vmware.content_client.</code><codeclass="descname">Configuration</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content_client.Configuration"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">get</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content_client.Configuration.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieves the current configuration values.</p>
<codeclass="descname">update</code><spanclass="sig-paren">(</span><em>model</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content_client.Configuration.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Updates the configuration. The update is incremental. Any attribute in
the <aclass="reference internal"href="#com.vmware.content_client.ConfigurationModel"title="com.vmware.content_client.ConfigurationModel"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ConfigurationModel</span></code></a> class that is None will not be
modified. Note that this update method doesn’t guarantee an atomic
change of all the properties. In the case of a system crash or failure,
some of the properties could be left unchanged while others may be
<emclass="property">class </em><codeclass="descclassname">com.vmware.content_client.</code><codeclass="descname">ConfigurationModel</code><spanclass="sig-paren">(</span><em>automatic_sync_enabled=None</em>, <em>automatic_sync_start_hour=None</em>, <em>automatic_sync_stop_hour=None</em>, <em>maximum_concurrent_item_syncs=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content_client.ConfigurationModel"title="Permalink to this definition">¶</a></dt>
This attribute is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It will
always be present in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code>
methods. It is optional for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method.</p>
<li><p><strong>automatic_sync_start_hour</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – The hour at which the automatic synchronization will start. This
This attribute is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It will
always be present in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code>
methods. It is optional for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method.</p></li>
<li><p><strong>automatic_sync_stop_hour</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – The hour at which the automatic synchronization will stop. Any
active synchronization operation will continue to run, however no
new synchronization operations will be triggered after the stop
hour. This value is between 0 (midnight) and 23 inclusive.
This attribute is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It will
always be present in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code>
methods. It is optional for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method.</p></li>
<li><p><strong>maximum_concurrent_item_syncs</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) –<p>The maximum allowed number of library items to synchronize
<p>This attribute is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It will
always be present in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code>
methods. It is optional for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.content_client.</code><codeclass="descname">Library</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content_client.Library"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">FindSpec</code><spanclass="sig-paren">(</span><em>name=None</em>, <em>type=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content_client.Library.FindSpec"title="Permalink to this definition">¶</a></dt>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name of the library to search. The name is case-insensitive. See
<codeclass="descname">RESOURCE_TYPE</code><emclass="property"> = 'com.vmware.content.Library'</em><aclass="headerlink"href="#com.vmware.content_client.Library.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<dd><p>Resource type for library.</p>
</dd></dl>
<dlclass="method">
<dtid="com.vmware.content_client.Library.find">
<codeclass="descname">find</code><spanclass="sig-paren">(</span><em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content_client.Library.find"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a list of all the visible (as determined by authorization
<ddclass="field-odd"><p>The <aclass="reference internal"href="#com.vmware.content_client.Library.list"title="com.vmware.content_client.Library.list"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code></a> of identifiers of all the visible libraries
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>library_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content_client.Library.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a given <aclass="reference internal"href="#com.vmware.content_client.LibraryModel"title="com.vmware.content_client.LibraryModel"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryModel</span></code></a>.</p>
<ddclass="field-odd"><p><strong>library_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the library to return.
<codeclass="descname">list</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content_client.Library.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the identifiers of all libraries of any type in the Content
<ddclass="field-even"><p>The <aclass="reference internal"href="#com.vmware.content_client.Library.list"title="com.vmware.content_client.Library.list"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code></a> of all identifiers of all libraries in the
<codeclass="descname">update</code><spanclass="sig-paren">(</span><em>library_id</em>, <em>update_spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content_client.Library.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Updates the properties of a library.</p>
<p>This is an incremental update to the library. Any attribute in the
<aclass="reference internal"href="#com.vmware.content_client.LibraryModel"title="com.vmware.content_client.LibraryModel"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryModel</span></code></a> class that is None will not be modified.</p>
<p>This method will only update the common properties for all library
types. This will not, for example, update the
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">LibraryModel.publish_info</span></code> of a local library, nor the
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">LibraryModel.subscription_info</span></code> of a subscribed library.
Specific properties are updated in <aclass="reference internal"href="#com.vmware.content_client.LocalLibrary.update"title="com.vmware.content_client.LocalLibrary.update"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">LocalLibrary.update()</span></code></a> and
<li><p><strong>library_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the library to update.
<li><p><strong>update_spec</strong> (<aclass="reference internal"href="#com.vmware.content_client.LibraryModel"title="com.vmware.content_client.LibraryModel"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryModel</span></code></a>) – Specification of the new property values to set on the library.</p></li>
if the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">LibraryModel.version</span></code> of <codeclass="docutils literal notranslate"><spanclass="pre">update_spec</span></code> is not equal
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.content.Library</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.content.Library</span></code>.
This attribute is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It will not
be present in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code> methods.
It is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method.</p></li>
<li><p><strong>creation_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – The date and time when this library was created.
This attribute is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It will
always be present in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code>
methods. It is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method.</p></li>
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – A human-readable description for this library.
This attribute is optional for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. Leaving it
None during creation will result in an empty string value. It will
always be present in the result of a <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code> method. It
is optional for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method. Leaving it None during
update indicates that the description should be left unchanged.</p></li>
<li><p><strong>last_modified_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) –<p>The date and time when this library was last updated.</p>
<p>This attribute is updated automatically when the library properties
are changed. This attribute is not affected by adding, removing, or
modifying a library item or its content within the library. Tagging
the library or syncing the subscribed library does not alter this
attribute.
This attribute is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It will
always be present in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code>
methods. It is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method.</p>
<li><p><strong>last_sync_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) –<p>The date and time when this library was last synchronized.</p>
<p>This attribute applies only to subscribed libraries. It is updated
every time a synchronization is triggered on the library. The value
is None for a local library.
This attribute is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It is
optional in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code> methods. It
is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method.</p>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) –<p>The name of the library.</p>
<p>A Library is identified by a human-readable name. Library names
cannot be undefined or an empty string. Names do not have to be
unique.
This attribute must be provided for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It will
always be present in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code>
methods. It is optional for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method.</p>
<li><p><strong>storage_backings</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="com.vmware.content.html#com.vmware.content.library_client.StorageBacking"title="com.vmware.content.library_client.StorageBacking"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.content.library_client.StorageBacking</span></code></a>) –<p>The list of default storage backings which are available for this
a default storage location which can be used to store files for
library items in this library. Some library items, for instance,
virtual machine template items, support files that may be
distributed across various storage backings. One or more item files
may or may not be located on the default storage backing.</p>
<p>Multiple default storage locations are not currently supported but
may become supported in future releases.
This attribute must be provided for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It will
always be present in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code>
methods. It is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method.</p>
<li><p><strong>type</strong> (<aclass="reference internal"href="#com.vmware.content_client.LibraryModel.LibraryType"title="com.vmware.content_client.LibraryModel.LibraryType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryModel.LibraryType</span></code></a>) –<p>The type (LOCAL, SUBSCRIBED) of this library.</p>
<p>This value can be used to determine what additional services and
information can be available for this library. This attribute is
not used for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> methods. It will always
be present in the result of a <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> method.
This attribute is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It will
always be present in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code>
methods. It is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method.</p>
This attribute is optional for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It is
optional in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code> methods. It
is optional for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method.</p></li>
<li><p><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) –<p>A version number which is updated on metadata changes. This value
allows clients to detect concurrent updates and prevent accidental
clobbering of data.</p>
<p>This value represents a number which is incremented every time
library properties, such as name or description, are changed. It is
not incremented by changes to a library item within the library,
including adding or removing items. It is also not affected by
tagging the library.
This attribute is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It will
always be present in the result of a <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code> method. It
is optional for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method. Leaving it None during
update indicates that you do not need to detect concurrent updates.</p>
<li><p><strong>publish_info</strong> (<aclass="reference internal"href="com.vmware.content.html#com.vmware.content.library_client.PublishInfo"title="com.vmware.content.library_client.PublishInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.content.library_client.PublishInfo</span></code></a>) –<p>Defines how this library is published so that it can be subscribed
This attribute is optional for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code>
methods. If not specified during creation, the default is for the
library to not be published. If not specified during update, the
<li><p><strong>subscription_info</strong> (<aclass="reference internal"href="com.vmware.content.html#com.vmware.content.library_client.SubscriptionInfo"title="com.vmware.content.library_client.SubscriptionInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.content.library_client.SubscriptionInfo</span></code></a>) –<p>Defines the subscription behavior for this Library.</p>
to false will halt subscription but will not remove existing cached
data.
This attribute is optional for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code>
methods. If not specified during creation, a default will be
created without an active subscription. If not specified during
<li><p><strong>server_guid</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The unique identifier of the vCenter server where the library
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.VCenter</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.VCenter</span></code>.
This attribute is optional for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It will
always be present in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code>
<emclass="property">class </em><codeclass="descname">LibraryType</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content_client.LibraryModel.LibraryType"title="Permalink to this definition">¶</a></dt>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">LOCAL</code><emclass="property"> = LibraryType(string='LOCAL')</em><aclass="headerlink"href="#com.vmware.content_client.LibraryModel.LibraryType.LOCAL"title="Permalink to this definition">¶</a></dt>
<dd><p>The library contents are defined and stored by the local Content Library
Service installation.</p>
<p>A local library can be retrieved and managed via the <aclass="reference internal"href="#com.vmware.content_client.LocalLibrary"title="com.vmware.content_client.LocalLibrary"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LocalLibrary</span></code></a>.</p>
<codeclass="descname">SUBSCRIBED</code><emclass="property"> = LibraryType(string='SUBSCRIBED')</em><aclass="headerlink"href="#com.vmware.content_client.LibraryModel.LibraryType.SUBSCRIBED"title="Permalink to this definition">¶</a></dt>
<dd><p>The library synchronizes its items and content from another published
library.</p>
<p>A subscribed library can be retrieved and managed via the
<emclass="property">class </em><codeclass="descclassname">com.vmware.content_client.</code><codeclass="descname">LocalLibrary</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content_client.LocalLibrary"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">LocalLibrary</span></code> class manages local libraries.</p>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">LocalLibrary</span></code> class provides support for creating and maintaining
local library instances. A local library may also use the <aclass="reference internal"href="#com.vmware.content_client.Library"title="com.vmware.content_client.Library"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Library</span></code></a>
class to manage general library functionality.</p>
<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">DestinationSpec</code><spanclass="sig-paren">(</span><em>subscription=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content_client.LocalLibrary.DestinationSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">LocalLibrary.DestinationSpec</span></code> class contains information required to
publish the library to a specific subscription. This class was added in
vSphere API 6.7.2.</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"><p><strong>subscription</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the subscription associated with the subscribed
library. This attribute was added in vSphere API 6.7.2.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.content.library.Subscriptions</span></code>. When methods return a
value of this class as a return value, the attribute will be an
<codeclass="descname">create</code><spanclass="sig-paren">(</span><em>create_spec</em>, <em>client_token=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content_client.LocalLibrary.create"title="Permalink to this definition">¶</a></dt>
<li><p><strong>client_token</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A unique token generated on the client for each creation request.
If not specified creation is not idempotent.</p></li>
<li><p><strong>create_spec</strong> (<aclass="reference internal"href="#com.vmware.content_client.LibraryModel"title="com.vmware.content_client.LibraryModel"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryModel</span></code></a>) – Specification for the new local library.</p></li>
<ddclass="field-odd"><p>Identifier of the newly created <aclass="reference internal"href="#com.vmware.content_client.LibraryModel"title="com.vmware.content_client.LibraryModel"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryModel</span></code></a>.
<codeclass="descname">delete</code><spanclass="sig-paren">(</span><em>library_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content_client.LocalLibrary.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Deletes the specified local library.</p>
<p>Deleting a local library will remove the entry immediately and begin an
asynchronous task to remove all cached content for the library. If the
asynchronous task fails, file content may remain on the storage
backing. This content will require manual removal.</p>
<ddclass="field-odd"><p><strong>library_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the local library to delete.
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>library_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content_client.LocalLibrary.get"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>library_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the local library to return.
<codeclass="descname">list</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content_client.LocalLibrary.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the identifiers of all local libraries in the Content Library.</p>
<ddclass="field-even"><p>The <aclass="reference internal"href="#com.vmware.content_client.LocalLibrary.list"title="com.vmware.content_client.LocalLibrary.list"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code></a> of identifiers of all local libraries in the
<codeclass="descname">publish</code><spanclass="sig-paren">(</span><em>library_id</em>, <em>subscriptions=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content_client.LocalLibrary.publish"title="Permalink to this definition">¶</a></dt>
<dd><p>Publishes the library to specified subscriptions. If no subscriptions
are specified, then publishes the library to all its subscriptions.
This method was added in vSphere API 6.7.2.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>library_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the published library.
The parameter must be an identifier for the resource type:
<li><p><strong>subscriptions</strong> (<aclass="reference internal"href="#com.vmware.content_client.LocalLibrary.list"title="com.vmware.content_client.LocalLibrary.list"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code></a> of <aclass="reference internal"href="#com.vmware.content_client.LocalLibrary.DestinationSpec"title="com.vmware.content_client.LocalLibrary.DestinationSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LocalLibrary.DestinationSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The list of subscriptions to publish this library to.</p></li>
<codeclass="descname">update</code><spanclass="sig-paren">(</span><em>library_id</em>, <em>update_spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content_client.LocalLibrary.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Updates the properties of a local library.</p>
<p>This is an incremental update to the local library. Attributes that are
None in the update specification will be left unchanged.</p>
<li><p><strong>library_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the local library to update.
<li><p><strong>update_spec</strong> (<aclass="reference internal"href="#com.vmware.content_client.LibraryModel"title="com.vmware.content_client.LibraryModel"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryModel</span></code></a>) – Specification of the new property values to set on the local
if the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">LibraryModel.version</span></code> of <codeclass="docutils literal notranslate"><spanclass="pre">update_spec</span></code> is None and
the library is being concurrently updated by another user.</p>
if the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">LibraryModel.version</span></code> of <codeclass="docutils literal notranslate"><spanclass="pre">update_spec</span></code> is not equal
<emclass="property">class </em><codeclass="descclassname">com.vmware.content_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.content_client.</code><codeclass="descname">SubscribedLibrary</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content_client.SubscribedLibrary"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">ProbeResult</code><spanclass="sig-paren">(</span><em>status=None</em>, <em>ssl_thumbprint=None</em>, <em>error_messages=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content_client.SubscribedLibrary.ProbeResult"title="Permalink to this definition">¶</a></dt>
<li><p><strong>status</strong> (<aclass="reference internal"href="#com.vmware.content_client.SubscribedLibrary.ProbeResult.Status"title="com.vmware.content_client.SubscribedLibrary.ProbeResult.Status"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SubscribedLibrary.ProbeResult.Status</span></code></a>) – The status of probe result. This will be one of SUCCESS,
<li><p><strong>ssl_thumbprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The SSL thumbprint for the remote endpoint.
<li><p><strong>error_messages</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – If the probe result is in an error status, this attribute will
<emclass="property">class </em><codeclass="descname">Status</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content_client.SubscribedLibrary.ProbeResult.Status"title="Permalink to this definition">¶</a></dt>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">CERTIFICATE_ERROR</code><emclass="property"> = Status(string='CERTIFICATE_ERROR')</em><aclass="headerlink"href="#com.vmware.content_client.SubscribedLibrary.ProbeResult.Status.CERTIFICATE_ERROR"title="Permalink to this definition">¶</a></dt>
<dd><p>Indicates that the provided server certificate thumbprint in
<codeclass="descname">HOST_NOT_FOUND</code><emclass="property"> = Status(string='HOST_NOT_FOUND')</em><aclass="headerlink"href="#com.vmware.content_client.SubscribedLibrary.ProbeResult.Status.HOST_NOT_FOUND"title="Permalink to this definition">¶</a></dt>
<dd><p>Indicates that the host in the URL could not be found.</p>
<codeclass="descname">INVALID_CREDENTIALS</code><emclass="property"> = Status(string='INVALID_CREDENTIALS')</em><aclass="headerlink"href="#com.vmware.content_client.SubscribedLibrary.ProbeResult.Status.INVALID_CREDENTIALS"title="Permalink to this definition">¶</a></dt>
<dd><p>Indicates that the connection was rejected due to invalid credentials.</p>
<codeclass="descname">INVALID_URL</code><emclass="property"> = Status(string='INVALID_URL')</em><aclass="headerlink"href="#com.vmware.content_client.SubscribedLibrary.ProbeResult.Status.INVALID_URL"title="Permalink to this definition">¶</a></dt>
<dd><p>Indicates that the supplied URL was not valid.</p>
<codeclass="descname">RESOURCE_NOT_FOUND</code><emclass="property"> = Status(string='RESOURCE_NOT_FOUND')</em><aclass="headerlink"href="#com.vmware.content_client.SubscribedLibrary.ProbeResult.Status.RESOURCE_NOT_FOUND"title="Permalink to this definition">¶</a></dt>
<dd><p>Indicates that the given resource at the URL was not found.</p>
<codeclass="descname">SUCCESS</code><emclass="property"> = Status(string='SUCCESS')</em><aclass="headerlink"href="#com.vmware.content_client.SubscribedLibrary.ProbeResult.Status.SUCCESS"title="Permalink to this definition">¶</a></dt>
<dd><p>Indicates that the probe was successful.</p>
<codeclass="descname">TIMED_OUT</code><emclass="property"> = Status(string='TIMED_OUT')</em><aclass="headerlink"href="#com.vmware.content_client.SubscribedLibrary.ProbeResult.Status.TIMED_OUT"title="Permalink to this definition">¶</a></dt>
<dd><p>Indicates that the probe timed out while attempting to connect to the URL.</p>
<codeclass="descname">UNKNOWN_ERROR</code><emclass="property"> = Status(string='UNKNOWN_ERROR')</em><aclass="headerlink"href="#com.vmware.content_client.SubscribedLibrary.ProbeResult.Status.UNKNOWN_ERROR"title="Permalink to this definition">¶</a></dt>
<dd><p>Indicates an unspecified error different from the other error cases defined
in <aclass="reference internal"href="#com.vmware.content_client.SubscribedLibrary.ProbeResult.Status"title="com.vmware.content_client.SubscribedLibrary.ProbeResult.Status"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SubscribedLibrary.ProbeResult.Status</span></code></a>.</p>
<codeclass="descname">create</code><spanclass="sig-paren">(</span><em>create_spec</em>, <em>client_token=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content_client.SubscribedLibrary.create"title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a new subscribed library.</p>
<p>Once created, the subscribed library will be empty. If the
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">LibraryModel.subscription_info</span></code> property is set, the Content
Library Service will attempt to synchronize to the remote source. This
is an asynchronous operation so the content of the published library
<li><p><strong>client_token</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Unique token generated on the client for each creation request. The
If not specified creation is not idempotent.</p></li>
<li><p><strong>create_spec</strong> (<aclass="reference internal"href="#com.vmware.content_client.LibraryModel"title="com.vmware.content_client.LibraryModel"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryModel</span></code></a>) – Specification for the new subscribed library.</p></li>
<codeclass="descname">delete</code><spanclass="sig-paren">(</span><em>library_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content_client.SubscribedLibrary.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Deletes the specified subscribed library.</p>
<p>Deleting a subscribed library will remove the entry immediately and
begin an asynchronous task to remove all cached content for the
library. If the asynchronous task fails, file content may remain on the
storage backing. This content will require manual removal.</p>
<ddclass="field-odd"><p><strong>library_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the subscribed library to delete.
<codeclass="descname">evict</code><spanclass="sig-paren">(</span><em>library_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content_client.SubscribedLibrary.evict"title="Permalink to this definition">¶</a></dt>
<dd><p>Evicts the cached content of an on-demand subscribed library.</p>
<p>This method allows the cached content of a subscribed library to be
removed to free up storage capacity. This method will only work when a
<ddclass="field-odd"><p><strong>library_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the subscribed library whose content should be
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>library_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content_client.SubscribedLibrary.get"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>library_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the subscribed library to return.
<codeclass="descname">list</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content_client.SubscribedLibrary.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the identifiers of all subscribed libraries in the Content
<ddclass="field-even"><p>The <aclass="reference internal"href="#com.vmware.content_client.SubscribedLibrary.list"title="com.vmware.content_client.SubscribedLibrary.list"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code></a> of identifiers of all subscribed libraries in the
<codeclass="descname">probe</code><spanclass="sig-paren">(</span><em>subscription_info</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content_client.SubscribedLibrary.probe"title="Permalink to this definition">¶</a></dt>
<dd><p>Probes remote library subscription information, including URL, SSL
certificate and password. The resulting
<aclass="reference internal"href="#com.vmware.content_client.SubscribedLibrary.ProbeResult"title="com.vmware.content_client.SubscribedLibrary.ProbeResult"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SubscribedLibrary.ProbeResult</span></code></a> class describes whether or not
<ddclass="field-odd"><p><strong>subscription_info</strong> (<aclass="reference internal"href="com.vmware.content.html#com.vmware.content.library_client.SubscriptionInfo"title="com.vmware.content.library_client.SubscriptionInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.content.library_client.SubscriptionInfo</span></code></a>) – The subscription info to be probed.</p>
<codeclass="descname">sync</code><spanclass="sig-paren">(</span><em>library_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content_client.SubscribedLibrary.sync"title="Permalink to this definition">¶</a></dt>
<dd><p>Forces the synchronization of the subscribed library.</p>
<p>Synchronizing a subscribed library forcefully with this method will
perform the same synchronization behavior as would run periodically for
<ddclass="field-odd"><p><strong>library_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the subscribed library to synchronize.
<codeclass="descname">update</code><spanclass="sig-paren">(</span><em>library_id</em>, <em>update_spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content_client.SubscribedLibrary.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Updates the properties of a subscribed library.</p>
<p>This is an incremental update to the subscribed library. Attributes
that are None in the update specification will be left unchanged.</p>
<li><p><strong>library_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the subscribed library to update.
<li><p><strong>update_spec</strong> (<aclass="reference internal"href="#com.vmware.content_client.LibraryModel"title="com.vmware.content_client.LibraryModel"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryModel</span></code></a>) – Specification of the new property values to set on the subscribed
if the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">LibraryModel.version</span></code> of <codeclass="docutils literal notranslate"><spanclass="pre">update_spec</span></code> is None and
the library is being concurrently updated by another user.</p>
if the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">LibraryModel.version</span></code> of <codeclass="docutils literal notranslate"><spanclass="pre">update_spec</span></code> is not equal
<emclass="property">class </em><codeclass="descclassname">com.vmware.content_client.</code><codeclass="descname">Type</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content_client.Type"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Type</span></code> class exposes the
<aclass="reference internal"href="com.vmware.content.html#com.vmware.content.library_client.ItemModel"title="com.vmware.content.library_client.ItemModel"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.content.library_client.ItemModel</span></code></a> types that this
Content Library Service supports.</p>
<p>A library item has an optional type which can be specified with the
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">com.vmware.content.library_client.ItemModel.type</span></code> attribute. For
items with a type that is supported by a plugin, the Content Library
Service may understand the files which are part of the library item and can
produce metadata for the item.</p>
<p>In other cases, uploads may require a process in which one upload implies
subsequent uploads. For example, an Open Virtualization Format (OVF)
package is composed of an OVF descriptor file and the associated virtual
disk files. Uploading an OVF descriptor can enable the Content Library
Service to understand that the complete OVF package requires additional
disk files, and it can set up the transfers for the disks automatically by
adding the file entries for the disks when the OVF descriptor is uploaded.</p>
<p>When a type is not supported by a plugin, or the type is not specified, the
Content Library Service can handle a library item in a default way, without
adding metadata to the item or guiding the upload process.</p>
<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">Info</code><spanclass="sig-paren">(</span><em>description=None</em>, <em>name=None</em>, <em>type=None</em>, <em>vendor=None</em>, <em>version=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content_client.Type.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Type.Info</span></code> class describes support for a specific type of data in an
<aclass="reference internal"href="com.vmware.content.html#com.vmware.content.library_client.ItemModel"title="com.vmware.content.library_client.ItemModel"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.content.library_client.ItemModel</span></code></a>. The <codeclass="docutils literal notranslate"><spanclass="pre">Type.Info</span></code> can
be queried through the <aclass="reference internal"href="#com.vmware.content_client.Type"title="com.vmware.content_client.Type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Type</span></code></a> class. Type support describes plugins
in the Content Library which can provide metadata on library items and help
manage the transfer process by adding dependent files when a current file
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – A description of the type support offered by the plugin.</p></li>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the plugin which provides the type support.</p></li>
<li><p><strong>type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) –<p>The type which the plugin supports.</p>
<li><p><strong>vendor</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the vendor who created the type support plugin.</p></li>
<li><p><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The version number of the type support plugin.</p></li>
<codeclass="descname">list</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content_client.Type.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a <aclass="reference internal"href="#com.vmware.content_client.Type.list"title="com.vmware.content_client.Type.list"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code></a> of <aclass="reference internal"href="#com.vmware.content_client.Type.Info"title="com.vmware.content_client.Type.Info"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Type.Info</span></code></a> instances which describe
the type support plugins in this Content Library.</p>
<spanid="com-vmware-vapi-client-module"></span><h2>com.vmware.vapi_client module<aclass="headerlink"href="#module-com.vmware.vapi_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi_client</span></code> component provides API infrastructure classes
and standard types that can be used in the interface specification of any
class.</p>
<dlclass="class">
<dtid="com.vmware.vapi_client.StubFactory">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-vcenter-client-module"></span><h2>com.vmware.vcenter_client module<aclass="headerlink"href="#module-com.vmware.vcenter_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter_client</span></code> module provides classes for managing VMware
vSphere environments. The module is available starting in vSphere 6.5.</p>
<dlclass="class">
<dtid="com.vmware.vcenter_client.Cluster">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter_client.</code><codeclass="descname">Cluster</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.Cluster"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">FilterSpec</code><spanclass="sig-paren">(</span><em>clusters=None</em>, <em>names=None</em>, <em>folders=None</em>, <em>datacenters=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.Cluster.FilterSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cluster.FilterSpec</span></code> class contains attributes used to filter the
results when listing clusters (see <aclass="reference internal"href="#com.vmware.vcenter_client.Cluster.list"title="com.vmware.vcenter_client.Cluster.list"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Cluster.list()</span></code></a>). If multiple
attributes are specified, only clusters matching all of the attributes
<li><p><strong>clusters</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifiers of clusters that can match the filter.
If None or empty, clusters with any identifier match the filter.</p></li>
<li><p><strong>names</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Names that clusters must have to match the filter (see
If None or empty, clusters with any name match the filter.</p></li>
<li><p><strong>folders</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Folders that must contain the cluster for the cluster to match the
If None or empty, clusters in any folder match the filter.</p></li>
<li><p><strong>datacenters</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Datacenters that must contain the cluster for the cluster to match
<emclass="property">class </em><codeclass="descname">Info</code><spanclass="sig-paren">(</span><em>name=None</em>, <em>resource_pool=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.Cluster.Info"title="Permalink to this definition">¶</a></dt>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the cluster</p></li>
<li><p><strong>resource_pool</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the root resource pool of the cluster
<codeclass="descname">RESOURCE_TYPE</code><emclass="property"> = 'ClusterComputeResource'</em><aclass="headerlink"href="#com.vmware.vcenter_client.Cluster.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<dd><p>The resource type for the vCenter Cluster</p>
<emclass="property">class </em><codeclass="descname">Summary</code><spanclass="sig-paren">(</span><em>cluster=None</em>, <em>name=None</em>, <em>ha_enabled=None</em>, <em>drs_enabled=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.Cluster.Summary"title="Permalink to this definition">¶</a></dt>
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the cluster.</p></li>
<li><p><strong>ha_enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag indicating whether the vSphere HA feature is enabled for the
cluster.</p></li>
<li><p><strong>drs_enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag indicating whether the vSphere DRS service is enabled for the
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>cluster</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.Cluster.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieves information about the cluster corresponding to <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code>.</p>
<ddclass="field-odd"><p>The <aclass="reference internal"href="#com.vmware.vcenter_client.Cluster.Info"title="com.vmware.vcenter_client.Cluster.Info"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.Info</span></code></a> instances that corresponds to the
<codeclass="descname">list</code><spanclass="sig-paren">(</span><em>filter=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.Cluster.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about at most 1000 visible (subject to permission
checks) clusters in vCenter matching the <aclass="reference internal"href="#com.vmware.vcenter_client.Cluster.FilterSpec"title="com.vmware.vcenter_client.Cluster.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.FilterSpec</span></code></a>.</p>
<ddclass="field-odd"><p><strong>filter</strong> (<aclass="reference internal"href="#com.vmware.vcenter_client.Cluster.FilterSpec"title="com.vmware.vcenter_client.Cluster.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.FilterSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specification of matching clusters for which information should be
<aclass="reference internal"href="#com.vmware.vcenter_client.Cluster.FilterSpec"title="com.vmware.vcenter_client.Cluster.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.FilterSpec</span></code></a> with all attributes None which means
if more than 1000 clusters match the <aclass="reference internal"href="#com.vmware.vcenter_client.Cluster.FilterSpec"title="com.vmware.vcenter_client.Cluster.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.FilterSpec</span></code></a>.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter_client.</code><codeclass="descname">Datacenter</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.Datacenter"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">CreateSpec</code><spanclass="sig-paren">(</span><em>name=None</em>, <em>folder=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.Datacenter.CreateSpec"title="Permalink to this definition">¶</a></dt>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the datacenter to be created.</p></li>
<li><p><strong>folder</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Datacenter folder in which the new datacenter should be created.
<emclass="property">class </em><codeclass="descname">FilterSpec</code><spanclass="sig-paren">(</span><em>datacenters=None</em>, <em>names=None</em>, <em>folders=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.Datacenter.FilterSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Datacenter.FilterSpec</span></code> class contains attributes used to filter the
results when listing datacenters (see <aclass="reference internal"href="#com.vmware.vcenter_client.Datacenter.list"title="com.vmware.vcenter_client.Datacenter.list"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Datacenter.list()</span></code></a>). If multiple
attributes are specified, only datacenters matching all of the attributes
<li><p><strong>datacenters</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifiers of datacenters that can match the filter.
If None or empty, datacenters with any identifier match the filter.</p></li>
<li><p><strong>names</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Names that datacenters must have to match the filter (see
If None or empty, datacenters with any name match the filter.</p></li>
<li><p><strong>folders</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Folders that must contain the datacenters for the datacenter to
<emclass="property">class </em><codeclass="descname">Info</code><spanclass="sig-paren">(</span><em>name=None</em>, <em>datastore_folder=None</em>, <em>host_folder=None</em>, <em>network_folder=None</em>, <em>vm_folder=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.Datacenter.Info"title="Permalink to this definition">¶</a></dt>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the datacenter.</p></li>
<li><p><strong>datastore_folder</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The root datastore folder associated with the datacenter.
attribute will be an identifier for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">Folder</span></code>.</p></li>
<li><p><strong>host_folder</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The root host and cluster folder associated with the datacenter.
<codeclass="descname">RESOURCE_TYPE</code><emclass="property"> = 'Datacenter'</em><aclass="headerlink"href="#com.vmware.vcenter_client.Datacenter.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<dd><p>The resource type for the vCenter Datacenter</p>
<emclass="property">class </em><codeclass="descname">Summary</code><spanclass="sig-paren">(</span><em>datacenter=None</em>, <em>name=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.Datacenter.Summary"title="Permalink to this definition">¶</a></dt>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the datacenter.</p></li>
<codeclass="descname">create</code><spanclass="sig-paren">(</span><em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.Datacenter.create"title="Permalink to this definition">¶</a></dt>
<dd><p>Create a new datacenter in the vCenter inventory</p>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter_client.Datacenter.CreateSpec"title="com.vmware.vcenter_client.Datacenter.CreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Datacenter.CreateSpec</span></code></a>) – Specification for the new datacenter to be created.</p>
<codeclass="descname">delete</code><spanclass="sig-paren">(</span><em>datacenter</em>, <em>force=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.Datacenter.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Delete an empty datacenter from the vCenter Server</p>
<li><p><strong>datacenter</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the datacenter to be deleted.
<li><p><strong>force</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – If true, delete the datacenter even if it is not empty.
If None a <aclass="reference internal"href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInUse"title="com.vmware.vapi.std.errors_client.ResourceInUse"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std.errors_client.ResourceInUse</span></code></a>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>datacenter</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.Datacenter.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieves information about the datacenter corresponding to
<ddclass="field-odd"><p>The <aclass="reference internal"href="#com.vmware.vcenter_client.Datacenter.Info"title="com.vmware.vcenter_client.Datacenter.Info"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Datacenter.Info</span></code></a> instances that corresponds to the
<codeclass="descname">list</code><spanclass="sig-paren">(</span><em>filter=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.Datacenter.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about at most 1000 visible (subject to permission
<ddclass="field-odd"><p><strong>filter</strong> (<aclass="reference internal"href="#com.vmware.vcenter_client.Datacenter.FilterSpec"title="com.vmware.vcenter_client.Datacenter.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Datacenter.FilterSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specification of matching datacenters for which information should
<aclass="reference internal"href="#com.vmware.vcenter_client.Datacenter.FilterSpec"title="com.vmware.vcenter_client.Datacenter.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Datacenter.FilterSpec</span></code></a> with all attributes None which means
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter_client.</code><codeclass="descname">Datastore</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.Datastore"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">FilterSpec</code><spanclass="sig-paren">(</span><em>datastores=None</em>, <em>names=None</em>, <em>types=None</em>, <em>folders=None</em>, <em>datacenters=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.Datastore.FilterSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Datastore.FilterSpec</span></code> class contains attributes used to filter the
results when listing datastores (see <aclass="reference internal"href="#com.vmware.vcenter_client.Datastore.list"title="com.vmware.vcenter_client.Datastore.list"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Datastore.list()</span></code></a>). If multiple
attributes are specified, only datastores matching all of the attributes
<li><p><strong>datastores</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifiers of datastores that can match the filter.
If None or empty, datastores with any identifier match the filter.</p></li>
<li><p><strong>names</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Names that datastores must have to match the filter (see
If None or empty, datastores with any name match the filter.</p></li>
<li><p><strong>types</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <aclass="reference internal"href="#com.vmware.vcenter_client.Datastore.Type"title="com.vmware.vcenter_client.Datastore.Type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Datastore.Type</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Types that datastores must have to match the filter (see
If None or empty, datastores with any type match the filter.</p></li>
<li><p><strong>folders</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Folders that must contain the datastore for the datastore to match
If None or empty, datastores in any folder match the filter.</p></li>
<li><p><strong>datacenters</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Datacenters that must contain the datastore for the datastore to
<emclass="property">class </em><codeclass="descname">Info</code><spanclass="sig-paren">(</span><em>name=None</em>, <em>type=None</em>, <em>accessible=None</em>, <em>free_space=None</em>, <em>multiple_host_access=None</em>, <em>thin_provisioning_supported=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.Datastore.Info"title="Permalink to this definition">¶</a></dt>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the datastore.</p></li>
<li><p><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter_client.Datastore.Type"title="com.vmware.vcenter_client.Datastore.Type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Datastore.Type</span></code></a>) – Type (VMFS, NFS, NFS41, CIFS, VSAN, VFFS, VVOL) of the datastore.</p></li>
<li><p><strong>accessible</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Whether or not this datastore is accessible.</p></li>
<li><p><strong>free_space</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Available space of this datastore, in bytes.</p>
<li><p><strong>multiple_host_access</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Whether or not ore than one host in the datacenter has been
configured with access to the datastore.</p></li>
<li><p><strong>thin_provisioning_supported</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Whether or not the datastore supports thin provisioning on a per
<codeclass="descname">RESOURCE_TYPE</code><emclass="property"> = 'Datastore'</em><aclass="headerlink"href="#com.vmware.vcenter_client.Datastore.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<dd><p>The resource type for the vCenter datastore</p>
<emclass="property">class </em><codeclass="descname">Summary</code><spanclass="sig-paren">(</span><em>datastore=None</em>, <em>name=None</em>, <em>type=None</em>, <em>free_space=None</em>, <em>capacity=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.Datastore.Summary"title="Permalink to this definition">¶</a></dt>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the datastore.</p></li>
<li><p><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter_client.Datastore.Type"title="com.vmware.vcenter_client.Datastore.Type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Datastore.Type</span></code></a>) – Type (VMFS, NFS, NFS41, CIFS, VSAN, VFFS, VVOL) of the datatore.</p></li>
<li><p><strong>free_space</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Available space of this datastore, in bytes.</p>
<li><p><strong>capacity</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Capacity of this datastore, in bytes.</p>
<emclass="property">class </em><codeclass="descname">Type</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.Datastore.Type"title="Permalink to this definition">¶</a></dt>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">CIFS</code><emclass="property"> = Type(string='CIFS')</em><aclass="headerlink"href="#com.vmware.vcenter_client.Datastore.Type.CIFS"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">NFS</code><emclass="property"> = Type(string='NFS')</em><aclass="headerlink"href="#com.vmware.vcenter_client.Datastore.Type.NFS"title="Permalink to this definition">¶</a></dt>
<dd><p>Network file system v3 (linux & esx servers only).</p>
<codeclass="descname">NFS41</code><emclass="property"> = Type(string='NFS41')</em><aclass="headerlink"href="#com.vmware.vcenter_client.Datastore.Type.NFS41"title="Permalink to this definition">¶</a></dt>
<dd><p>Network file system v4.1 (linux & esx servers only).</p>
<codeclass="descname">VFFS</code><emclass="property"> = Type(string='VFFS')</em><aclass="headerlink"href="#com.vmware.vcenter_client.Datastore.Type.VFFS"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">VMFS</code><emclass="property"> = Type(string='VMFS')</em><aclass="headerlink"href="#com.vmware.vcenter_client.Datastore.Type.VMFS"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">VSAN</code><emclass="property"> = Type(string='VSAN')</em><aclass="headerlink"href="#com.vmware.vcenter_client.Datastore.Type.VSAN"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">VVOL</code><emclass="property"> = Type(string='VVOL')</em><aclass="headerlink"href="#com.vmware.vcenter_client.Datastore.Type.VVOL"title="Permalink to this definition">¶</a></dt>
<dd><p>vSphere Virtual Volume (ESX Server only).</p>
</dd></dl>
</dd></dl>
<dlclass="method">
<dtid="com.vmware.vcenter_client.Datastore.get">
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>datastore</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.Datastore.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieves information about the datastore indicated by <codeclass="docutils literal notranslate"><spanclass="pre">datastore</span></code>.</p>
<ddclass="field-odd"><p><strong>datastore</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the datastore for which information should be
<codeclass="descname">list</code><spanclass="sig-paren">(</span><em>filter=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.Datastore.list"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>filter</strong> (<aclass="reference internal"href="#com.vmware.vcenter_client.Datastore.FilterSpec"title="com.vmware.vcenter_client.Datastore.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Datastore.FilterSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specification of matching datastores for which information should
<aclass="reference internal"href="#com.vmware.vcenter_client.Datastore.FilterSpec"title="com.vmware.vcenter_client.Datastore.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Datastore.FilterSpec</span></code></a> with all attributes None which means
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter_client.</code><codeclass="descname">Deployment</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.Deployment"title="Permalink to this definition">¶</a></dt>
appliance deployment. This class was added in vSphere API 6.7.</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>
<li><p><strong>state</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.deployment_client.ApplianceState"title="com.vmware.vcenter.deployment_client.ApplianceState"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.deployment_client.ApplianceState</span></code></a>) – State of the vCenter Server Appliance. This attribute was added in
vSphere API 6.7.</p></li>
<li><p><strong>progress</strong> (<aclass="reference internal"href="com.vmware.cis.html#com.vmware.cis.task_client.Progress"title="com.vmware.cis.task_client.Progress"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.cis.task_client.Progress</span></code></a>) – The progress info of the current appliance status. This attribute
<li><p><strong>subtask_order</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The ordered list of subtasks for this deployment operation. This
<li><p><strong>subtasks</strong> ((<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.vcenter_client.Deployment.Task"title="com.vmware.vcenter_client.Deployment.Task"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Deployment.Task</span></code></a>) or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The map of the deployment subtasks and their status infomation.
<li><p><strong>description</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Description of the operation associated with the task.</p></li>
<li><p><strong>service</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the service containing the operation.
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.service</span></code>.</p></li>
<li><p><strong>operation</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the operation associated with the task.
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.operation</span></code>.</p></li>
<li><p><strong>parent</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Parent of the current task.
This attribute will be None if the task has no parent.</p></li>
<li><p><strong>target</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID"title="com.vmware.vapi.std_client.DynamicID"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifier of the target created by the operation or an existing
<li><p><strong>status</strong> (<aclass="reference internal"href="com.vmware.cis.html#com.vmware.cis.task_client.Status"title="com.vmware.cis.task_client.Status"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.cis.task_client.Status</span></code></a>) – Status of the operation associated with the task.</p></li>
<li><p><strong>cancelable</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag to indicate whether or not the operation can be cancelled. The
value may change as the operation progresses.</p></li>
<li><p><strong>error</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Exception</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Description of the error if the operation status is “FAILED”.
<li><p><strong>start_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Time when the operation is started.
<li><p><strong>end_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Time when the operation is completed.
<li><p><strong>user</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name of the user who performed the operation.
<li><p><strong>progress</strong> (<aclass="reference internal"href="com.vmware.cis.html#com.vmware.cis.task_client.Progress"title="com.vmware.cis.task_client.Progress"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.cis.task_client.Progress</span></code></a>) – The progress info of this deployment task. This attribute was added
<li><p><strong>result</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.deployment_client.Notifications"title="com.vmware.vcenter.deployment_client.Notifications"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.deployment_client.Notifications</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Result of the task. This attribute was added in vSphere API 6.7.
<li><p><strong>description</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Description of the operation associated with the task.</p></li>
<li><p><strong>service</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the service containing the operation.
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.service</span></code>.</p></li>
<li><p><strong>operation</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the operation associated with the task.
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.operation</span></code>.</p></li>
<li><p><strong>parent</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Parent of the current task.
This attribute will be None if the task has no parent.</p></li>
<li><p><strong>target</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID"title="com.vmware.vapi.std_client.DynamicID"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifier of the target created by the operation or an existing
<li><p><strong>status</strong> (<aclass="reference internal"href="com.vmware.cis.html#com.vmware.cis.task_client.Status"title="com.vmware.cis.task_client.Status"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.cis.task_client.Status</span></code></a>) – Status of the operation associated with the task.</p></li>
<li><p><strong>cancelable</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag to indicate whether or not the operation can be cancelled. The
value may change as the operation progresses.</p></li>
<li><p><strong>error</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Exception</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Description of the error if the operation status is “FAILED”.
<li><p><strong>start_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Time when the operation is started.
<li><p><strong>end_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Time when the operation is completed.
<li><p><strong>user</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name of the user who performed the operation.
<codeclass="descname">get</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.Deployment.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Get the current status of the appliance deployment. This method was
<codeclass="descname">rollback</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.Deployment.rollback"title="Permalink to this definition">¶</a></dt>
<dd><p>Rollback a failed appliance so it can be configured once again. This
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter_client.</code><codeclass="descname">Folder</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.Folder"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">FilterSpec</code><spanclass="sig-paren">(</span><em>folders=None</em>, <em>names=None</em>, <em>type=None</em>, <em>parent_folders=None</em>, <em>datacenters=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.Folder.FilterSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Folder.FilterSpec</span></code> class contains attributes used to filter the
results when listing folders (see <aclass="reference internal"href="#com.vmware.vcenter_client.Folder.list"title="com.vmware.vcenter_client.Folder.list"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Folder.list()</span></code></a>). If multiple
attributes are specified, only folders matching all of the attributes match
<li><p><strong>folders</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifiers of folders that can match the filter.
If None or empty, folders with any identifier match the filter.</p></li>
<li><p><strong>names</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Names that folders must have to match the filter (see
If None or empty, folders with any name match the filter.</p></li>
<li><p><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter_client.Folder.Type"title="com.vmware.vcenter_client.Folder.Type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Folder.Type</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Type that folders must have to match the filter (see
If None, folders with any type match the filter.</p></li>
<li><p><strong>parent_folders</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Folders that must contain the folder for the folder to match the
If None or empty, folder in any folder match the filter.</p></li>
<li><p><strong>datacenters</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Datacenters that must contain the folder for the folder to match
<codeclass="descname">RESOURCE_TYPE</code><emclass="property"> = 'Folder'</em><aclass="headerlink"href="#com.vmware.vcenter_client.Folder.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<dd><p>The resource type for the vCenter folder</p>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vcenter_client.Folder.Summary">
<emclass="property">class </em><codeclass="descname">Summary</code><spanclass="sig-paren">(</span><em>folder=None</em>, <em>name=None</em>, <em>type=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.Folder.Summary"title="Permalink to this definition">¶</a></dt>
attribute will be an identifier for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">Folder</span></code>.</p></li>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the vCenter Server folder.</p></li>
<li><p><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter_client.Folder.Type"title="com.vmware.vcenter_client.Folder.Type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Folder.Type</span></code></a>) – Type (DATACENTER, DATASTORE, HOST, NETWORK, VIRTUAL_MACHINE) of the
<emclass="property">class </em><codeclass="descname">Type</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.Folder.Type"title="Permalink to this definition">¶</a></dt>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">DATACENTER</code><emclass="property"> = Type(string='DATACENTER')</em><aclass="headerlink"href="#com.vmware.vcenter_client.Folder.Type.DATACENTER"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DATASTORE</code><emclass="property"> = Type(string='DATASTORE')</em><aclass="headerlink"href="#com.vmware.vcenter_client.Folder.Type.DATASTORE"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">HOST</code><emclass="property"> = Type(string='HOST')</em><aclass="headerlink"href="#com.vmware.vcenter_client.Folder.Type.HOST"title="Permalink to this definition">¶</a></dt>
<dd><p>A folder that can contain compute resources (hosts and clusters).</p>
<codeclass="descname">NETWORK</code><emclass="property"> = Type(string='NETWORK')</em><aclass="headerlink"href="#com.vmware.vcenter_client.Folder.Type.NETWORK"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">VIRTUAL_MACHINE</code><emclass="property"> = Type(string='VIRTUAL_MACHINE')</em><aclass="headerlink"href="#com.vmware.vcenter_client.Folder.Type.VIRTUAL_MACHINE"title="Permalink to this definition">¶</a></dt>
<dd><p>A folder that can contain virtual machines.</p>
</dd></dl>
</dd></dl>
<dlclass="method">
<dtid="com.vmware.vcenter_client.Folder.list">
<codeclass="descname">list</code><spanclass="sig-paren">(</span><em>filter=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.Folder.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about at most 1000 visible (subject to permission
checks) folders in vCenter matching the <aclass="reference internal"href="#com.vmware.vcenter_client.Folder.FilterSpec"title="com.vmware.vcenter_client.Folder.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Folder.FilterSpec</span></code></a>.</p>
<ddclass="field-odd"><p><strong>filter</strong> (<aclass="reference internal"href="#com.vmware.vcenter_client.Folder.FilterSpec"title="com.vmware.vcenter_client.Folder.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Folder.FilterSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specification of matching folders for which information should be
If None, the behavior is equivalent to a <aclass="reference internal"href="#com.vmware.vcenter_client.Folder.FilterSpec"title="com.vmware.vcenter_client.Folder.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Folder.FilterSpec</span></code></a>
if more than 1000 folders match the <aclass="reference internal"href="#com.vmware.vcenter_client.Folder.FilterSpec"title="com.vmware.vcenter_client.Folder.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Folder.FilterSpec</span></code></a>.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter_client.</code><codeclass="descname">Host</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.Host"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">ConnectionState</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.Host.ConnectionState"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Host.ConnectionState</span></code> class defines the connection status of a host.</p>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">CONNECTED</code><emclass="property"> = ConnectionState(string='CONNECTED')</em><aclass="headerlink"href="#com.vmware.vcenter_client.Host.ConnectionState.CONNECTED"title="Permalink to this definition">¶</a></dt>
<dd><p>Host is connected to the vCenter Server</p>
<codeclass="descname">DISCONNECTED</code><emclass="property"> = ConnectionState(string='DISCONNECTED')</em><aclass="headerlink"href="#com.vmware.vcenter_client.Host.ConnectionState.DISCONNECTED"title="Permalink to this definition">¶</a></dt>
<dd><p>Host is disconnected from the vCenter Server</p>
<codeclass="descname">NOT_RESPONDING</code><emclass="property"> = ConnectionState(string='NOT_RESPONDING')</em><aclass="headerlink"href="#com.vmware.vcenter_client.Host.ConnectionState.NOT_RESPONDING"title="Permalink to this definition">¶</a></dt>
<dd><p>VirtualCenter is not receiving heartbeats from the server. The state
automatically changes to connected once heartbeats are received again.</p>
<li><p><strong>hostname</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The IP address or DNS resolvable name of the host.</p></li>
<li><p><strong>port</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The port of the host.
If None, port 443 will be used.</p></li>
<li><p><strong>user_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The administrator account on the host.</p></li>
<li><p><strong>password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The password for the administrator account on the host.</p></li>
<li><p><strong>folder</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Host and cluster folder in which the new standalone host should be
<li><p><strong>thumbprint_verification</strong> (<aclass="reference internal"href="#com.vmware.vcenter_client.Host.CreateSpec.ThumbprintVerification"title="com.vmware.vcenter_client.Host.CreateSpec.ThumbprintVerification"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Host.CreateSpec.ThumbprintVerification</span></code></a>) – Type of host’s SSL certificate verification to be done.</p></li>
<li><p><strong>thumbprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The thumbprint of the SSL certificate, which the host is expected
<li><p><strong>force_add</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Whether host should be added to the vCenter Server even if it is
<emclass="property">class </em><codeclass="descname">ThumbprintVerification</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.Host.CreateSpec.ThumbprintVerification"title="Permalink to this definition">¶</a></dt>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">NONE</code><emclass="property"> = ThumbprintVerification(string='NONE')</em><aclass="headerlink"href="#com.vmware.vcenter_client.Host.CreateSpec.ThumbprintVerification.NONE"title="Permalink to this definition">¶</a></dt>
<dd><p>Accept the host’s thumbprint without verifying it.</p>
<codeclass="descname">THUMBPRINT</code><emclass="property"> = ThumbprintVerification(string='THUMBPRINT')</em><aclass="headerlink"href="#com.vmware.vcenter_client.Host.CreateSpec.ThumbprintVerification.THUMBPRINT"title="Permalink to this definition">¶</a></dt>
<dd><p>Host’s SSL certificate verified by checking its thumbprint against the
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Host.FilterSpec</span></code> class contains attributes used to filter the
results when listing hosts (see <aclass="reference internal"href="#com.vmware.vcenter_client.Host.list"title="com.vmware.vcenter_client.Host.list"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Host.list()</span></code></a>). If multiple attributes
are specified, only hosts matching all of the attributes match the filter.</p>
<li><p><strong>hosts</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifiers of hosts that can match the filter.
If None or empty, hosts with any identifier match the filter.</p></li>
<li><p><strong>names</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Names that hosts must have to match the filter (see
If None or empty, hosts with any name match the filter.</p></li>
<li><p><strong>folders</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Folders that must contain the hosts for the hosts to match the
If None or empty, hosts in any folder match the filter.</p></li>
<li><p><strong>datacenters</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Datacenters that must contain the hosts for the hosts to match the
If None or empty, hosts in any datacenter match the filter.</p></li>
<li><p><strong>standalone</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – If true, only hosts that are not part of a cluster can match the
<li><p><strong>clusters</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Clusters that must contain the hosts for the hosts to match the
<li><p><strong>connection_states</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <aclass="reference internal"href="#com.vmware.vcenter_client.Host.ConnectionState"title="com.vmware.vcenter_client.Host.ConnectionState"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Host.ConnectionState</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Connection states that a host must be in to match the filter (see
<emclass="property">class </em><codeclass="descname">PowerState</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.Host.PowerState"title="Permalink to this definition">¶</a></dt>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">POWERED_OFF</code><emclass="property"> = PowerState(string='POWERED_OFF')</em><aclass="headerlink"href="#com.vmware.vcenter_client.Host.PowerState.POWERED_OFF"title="Permalink to this definition">¶</a></dt>
<dd><p>The host was specifically powered off by the user through vCenter server.
This state is not a cetain state, because after vCenter server issues the
command to power off the host, the host might crash, or kill all the
<codeclass="descname">POWERED_ON</code><emclass="property"> = PowerState(string='POWERED_ON')</em><aclass="headerlink"href="#com.vmware.vcenter_client.Host.PowerState.POWERED_ON"title="Permalink to this definition">¶</a></dt>
<dd><p>The host is powered on. A host that is entering standby mode is also in
<codeclass="descname">STANDBY</code><emclass="property"> = PowerState(string='STANDBY')</em><aclass="headerlink"href="#com.vmware.vcenter_client.Host.PowerState.STANDBY"title="Permalink to this definition">¶</a></dt>
<dd><p>The host was specifically put in standby mode, either explicitly by the
user, or automatically by DPM. This state is not a cetain state, because
after VirtualCenter issues the command to put the host in standby state,
the host might crash, or kill all the processes but fail to enter standby
mode. A host that is exiting standby mode is also in this state.</p>
<codeclass="descname">RESOURCE_TYPE</code><emclass="property"> = 'HostSystem'</em><aclass="headerlink"href="#com.vmware.vcenter_client.Host.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<dd><p>The resource type for the vCenter Host.</p>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vcenter_client.Host.Summary">
<emclass="property">class </em><codeclass="descname">Summary</code><spanclass="sig-paren">(</span><em>host=None</em>, <em>name=None</em>, <em>connection_state=None</em>, <em>power_state=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.Host.Summary"title="Permalink to this definition">¶</a></dt>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the host.</p></li>
<li><p><strong>connection_state</strong> (<aclass="reference internal"href="#com.vmware.vcenter_client.Host.ConnectionState"title="com.vmware.vcenter_client.Host.ConnectionState"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Host.ConnectionState</span></code></a>) – Connection status of the host</p></li>
<li><p><strong>power_state</strong> (<aclass="reference internal"href="#com.vmware.vcenter_client.Host.PowerState"title="com.vmware.vcenter_client.Host.PowerState"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Host.PowerState</span></code></a>) – Power state of the host
<codeclass="descname">connect</code><spanclass="sig-paren">(</span><em>host</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.Host.connect"title="Permalink to this definition">¶</a></dt>
<dd><p>Connect to the host corresponding to <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> previously added to the
<ddclass="field-odd"><p><strong>host</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the host to be reconnected.
<codeclass="descname">create</code><spanclass="sig-paren">(</span><em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.Host.create"title="Permalink to this definition">¶</a></dt>
<dd><p>Add a new standalone host in the vCenter inventory. The newly connected
host will be in connected state. The vCenter Server will verify the SSL
certificate before adding the host to its inventory. In the case where
the SSL certificate cannot be verified because the Certificate
Authority is not recognized or the certificate is self signed, the
vCenter Server will fall back to thumbprint verification mode as
defined by <aclass="reference internal"href="#com.vmware.vcenter_client.Host.CreateSpec.ThumbprintVerification"title="com.vmware.vcenter_client.Host.CreateSpec.ThumbprintVerification"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Host.CreateSpec.ThumbprintVerification</span></code></a>.</p>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter_client.Host.CreateSpec"title="com.vmware.vcenter_client.Host.CreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Host.CreateSpec</span></code></a>) – Specification for the new host to be created.</p>
<codeclass="descname">delete</code><spanclass="sig-paren">(</span><em>host</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.Host.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Remove a standalone host from the vCenter Server.</p>
<ddclass="field-odd"><p><strong>host</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the host to be deleted.
<codeclass="descname">disconnect</code><spanclass="sig-paren">(</span><em>host</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.Host.disconnect"title="Permalink to this definition">¶</a></dt>
<dd><p>Disconnect the host corresponding to <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> from the vCenter server</p>
<ddclass="field-odd"><p><strong>host</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the host to be disconnected.
<codeclass="descname">list</code><spanclass="sig-paren">(</span><em>filter=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.Host.list"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>filter</strong> (<aclass="reference internal"href="#com.vmware.vcenter_client.Host.FilterSpec"title="com.vmware.vcenter_client.Host.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Host.FilterSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specification of matching hosts for which information should be
If None, the behavior is equivalent to a <aclass="reference internal"href="#com.vmware.vcenter_client.Host.FilterSpec"title="com.vmware.vcenter_client.Host.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Host.FilterSpec</span></code></a>
if more than 2500 hosts match the <aclass="reference internal"href="#com.vmware.vcenter_client.Host.FilterSpec"title="com.vmware.vcenter_client.Host.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Host.FilterSpec</span></code></a>.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter_client.</code><codeclass="descname">Network</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.Network"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">FilterSpec</code><spanclass="sig-paren">(</span><em>networks=None</em>, <em>names=None</em>, <em>types=None</em>, <em>folders=None</em>, <em>datacenters=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.Network.FilterSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Network.FilterSpec</span></code> class contains attributes used to filter the
results when listing networks (see <aclass="reference internal"href="#com.vmware.vcenter_client.Network.list"title="com.vmware.vcenter_client.Network.list"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Network.list()</span></code></a>). If multiple
attributes are specified, only networks matching all of the attributes
<li><p><strong>networks</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifiers of networks that can match the filter.
If None or empty, networks with any identifier match the filter.</p></li>
<li><p><strong>names</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Names that networks must have to match the filter (see
If None or empty, networks with any name match the filter.</p></li>
<li><p><strong>types</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <aclass="reference internal"href="#com.vmware.vcenter_client.Network.Type"title="com.vmware.vcenter_client.Network.Type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Network.Type</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Types that networks must have to match the filter (see
If None, networks with any type match the filter.</p></li>
<li><p><strong>folders</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Folders that must contain the network for the network to match the
If None or empty, networks in any folder match the filter.</p></li>
<li><p><strong>datacenters</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Datacenters that must contain the network for the network to match
<codeclass="descname">RESOURCE_TYPE</code><emclass="property"> = 'Network'</em><aclass="headerlink"href="#com.vmware.vcenter_client.Network.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<dd><p>The resource type for the vCenter network</p>
<emclass="property">class </em><codeclass="descname">Summary</code><spanclass="sig-paren">(</span><em>network=None</em>, <em>name=None</em>, <em>type=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.Network.Summary"title="Permalink to this definition">¶</a></dt>
attribute will be an identifier for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">Network</span></code>.</p></li>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the network.</p></li>
<li><p><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter_client.Network.Type"title="com.vmware.vcenter_client.Network.Type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Network.Type</span></code></a>) – Type (STANDARD_PORTGROUP, DISTRIBUTED_PORTGROUP, OPAQUE_NETWORK) of
<emclass="property">class </em><codeclass="descname">Type</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.Network.Type"title="Permalink to this definition">¶</a></dt>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">DISTRIBUTED_PORTGROUP</code><emclass="property"> = Type(string='DISTRIBUTED_PORTGROUP')</em><aclass="headerlink"href="#com.vmware.vcenter_client.Network.Type.DISTRIBUTED_PORTGROUP"title="Permalink to this definition">¶</a></dt>
<dd><p>XXX: vCenter based (create and managed through vCenter)</p>
<codeclass="descname">OPAQUE_NETWORK</code><emclass="property"> = Type(string='OPAQUE_NETWORK')</em><aclass="headerlink"href="#com.vmware.vcenter_client.Network.Type.OPAQUE_NETWORK"title="Permalink to this definition">¶</a></dt>
<dd><p>A network for whose configuration is managed outside of vSphere. The
identifer and name of the network is made available through vSphere so that
host and virtual machine virtual ethernet devices can connect to them.</p>
<codeclass="descname">STANDARD_PORTGROUP</code><emclass="property"> = Type(string='STANDARD_PORTGROUP')</em><aclass="headerlink"href="#com.vmware.vcenter_client.Network.Type.STANDARD_PORTGROUP"title="Permalink to this definition">¶</a></dt>
<dd><p>XXX: ESX based (created and managed on ESX)</p>
</dd></dl>
</dd></dl>
<dlclass="method">
<dtid="com.vmware.vcenter_client.Network.list">
<codeclass="descname">list</code><spanclass="sig-paren">(</span><em>filter=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.Network.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about at most 1000 visible (subject to permission
checks) networks in vCenter matching the <aclass="reference internal"href="#com.vmware.vcenter_client.Network.FilterSpec"title="com.vmware.vcenter_client.Network.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Network.FilterSpec</span></code></a>.</p>
<ddclass="field-odd"><p><strong>filter</strong> (<aclass="reference internal"href="#com.vmware.vcenter_client.Network.FilterSpec"title="com.vmware.vcenter_client.Network.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Network.FilterSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specification of matching networks for which information should be
<aclass="reference internal"href="#com.vmware.vcenter_client.Network.FilterSpec"title="com.vmware.vcenter_client.Network.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Network.FilterSpec</span></code></a> with all attributes None which means
if more than 1000 networks match the <aclass="reference internal"href="#com.vmware.vcenter_client.Network.FilterSpec"title="com.vmware.vcenter_client.Network.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Network.FilterSpec</span></code></a>.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter_client.</code><codeclass="descname">ResourcePool</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.ResourcePool"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">FilterSpec</code><spanclass="sig-paren">(</span><em>resource_pools=None</em>, <em>names=None</em>, <em>parent_resource_pools=None</em>, <em>datacenters=None</em>, <em>hosts=None</em>, <em>clusters=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.ResourcePool.FilterSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ResourcePool.FilterSpec</span></code> class contains attributes used to filter
the results when listing resource pools (see <aclass="reference internal"href="#com.vmware.vcenter_client.ResourcePool.list"title="com.vmware.vcenter_client.ResourcePool.list"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">ResourcePool.list()</span></code></a>). If
multiple attributes are specified, only resource pools matching all of the
<li><p><strong>resource_pools</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifiers of resource pools that can match the filter.
<li><p><strong>names</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Names that resource pools must have to match the filter (see
If None or empty, resource pools with any name match the filter.</p></li>
<li><p><strong>parent_resource_pools</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Resource pools that must contain the resource pool for the resource
<li><p><strong>datacenters</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Datacenters that must contain the resource pool for the resource
<li><p><strong>hosts</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Hosts that must contain the resource pool for the resource pool to
If None or empty, resource pools in any host match the filter.</p></li>
<li><p><strong>clusters</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Clusters that must contain the resource pool for the resource pool
<emclass="property">class </em><codeclass="descname">Info</code><spanclass="sig-paren">(</span><em>name=None</em>, <em>resource_pools=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.ResourcePool.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ResourcePool.Info</span></code> class contains information about a resource pool.</p>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the vCenter Server resource pool.</p></li>
<li><p><strong>resource_pools</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifiers of the child resource pools contained in this resource
<codeclass="descname">RESOURCE_TYPE</code><emclass="property"> = 'ResourcePool'</em><aclass="headerlink"href="#com.vmware.vcenter_client.ResourcePool.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<dd><p>The resource type for the vCenter resource pool</p>
<emclass="property">class </em><codeclass="descname">Summary</code><spanclass="sig-paren">(</span><em>resource_pool=None</em>, <em>name=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.ResourcePool.Summary"title="Permalink to this definition">¶</a></dt>
<li><p><strong>resource_pool</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the resource pool.
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the resource pool.</p></li>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>resource_pool</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.ResourcePool.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieves information about the resource pool indicated by
<ddclass="field-odd"><p><strong>resource_pool</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the resource pool for which information should be
<codeclass="descname">list</code><spanclass="sig-paren">(</span><em>filter=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.ResourcePool.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about at most 1000 visible (subject to permission
<ddclass="field-odd"><p><strong>filter</strong> (<aclass="reference internal"href="#com.vmware.vcenter_client.ResourcePool.FilterSpec"title="com.vmware.vcenter_client.ResourcePool.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ResourcePool.FilterSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specification of matching resource pools for which information
<aclass="reference internal"href="#com.vmware.vcenter_client.ResourcePool.FilterSpec"title="com.vmware.vcenter_client.ResourcePool.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ResourcePool.FilterSpec</span></code></a> with all attributes None which
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter_client.</code><codeclass="descname">VM</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.VM"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">ComputePlacementSpec</code><spanclass="sig-paren">(</span><em>resource_pool=None</em>, <em>host=None</em>, <em>cluster=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.VM.ComputePlacementSpec"title="Permalink to this definition">¶</a></dt>
<li><p><strong>resource_pool</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Resource pool into which the virtual machine should be placed.
<li><p><strong>host</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Host onto which the virtual machine should be placed.</p>
<p>If <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">resourcePool</span></code> are both specified,
<codeclass="docutils literal notranslate"><spanclass="pre">resourcePool</span></code> must belong to <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code>.</p>
<p>If <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code> are both specified, <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> must be a
member of <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code>.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">HostSystem</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
This attribute may be None if <codeclass="docutils literal notranslate"><spanclass="pre">resourcePool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code> is
specified. If None, the system will attempt to choose a suitable
host for the virtual machine; if a host cannot be chosen, the
<li><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Cluster into which the virtual machine should be placed.</p>
<p>If <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">resourcePool</span></code> are both specified,
<codeclass="docutils literal notranslate"><spanclass="pre">resourcePool</span></code> must belong to <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code>.</p>
<p>If <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> are both specified, <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> must be a
member of <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code>.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>.
If <codeclass="docutils literal notranslate"><spanclass="pre">resourcePool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> is specified, it is recommended
If the guest-specific size is 0, no virtual disk will be created.</p></li>
<li><p><strong>nics</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="com.vmware.vcenter.vm.html#com.vmware.vcenter.vm.hardware_client.Ethernet.CreateSpec"title="com.vmware.vcenter.vm.hardware_client.Ethernet.CreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vm.hardware_client.Ethernet.CreateSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of Ethernet adapters.
If None, no Ethernet adapters will be created.</p></li>
<li><p><strong>cdroms</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="com.vmware.vcenter.vm.html#com.vmware.vcenter.vm.hardware_client.Cdrom.CreateSpec"title="com.vmware.vcenter.vm.hardware_client.Cdrom.CreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vm.hardware_client.Cdrom.CreateSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of CD-ROMs.
If None, no CD-ROM devices will be created.</p></li>
<li><p><strong>floppies</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="com.vmware.vcenter.vm.html#com.vmware.vcenter.vm.hardware_client.Floppy.CreateSpec"title="com.vmware.vcenter.vm.hardware_client.Floppy.CreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vm.hardware_client.Floppy.CreateSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of floppy drives.
If None, no floppy drives will be created.</p></li>
<li><p><strong>parallel_ports</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="com.vmware.vcenter.vm.html#com.vmware.vcenter.vm.hardware_client.Parallel.CreateSpec"title="com.vmware.vcenter.vm.hardware_client.Parallel.CreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vm.hardware_client.Parallel.CreateSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of parallel ports.
If None, no parallel ports will be created.</p></li>
<li><p><strong>serial_ports</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="com.vmware.vcenter.vm.html#com.vmware.vcenter.vm.hardware_client.Serial.CreateSpec"title="com.vmware.vcenter.vm.hardware_client.Serial.CreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vm.hardware_client.Serial.CreateSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of serial ports.
If None, no serial ports will be created.</p></li>
<li><p><strong>sata_adapters</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="com.vmware.vcenter.vm.hardware.html#com.vmware.vcenter.vm.hardware.adapter_client.Sata.CreateSpec"title="com.vmware.vcenter.vm.hardware.adapter_client.Sata.CreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vm.hardware.adapter_client.Sata.CreateSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of SATA adapters.
<li><p><strong>storage_policy</strong> (<aclass="reference internal"href="#com.vmware.vcenter_client.VM.StoragePolicySpec"title="com.vmware.vcenter_client.VM.StoragePolicySpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">VM.StoragePolicySpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The <codeclass="docutils literal notranslate"><spanclass="pre">VM.StoragePolicySpec</span></code> class contains information about the
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">VM.FilterSpec</span></code> class contains attributes used to filter the results
when listing virtual machines (see <aclass="reference internal"href="#com.vmware.vcenter_client.VM.list"title="com.vmware.vcenter_client.VM.list"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">VM.list()</span></code></a>). If multiple attributes
are specified, only virtual machines matching all of the attributes match
<li><p><strong>vms</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifiers of virtual machines that can match the filter.
<li><p><strong>names</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Names that virtual machines must have to match the filter (see
If None or empty, virtual machines with any name match the filter.</p></li>
<li><p><strong>folders</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Folders that must contain the virtual machine for the virtual
If None or empty, virtual machines in any folder match the filter.</p></li>
<li><p><strong>datacenters</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Datacenters that must contain the virtual machine for the virtual
<li><p><strong>hosts</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Hosts that must contain the virtual machine for the virtual machine
If None or empty, virtual machines on any host match the filter.</p></li>
<li><p><strong>clusters</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Clusters that must contain the virtual machine for the virtual
If None or empty, virtual machines in any cluster match the filter.</p></li>
<li><p><strong>resource_pools</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Resource pools that must contain the virtual machine for the
<li><p><strong>power_states</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.vm_client.Power.State"title="com.vmware.vcenter.vm_client.Power.State"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vm_client.Power.State</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Power states that a virtual machine must be in to match the filter
<li><p><strong>identity</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.vm_client.Identity.Info"title="com.vmware.vcenter.vm_client.Identity.Info"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vm_client.Identity.Info</span></code></a>) – Identity of the virtual machine. This attribute was added in
vSphere API 6.7.1.
This attribute is optional because it was added in a newer version
than its parent node.</p></li>
<li><p><strong>power_state</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.vm_client.Power.State"title="com.vmware.vcenter.vm_client.Power.State"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vm_client.Power.State</span></code></a>) – Power state of the virtual machine.</p></li>
<li><p><strong>instant_clone_frozen</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Indicates whether the virtual machine is frozen for instant clone,
or not. This attribute was added in vSphere API 6.7.1.
This attribute is optional because it was added in a newer version
<emclass="property">class </em><codeclass="descname">InstantClonePlacementSpec</code><spanclass="sig-paren">(</span><em>folder=None</em>, <em>resource_pool=None</em>, <em>datastore=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.VM.InstantClonePlacementSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">VM.InstantClonePlacementSpec</span></code> class contains information used to
place an InstantClone of a virtual machine onto resources within the
vCenter inventory. This class was added in vSphere API 6.7.1.</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>folder</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Virtual machine folder into which the InstantCloned virtual machine
should be placed. This attribute was added in vSphere API 6.7.1.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">Folder</span></code>.
When methods return a value of this class as a return value, the
attribute will be an identifier for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">Folder</span></code>.
If attribute is None, the system will use the virtual machine
folder of the source virtual machine.</p></li>
<li><p><strong>resource_pool</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Resource pool into which the InstantCloned virtual machine should
be placed. This attribute was added in vSphere API 6.7.1.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">ResourcePool</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
If attribute is None, the system will use the resource pool of the
source virtual machine.</p></li>
<li><p><strong>datastore</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Datastore on which the InstantCloned virtual machine’s
configuration state should be stored. This datastore will also be
used for any virtual disks that are created as part of the virtual
machine InstantClone operation. This attribute was added in vSphere
API 6.7.1.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">Datastore</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
<p>Document-based InstantClone spec. This class was added in vSphere API
6.7.1.</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>source</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Virtual machine to InstantClone from. This attribute was added in
vSphere API 6.7.1.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">VirtualMachine</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the new virtual machine. This attribute was added in
vSphere API 6.7.1.</p></li>
<li><p><strong>placement</strong> (<aclass="reference internal"href="#com.vmware.vcenter_client.VM.InstantClonePlacementSpec"title="com.vmware.vcenter_client.VM.InstantClonePlacementSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">VM.InstantClonePlacementSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Virtual machine placement information. This attribute was added in
vSphere API 6.7.1.
If this attribute is None, the system will use the values from the
source virtual machine. If specified, each field will be used for
placement. If the fields result in disjoint placement the operation
will fail. If the fields along with the placement values of the
source virtual machine result in disjoint placement the operation
will fail.</p></li>
<li><p><strong>nics_to_update</strong> ((<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="com.vmware.vcenter.vm.html#com.vmware.vcenter.vm.hardware_client.Ethernet.UpdateSpec"title="com.vmware.vcenter.vm.hardware_client.Ethernet.UpdateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vm.hardware_client.Ethernet.UpdateSpec</span></code></a>) or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Map of NICs to update. This attribute was added in vSphere API
6.7.1.
When clients pass a value of this class as a parameter, the key in
the attribute <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> must be an identifier for the resource
type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vm.hardware.Ethernet</span></code>. When methods
return a value of this class as a return value, the key in the
attribute <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> will be an identifier for the resource
<li><p><strong>disconnect_all_nics</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Indicates whether all NICs on the destination virtual machine
should be disconnected from the newtwork. This attribute was added
in vSphere API 6.7.1.
If None, connection status of all NICs on the destination virtual
machine will be the same as on the source virtual machine.</p></li>
<li><p><strong>parallel_ports_to_update</strong> ((<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="com.vmware.vcenter.vm.html#com.vmware.vcenter.vm.hardware_client.Parallel.UpdateSpec"title="com.vmware.vcenter.vm.hardware_client.Parallel.UpdateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vm.hardware_client.Parallel.UpdateSpec</span></code></a>) or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Map of parallel ports to Update. This attribute was added in
vSphere API 6.7.1.
When clients pass a value of this class as a parameter, the key in
the attribute <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> must be an identifier for the resource
type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vm.hardware.ParallelPort</span></code>. When methods
return a value of this class as a return value, the key in the
attribute <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> will be an identifier for the resource
If None, no parallel ports will be updated.</p></li>
<li><p><strong>serial_ports_to_update</strong> ((<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="com.vmware.vcenter.vm.html#com.vmware.vcenter.vm.hardware_client.Serial.UpdateSpec"title="com.vmware.vcenter.vm.hardware_client.Serial.UpdateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vm.hardware_client.Serial.UpdateSpec</span></code></a>) or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Map of serial ports to Update. This attribute was added in vSphere
API 6.7.1.
When clients pass a value of this class as a parameter, the key in
the attribute <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> must be an identifier for the resource
type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vm.hardware.SerialPort</span></code>. When methods
return a value of this class as a return value, the key in the
attribute <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> will be an identifier for the resource
If None, no serial ports will be updated.</p></li>
<li><p><strong>bios_uuid</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – 128-bit SMBIOS UUID of a virtual machine represented as a
hexadecimal string in “12345678-abcd-1234-cdef-123456789abc”
format. This attribute was added in vSphere API 6.7.1.
<emclass="property">class </em><codeclass="descname">InventoryPlacementSpec</code><spanclass="sig-paren">(</span><em>folder=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.VM.InventoryPlacementSpec"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>folder</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Virtual machine folder into which the virtual machine should be
<emclass="property">class </em><codeclass="descname">PlacementSpec</code><spanclass="sig-paren">(</span><em>folder=None</em>, <em>resource_pool=None</em>, <em>host=None</em>, <em>cluster=None</em>, <em>datastore=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.VM.PlacementSpec"title="Permalink to this definition">¶</a></dt>
<li><p><strong>folder</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Virtual machine folder into which the virtual machine should be
virtual machine creation operation will fail.</p></li>
<li><p><strong>resource_pool</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Resource pool into which the virtual machine should be placed.
<li><p><strong>host</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Host onto which the virtual machine should be placed.</p>
<p>If <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">resourcePool</span></code> are both specified,
<codeclass="docutils literal notranslate"><spanclass="pre">resourcePool</span></code> must belong to <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code>.</p>
<p>If <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code> are both specified, <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> must be a
member of <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code>.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">HostSystem</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
This attribute may be None if <codeclass="docutils literal notranslate"><spanclass="pre">resourcePool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code> is
specified. If None, the system will attempt to choose a suitable
host for the virtual machine; if a host cannot be chosen, the
<li><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Cluster into which the virtual machine should be placed.</p>
<p>If <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">resourcePool</span></code> are both specified,
<codeclass="docutils literal notranslate"><spanclass="pre">resourcePool</span></code> must belong to <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code>.</p>
<p>If <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> are both specified, <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> must be a
member of <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code>.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>.
If <codeclass="docutils literal notranslate"><spanclass="pre">resourcePool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> is specified, it is recommended
<li><p><strong>datastore</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Datastore on which the virtual machine’s configuration state should
<codeclass="descname">RESOURCE_TYPE</code><emclass="property"> = 'VirtualMachine'</em><aclass="headerlink"href="#com.vmware.vcenter_client.VM.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descname">RegisterPlacementSpec</code><spanclass="sig-paren">(</span><em>folder=None</em>, <em>resource_pool=None</em>, <em>host=None</em>, <em>cluster=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.VM.RegisterPlacementSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">VM.RegisterPlacementSpec</span></code> class contains information used to place a
virtual machine, created from existing virtual machine files on storage,
onto resources within the vCenter inventory. This class was added in
vSphere API 6.8.7.</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>folder</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Virtual machine folder into which the virtual machine should be
placed.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">Folder</span></code>.
When methods return a value of this class as a return value, the
attribute will be an identifier for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">Folder</span></code>.
This attribute is currently required. In the future, if this
attribute is None, the system will attempt to choose a suitable
folder for the virtual machine; if a folder cannot be chosen, the
virtual machine creation operation will fail.</p></li>
<li><p><strong>resource_pool</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Resource pool into which the virtual machine should be placed.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">ResourcePool</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
This attribute is currently required if both <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> and
<codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code> are None. In the future, if this attribute is None, the
system will attempt to choose a suitable resource pool for the
virtual machine; if a resource pool cannot be chosen, the virtual
machine creation operation will fail.</p></li>
<li><p><strong>host</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Host onto which the virtual machine should be placed.</p>
<p>If <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">resourcePool</span></code> are both specified,
<codeclass="docutils literal notranslate"><spanclass="pre">resourcePool</span></code> must belong to <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code>.</p>
<p>If <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code> are both specified, <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> must be a
member of <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code>.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">HostSystem</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
This attribute may be None if <codeclass="docutils literal notranslate"><spanclass="pre">resourcePool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code> is
specified. If None, the system will attempt to choose a suitable
host for the virtual machine; if a host cannot be chosen, the
virtual machine creation operation will fail.</p>
</p></li>
<li><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Cluster into which the virtual machine should be placed.</p>
<p>If <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">resourcePool</span></code> are both specified,
<codeclass="docutils literal notranslate"><spanclass="pre">resourcePool</span></code> must belong to <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code>.</p>
<p>If <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> are both specified, <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> must be a
member of <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code>.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>.
If <codeclass="docutils literal notranslate"><spanclass="pre">resourcePool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> is specified, it is recommended
<emclass="property">class </em><codeclass="descname">RegisterSpec</code><spanclass="sig-paren">(</span><em>datastore=None</em>, <em>path=None</em>, <em>datastore_path=None</em>, <em>name=None</em>, <em>placement=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.VM.RegisterSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">VM.RegisterSpec</span></code> class contains information used to create a virtual
machine from existing virtual machine files on storage.</p>
<p>The location of the virtual machine files on storage must be specified by
providing either <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">VM.RegisterSpec.datastore</span></code> and
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">VM.RegisterSpec.path</span></code> or by providing
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">VM.RegisterSpec.datastore_path</span></code>. If
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">VM.RegisterSpec.datastore</span></code> and <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">VM.RegisterSpec.path</span></code> are
<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code>, <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">VM.RegisterSpec.datastore_path</span></code> must be None, and if
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">VM.RegisterSpec.datastore</span></code> and <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">VM.RegisterSpec.path</span></code> must be
None.. This class was added in vSphere API 6.8.7.</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>datastore</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifier of the datastore on which the virtual machine’s
configuration state is stored. This attribute was added in vSphere
API 6.8.7.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">Datastore</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
If None, <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">VM.RegisterSpec.path</span></code> must also be None and
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">VM.RegisterSpec.datastore_path</span></code> must be <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code>.</p></li>
<li><p><strong>path</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Path to the virtual machine’s configuration file on the datastore
corresponding to {\@link #datastore). This attribute was added
in vSphere API 6.8.7.
If None, <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">VM.RegisterSpec.datastore</span></code> must also be None and
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">VM.RegisterSpec.datastore_path</span></code> must be <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code>.</p></li>
<li><p><strong>datastore_path</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Datastore path for the virtual machine’s configuration file in the
format “[datastore name] path”. For example “[storage1]
Test-VM/Test-VM.vmx”. This attribute was added in vSphere API
6.8.7.
If None, both <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">VM.RegisterSpec.datastore</span></code> and
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">VM.RegisterSpec.path</span></code> must be <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code>.</p></li>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Virtual machine name. This attribute was added in vSphere API
6.8.7.
If None, the display name from the virtual machine’s configuration
file will be used.</p></li>
<li><p><strong>placement</strong> (<aclass="reference internal"href="#com.vmware.vcenter_client.VM.RegisterPlacementSpec"title="com.vmware.vcenter_client.VM.RegisterPlacementSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">VM.RegisterPlacementSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Virtual machine placement information. This attribute was added in
vSphere API 6.8.7.
This attribute is currently required. In the future, if this
attribute is None, the system will attempt to choose suitable
resources on which to place the virtual machine.</p></li>
<emclass="property">class </em><codeclass="descname">StoragePlacementSpec</code><spanclass="sig-paren">(</span><em>datastore=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.VM.StoragePlacementSpec"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>datastore</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Datastore on which the virtual machine’s configuration state should
<emclass="property">class </em><codeclass="descname">StoragePolicySpec</code><spanclass="sig-paren">(</span><em>policy=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.VM.StoragePolicySpec"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>policy</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the storage policy which should be associated with
the virtual machine. This attribute was added in vSphere API 6.7.
<emclass="property">class </em><codeclass="descname">Summary</code><spanclass="sig-paren">(</span><em>vm=None</em>, <em>name=None</em>, <em>power_state=None</em>, <em>cpu_count=None</em>, <em>memory_size_mib=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.VM.Summary"title="Permalink to this definition">¶</a></dt>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the Virtual machine.</p></li>
<li><p><strong>power_state</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.vm_client.Power.State"title="com.vmware.vcenter.vm_client.Power.State"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vm_client.Power.State</span></code></a>) – Power state of the virtual machine.</p></li>
<li><p><strong>cpu_count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Number of CPU cores.
<codeclass="descname">create</code><spanclass="sig-paren">(</span><em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.VM.create"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">delete</code><spanclass="sig-paren">(</span><em>vm</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.VM.delete"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>vm</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.VM.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about a virtual machine.</p>
<codeclass="descname">instant_clone</code><spanclass="sig-paren">(</span><em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.VM.instant_clone"title="Permalink to this definition">¶</a></dt>
<dd><p>Create an instant clone of an existing virtual machine. This method was
<codeclass="descname">list</code><spanclass="sig-paren">(</span><em>filter=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.VM.list"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>filter</strong> (<aclass="reference internal"href="#com.vmware.vcenter_client.VM.FilterSpec"title="com.vmware.vcenter_client.VM.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">VM.FilterSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specification of matching virtual machines for which information
If None, the behavior is equivalent to a <aclass="reference internal"href="#com.vmware.vcenter_client.VM.FilterSpec"title="com.vmware.vcenter_client.VM.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">VM.FilterSpec</span></code></a>
with all attributes None which means all virtual machines match the
if the user doesn’t have the required privileges.</p>
</dd>
</dl>
</dd></dl>
<dlclass="method">
<dtid="com.vmware.vcenter_client.VM.register">
<codeclass="descname">register</code><spanclass="sig-paren">(</span><em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.VM.register"title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a virtual machine from existing virtual machine files on
storage. This method was added in vSphere API 6.8.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter_client.VM.RegisterSpec"title="com.vmware.vcenter_client.VM.RegisterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">VM.RegisterSpec</span></code></a>) – Specification of the location of the virtual machine files and the
if the user doesn’t have the required privileges.</p>
</dd>
</dl>
</dd></dl>
<dlclass="method">
<dtid="com.vmware.vcenter_client.VM.unregister">
<codeclass="descname">unregister</code><spanclass="sig-paren">(</span><em>vm</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter_client.VM.unregister"title="Permalink to this definition">¶</a></dt>
<dd><p>Removes the virtual machine corresponding to <codeclass="docutils literal notranslate"><spanclass="pre">vm</span></code> from the vCenter
inventory without removing any of the virtual machine’s files from
storage. All high-level information stored with the management server
(ESXi or vCenter) is removed, including information such as statistics,
resource pool association, permissions, and alarms. This method was
added in vSphere API 6.8.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>vm</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the virtual machine to be unregistered.
The parameter must be an identifier for the resource type:
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>.
