<spanid="com-vmware-appliance-package"></span><h1>com.vmware.appliance package<aclass="headerlink"href="#module-com.vmware.appliance"title="Permalink to this headline">¶</a></h1>
<divclass="section"id="subpackages">
<h2>Subpackages<aclass="headerlink"href="#subpackages"title="Permalink to this headline">¶</a></h2>
<spanid="com-vmware-appliance-access-client-module"></span><h2>com.vmware.appliance.access_client module<aclass="headerlink"href="#module-com.vmware.appliance.access_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.appliance.access_client</span></code> module provides classes for managing
access to the appliance. The module is available starting in vSphere 6.5.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.access_client.</code><codeclass="descname">Consolecli</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.access_client.Consolecli"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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.</td>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.access_client.Consolecli.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Get enabled state of the console-based controlled CLI (TTY1).</p>
<codeclass="descname">set</code><spanclass="sig-paren">(</span><em>enabled</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.access_client.Consolecli.set"title="Permalink to this definition">¶</a></dt>
<dd><p>Set enabled state of the console-based controlled CLI (TTY1).</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.access_client.</code><codeclass="descname">Dcui</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.access_client.Dcui"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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.</td>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.access_client.Dcui.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Get enabled state of Direct Console User Interface (DCUI TTY2).</p>
<codeclass="descname">set</code><spanclass="sig-paren">(</span><em>enabled</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.access_client.Dcui.set"title="Permalink to this definition">¶</a></dt>
<dd><p>Set enabled state of Direct Console User Interface (DCUI TTY2).</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.access_client.</code><codeclass="descname">Shell</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.access_client.Shell"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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.</td>
<emclass="property">class </em><codeclass="descname">ShellConfig</code><spanclass="sig-paren">(</span><em>enabled=None</em>, <em>timeout=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.access_client.Shell.ShellConfig"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Enabled can be set to true or false</li>
<li><strong>timeout</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – The timeout (in seconds) specifies how long you enable the Shell
access. The maximum timeout is 86400 seconds(1 day).</li>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.access_client.Shell.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Get enabled state of BASH, that is, access to BASH from within the
<codeclass="descname">set</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.access_client.Shell.set"title="Permalink to this definition">¶</a></dt>
<dd><p>Set enabled state of BASH, that is, access to BASH from within the
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.access_client.</code><codeclass="descname">Ssh</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.access_client.Ssh"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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.</td>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.access_client.Ssh.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Get enabled state of the SSH-based controlled CLI.</p>
<codeclass="descname">set</code><spanclass="sig-paren">(</span><em>enabled</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.access_client.Ssh.set"title="Permalink to this definition">¶</a></dt>
<dd><p>Set enabled state of the SSH-based controlled CLI.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.access_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.access_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-appliance-health-client-module"></span><h2>com.vmware.appliance.health_client module<aclass="headerlink"href="#module-com.vmware.appliance.health_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.appliance.health_client</span></code> module provides classes for
reporting the health of the various subsystems of the the appliance. The module
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.health_client.</code><codeclass="descname">Applmgmt</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.health_client.Applmgmt"title="Permalink to this definition">¶</a></dt>
<p><codeclass="docutils literal notranslate"><spanclass="pre">Applmgmt</span></code> class provides methods Get health status of applmgmt services.</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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.</td>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.health_client.Applmgmt.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Get health status of applmgmt services.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.health_client.</code><codeclass="descname">Databasestorage</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.health_client.Databasestorage"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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.</td>
<emclass="property">class </em><codeclass="descname">HealthLevel</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.health_client.Databasestorage.HealthLevel"title="Permalink to this definition">¶</a></dt>
<p><codeclass="docutils literal notranslate"><spanclass="pre">Databasestorage.HealthLevel</span></code> class Defines service health levels.</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">This class represents an enumerated type in the interface language
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">gray</code><emclass="property"> = HealthLevel(string='gray')</em><aclass="headerlink"href="#com.vmware.appliance.health_client.Databasestorage.HealthLevel.gray"title="Permalink to this definition">¶</a></dt>
<dd><p>No health data is available for this service.</p>
<codeclass="descname">green</code><emclass="property"> = HealthLevel(string='green')</em><aclass="headerlink"href="#com.vmware.appliance.health_client.Databasestorage.HealthLevel.green"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">orange</code><emclass="property"> = HealthLevel(string='orange')</em><aclass="headerlink"href="#com.vmware.appliance.health_client.Databasestorage.HealthLevel.orange"title="Permalink to this definition">¶</a></dt>
<dd><p>The service health is degraded. The service might have serious problems.</p>
<codeclass="descname">red</code><emclass="property"> = HealthLevel(string='red')</em><aclass="headerlink"href="#com.vmware.appliance.health_client.Databasestorage.HealthLevel.red"title="Permalink to this definition">¶</a></dt>
<dd><p>The service is unavaiable, not functioning properly, or will stop
<codeclass="descname">yellow</code><emclass="property"> = HealthLevel(string='yellow')</em><aclass="headerlink"href="#com.vmware.appliance.health_client.Databasestorage.HealthLevel.yellow"title="Permalink to this definition">¶</a></dt>
<dd><p>The service is healthy but experiencing some problems.</p>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.health_client.Databasestorage.get"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.health_client.</code><codeclass="descname">Load</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.health_client.Load"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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.</td>
<emclass="property">class </em><codeclass="descname">HealthLevel</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.health_client.Load.HealthLevel"title="Permalink to this definition">¶</a></dt>
<p><codeclass="docutils literal notranslate"><spanclass="pre">Load.HealthLevel</span></code> class Defines health levels.</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">This class represents an enumerated type in the interface language
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">gray</code><emclass="property"> = HealthLevel(string='gray')</em><aclass="headerlink"href="#com.vmware.appliance.health_client.Load.HealthLevel.gray"title="Permalink to this definition">¶</a></dt>
<dd><p>No health data is available for this service.</p>
<codeclass="descname">green</code><emclass="property"> = HealthLevel(string='green')</em><aclass="headerlink"href="#com.vmware.appliance.health_client.Load.HealthLevel.green"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">orange</code><emclass="property"> = HealthLevel(string='orange')</em><aclass="headerlink"href="#com.vmware.appliance.health_client.Load.HealthLevel.orange"title="Permalink to this definition">¶</a></dt>
<dd><p>The service health is degraded. The service might have serious problems.</p>
<codeclass="descname">red</code><emclass="property"> = HealthLevel(string='red')</em><aclass="headerlink"href="#com.vmware.appliance.health_client.Load.HealthLevel.red"title="Permalink to this definition">¶</a></dt>
<dd><p>The service is unavaiable, not functioning properly, or will stop
<codeclass="descname">yellow</code><emclass="property"> = HealthLevel(string='yellow')</em><aclass="headerlink"href="#com.vmware.appliance.health_client.Load.HealthLevel.yellow"title="Permalink to this definition">¶</a></dt>
<dd><p>The service is healthy state, but experiencing some levels of problems.</p>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.health_client.Load.get"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.health_client.</code><codeclass="descname">Mem</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.health_client.Mem"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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.</td>
<emclass="property">class </em><codeclass="descname">HealthLevel</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.health_client.Mem.HealthLevel"title="Permalink to this definition">¶</a></dt>
<p><codeclass="docutils literal notranslate"><spanclass="pre">Mem.HealthLevel</span></code> class Defines health levels.</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">This class represents an enumerated type in the interface language
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">gray</code><emclass="property"> = HealthLevel(string='gray')</em><aclass="headerlink"href="#com.vmware.appliance.health_client.Mem.HealthLevel.gray"title="Permalink to this definition">¶</a></dt>
<dd><p>No health data is available for this service.</p>
<codeclass="descname">green</code><emclass="property"> = HealthLevel(string='green')</em><aclass="headerlink"href="#com.vmware.appliance.health_client.Mem.HealthLevel.green"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">orange</code><emclass="property"> = HealthLevel(string='orange')</em><aclass="headerlink"href="#com.vmware.appliance.health_client.Mem.HealthLevel.orange"title="Permalink to this definition">¶</a></dt>
<dd><p>The service health is degraded. The service might have serious problems</p>
<codeclass="descname">red</code><emclass="property"> = HealthLevel(string='red')</em><aclass="headerlink"href="#com.vmware.appliance.health_client.Mem.HealthLevel.red"title="Permalink to this definition">¶</a></dt>
<dd><p>The service is unavaiable, not functioning properly, or will stop
<codeclass="descname">yellow</code><emclass="property"> = HealthLevel(string='yellow')</em><aclass="headerlink"href="#com.vmware.appliance.health_client.Mem.HealthLevel.yellow"title="Permalink to this definition">¶</a></dt>
<dd><p>The service is healthy state, but experiencing some levels of problems.</p>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.health_client.Mem.get"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.health_client.</code><codeclass="descname">Softwarepackages</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.health_client.Softwarepackages"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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.</td>
<emclass="property">class </em><codeclass="descname">HealthLevel</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.health_client.Softwarepackages.HealthLevel"title="Permalink to this definition">¶</a></dt>
<p><codeclass="docutils literal notranslate"><spanclass="pre">Softwarepackages.HealthLevel</span></code> class Defines health levels.</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">This class represents an enumerated type in the interface language
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">gray</code><emclass="property"> = HealthLevel(string='gray')</em><aclass="headerlink"href="#com.vmware.appliance.health_client.Softwarepackages.HealthLevel.gray"title="Permalink to this definition">¶</a></dt>
<dd><p>No health data is available for this service.</p>
<codeclass="descname">green</code><emclass="property"> = HealthLevel(string='green')</em><aclass="headerlink"href="#com.vmware.appliance.health_client.Softwarepackages.HealthLevel.green"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">orange</code><emclass="property"> = HealthLevel(string='orange')</em><aclass="headerlink"href="#com.vmware.appliance.health_client.Softwarepackages.HealthLevel.orange"title="Permalink to this definition">¶</a></dt>
<dd><p>The service health is degraded. The service might have serious problems.</p>
<codeclass="descname">red</code><emclass="property"> = HealthLevel(string='red')</em><aclass="headerlink"href="#com.vmware.appliance.health_client.Softwarepackages.HealthLevel.red"title="Permalink to this definition">¶</a></dt>
<dd><p>The service is unavaiable, not functioning properly, or will stop
<codeclass="descname">yellow</code><emclass="property"> = HealthLevel(string='yellow')</em><aclass="headerlink"href="#com.vmware.appliance.health_client.Softwarepackages.HealthLevel.yellow"title="Permalink to this definition">¶</a></dt>
<dd><p>The service is healthy state, but experiencing some levels of problems.</p>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.health_client.Softwarepackages.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Get information on available software updates available in the remote
vSphere Update Manager repository. Red indicates that security updates
are available. Orange indicates that non-security updates are
available. Green indicates that there are no updates available. Gray
indicates that there was an error retreiving information on software
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.health_client.</code><codeclass="descname">Storage</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.health_client.Storage"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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.</td>
<emclass="property">class </em><codeclass="descname">HealthLevel</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.health_client.Storage.HealthLevel"title="Permalink to this definition">¶</a></dt>
<p><codeclass="docutils literal notranslate"><spanclass="pre">Storage.HealthLevel</span></code> class Defines health levels.</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">This class represents an enumerated type in the interface language
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">gray</code><emclass="property"> = HealthLevel(string='gray')</em><aclass="headerlink"href="#com.vmware.appliance.health_client.Storage.HealthLevel.gray"title="Permalink to this definition">¶</a></dt>
<dd><p>No health data is available for this service.</p>
<codeclass="descname">green</code><emclass="property"> = HealthLevel(string='green')</em><aclass="headerlink"href="#com.vmware.appliance.health_client.Storage.HealthLevel.green"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">orange</code><emclass="property"> = HealthLevel(string='orange')</em><aclass="headerlink"href="#com.vmware.appliance.health_client.Storage.HealthLevel.orange"title="Permalink to this definition">¶</a></dt>
<dd><p>The service health is degraded. The service might have serious problems.</p>
<codeclass="descname">red</code><emclass="property"> = HealthLevel(string='red')</em><aclass="headerlink"href="#com.vmware.appliance.health_client.Storage.HealthLevel.red"title="Permalink to this definition">¶</a></dt>
<dd><p>The service is unavaiable, not functioning properly, or will stop
<codeclass="descname">yellow</code><emclass="property"> = HealthLevel(string='yellow')</em><aclass="headerlink"href="#com.vmware.appliance.health_client.Storage.HealthLevel.yellow"title="Permalink to this definition">¶</a></dt>
<dd><p>The service is healthy state, but experiencing some levels of problems.</p>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.health_client.Storage.get"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.health_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.health_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.health_client.</code><codeclass="descname">Swap</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.health_client.Swap"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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.</td>
<emclass="property">class </em><codeclass="descname">HealthLevel</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.health_client.Swap.HealthLevel"title="Permalink to this definition">¶</a></dt>
<p><codeclass="docutils literal notranslate"><spanclass="pre">Swap.HealthLevel</span></code> class Defines health levels.</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">This class represents an enumerated type in the interface language
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">gray</code><emclass="property"> = HealthLevel(string='gray')</em><aclass="headerlink"href="#com.vmware.appliance.health_client.Swap.HealthLevel.gray"title="Permalink to this definition">¶</a></dt>
<dd><p>No health data is available for this service.</p>
<codeclass="descname">green</code><emclass="property"> = HealthLevel(string='green')</em><aclass="headerlink"href="#com.vmware.appliance.health_client.Swap.HealthLevel.green"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">orange</code><emclass="property"> = HealthLevel(string='orange')</em><aclass="headerlink"href="#com.vmware.appliance.health_client.Swap.HealthLevel.orange"title="Permalink to this definition">¶</a></dt>
<dd><p>The service health is degraded. The service might have serious problems.</p>
<codeclass="descname">red</code><emclass="property"> = HealthLevel(string='red')</em><aclass="headerlink"href="#com.vmware.appliance.health_client.Swap.HealthLevel.red"title="Permalink to this definition">¶</a></dt>
<dd><p>The service is unavaiable, not functioning properly, or will stop
<codeclass="descname">yellow</code><emclass="property"> = HealthLevel(string='yellow')</em><aclass="headerlink"href="#com.vmware.appliance.health_client.Swap.HealthLevel.yellow"title="Permalink to this definition">¶</a></dt>
<dd><p>The service is healthy state, but experiencing some levels of problems.</p>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.health_client.Swap.get"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.health_client.</code><codeclass="descname">System</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.health_client.System"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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.</td>
<emclass="property">class </em><codeclass="descname">HealthLevel</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.health_client.System.HealthLevel"title="Permalink to this definition">¶</a></dt>
<p><codeclass="docutils literal notranslate"><spanclass="pre">System.HealthLevel</span></code> class Defines health levels.</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">This class represents an enumerated type in the interface language
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">gray</code><emclass="property"> = HealthLevel(string='gray')</em><aclass="headerlink"href="#com.vmware.appliance.health_client.System.HealthLevel.gray"title="Permalink to this definition">¶</a></dt>
<dd><p>No health data is available for this service.</p>
<codeclass="descname">green</code><emclass="property"> = HealthLevel(string='green')</em><aclass="headerlink"href="#com.vmware.appliance.health_client.System.HealthLevel.green"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">orange</code><emclass="property"> = HealthLevel(string='orange')</em><aclass="headerlink"href="#com.vmware.appliance.health_client.System.HealthLevel.orange"title="Permalink to this definition">¶</a></dt>
<dd><p>The service health is degraded. The service might have serious problems.</p>
<codeclass="descname">red</code><emclass="property"> = HealthLevel(string='red')</em><aclass="headerlink"href="#com.vmware.appliance.health_client.System.HealthLevel.red"title="Permalink to this definition">¶</a></dt>
<dd><p>The service is unavaiable, not functioning properly, or will stop
<codeclass="descname">yellow</code><emclass="property"> = HealthLevel(string='yellow')</em><aclass="headerlink"href="#com.vmware.appliance.health_client.System.HealthLevel.yellow"title="Permalink to this definition">¶</a></dt>
<dd><p>The service is healthy state, but experiencing some levels of problems.</p>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.health_client.System.get"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">lastcheck</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.health_client.System.lastcheck"title="Permalink to this definition">¶</a></dt>
<dd><p>Get last check timestamp of the health of the system.</p>
<spanid="com-vmware-appliance-local-accounts-client-module"></span><h2>com.vmware.appliance.local_accounts_client module<aclass="headerlink"href="#module-com.vmware.appliance.local_accounts_client"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.local_accounts_client.</code><codeclass="descname">Policy</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.local_accounts_client.Policy"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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.</td>
<emclass="property">class </em><codeclass="descname">Info</code><spanclass="sig-paren">(</span><em>max_days=None</em>, <em>min_days=None</em>, <em>warn_days=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.local_accounts_client.Policy.Info"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>max_days</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 a password may be used. If the password is
older than this, a password change will be forced. This attribute
was added in vSphere API 6.7.
If None then the restriction will be ignored.</li>
<li><strong>min_days</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 allowed between password changes. Any
password changes attempted sooner than this will be rejected. This
attribute was added in vSphere API 6.7.
If None then the restriction will be ignored.</li>
<li><strong>warn_days</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 warning given before a password expires. A zero
means warning is given only upon the day of expiration. This
<codeclass="descname">get</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.local_accounts_client.Policy.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Get the global password policy. This method was added in vSphere API
<codeclass="descname">set</code><spanclass="sig-paren">(</span><em>policy</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.local_accounts_client.Policy.set"title="Permalink to this definition">¶</a></dt>
<dd><p>Set the global password policy. This method was added in vSphere API
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.local_accounts_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.local_accounts_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-appliance-localaccounts-client-module"></span><h2>com.vmware.appliance.localaccounts_client module<aclass="headerlink"href="#module-com.vmware.appliance.localaccounts_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.appliancelocalaccounts</span></code> module provides classes for managing
local (OS) accounts in the appliance. The module is available starting in
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.localaccounts_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.localaccounts_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-appliance-logging-client-module"></span><h2>com.vmware.appliance.logging_client module<aclass="headerlink"href="#module-com.vmware.appliance.logging_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.appliance.logging_client</span></code> module provides classes for
managing log forwarding in the appliance. The module is available starting in
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.logging_client.</code><codeclass="descname">Forwarding</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.logging_client.Forwarding"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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.</td>
<emclass="property">class </em><codeclass="descname">Config</code><spanclass="sig-paren">(</span><em>hostname=None</em>, <em>port=None</em>, <em>protocol=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.logging_client.Forwarding.Config"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>hostname</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – FQDN or IP address of the logging server to which messages are
forwarded. This attribute was added in vSphere API 6.7.</li>
<li><strong>port</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – The port on which the remote logging server is listening for
forwarded log messages. This attribute was added in vSphere API
6.7.</li>
<li><strong>protocol</strong> (<aclass="reference internal"href="#com.vmware.appliance.logging_client.Forwarding.Protocol"title="com.vmware.appliance.logging_client.Forwarding.Protocol"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Forwarding.Protocol</span></code></a>) – Transport protocol used to forward log messages. This attribute was
<emclass="property">class </em><codeclass="descname">ConnectionStatus</code><spanclass="sig-paren">(</span><em>hostname=None</em>, <em>state=None</em>, <em>message=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.logging_client.Forwarding.ConnectionStatus"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>hostname</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – FQDN or IP address of the configured remote logging servers. This
attribute was added in vSphere API 6.7.</li>
<li><strong>state</strong> (<aclass="reference internal"href="#com.vmware.appliance.logging_client.Forwarding.ConnectionStatus.State"title="com.vmware.appliance.logging_client.Forwarding.ConnectionStatus.State"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Forwarding.ConnectionStatus.State</span></code></a>) – State of the configured remote logging server. This attribute was
added in vSphere API 6.7.</li>
<li><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> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Message associated with the state of the configured remote logging
server. This attribute was added in vSphere API 6.7.
<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.logging_client.Forwarding.ConnectionStatus.State"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Forwarding.ConnectionStatus.State</span></code> class defines the state values
that a remote logging server can be in. This enumeration was added in
vSphere API 6.7.</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">This class represents an enumerated type in the interface language
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">DOWN</code><emclass="property"> = State(string='DOWN')</em><aclass="headerlink"href="#com.vmware.appliance.logging_client.Forwarding.ConnectionStatus.State.DOWN"title="Permalink to this definition">¶</a></dt>
<dd><p>The remote logging server is not reachable. This class attribute was added
<codeclass="descname">UNKNOWN</code><emclass="property"> = State(string='UNKNOWN')</em><aclass="headerlink"href="#com.vmware.appliance.logging_client.Forwarding.ConnectionStatus.State.UNKNOWN"title="Permalink to this definition">¶</a></dt>
<dd><p>The status of remote logging server is unknown. This class attribute was
<codeclass="descname">UP</code><emclass="property"> = State(string='UP')</em><aclass="headerlink"href="#com.vmware.appliance.logging_client.Forwarding.ConnectionStatus.State.UP"title="Permalink to this definition">¶</a></dt>
<dd><p>The remote logging server is reachable. This class attribute was added in
<emclass="property">class </em><codeclass="descname">Protocol</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.logging_client.Forwarding.Protocol"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Forwarding.Protocol</span></code> class defines transport protocols for outbound
log messages. This enumeration was added in vSphere API 6.7.</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">This class represents an enumerated type in the interface language
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">TCP</code><emclass="property"> = Protocol(string='TCP')</em><aclass="headerlink"href="#com.vmware.appliance.logging_client.Forwarding.Protocol.TCP"title="Permalink to this definition">¶</a></dt>
<dd><p>Log messages will be forwarded to the remote host using the TCP protocol.
This class attribute was added in vSphere API 6.7.</p>
<codeclass="descname">TLS</code><emclass="property"> = Protocol(string='TLS')</em><aclass="headerlink"href="#com.vmware.appliance.logging_client.Forwarding.Protocol.TLS"title="Permalink to this definition">¶</a></dt>
<dd><p>Log messages will be forwarded to the remote host by using the TLS
protocol. This class attribute was added in vSphere API 6.7.</p>
<codeclass="descname">UDP</code><emclass="property"> = Protocol(string='UDP')</em><aclass="headerlink"href="#com.vmware.appliance.logging_client.Forwarding.Protocol.UDP"title="Permalink to this definition">¶</a></dt>
<dd><p>Log messages will be forwarded to the remote host using the UDP protocol.
This class attribute was added in vSphere API 6.7.</p>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.logging_client.Forwarding.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the configuration for forwarding log messages to remote logging
servers. This method was added in vSphere API 6.7.</p>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body">Information about the configuration for forwarding log messages to
<codeclass="descname">set</code><spanclass="sig-paren">(</span><em>cfg_list</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.logging_client.Forwarding.set"title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the configuration for forwarding log messages to remote log
servers. This method was added in vSphere API 6.7.</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>cfg_list</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.appliance.logging_client.Forwarding.Config"title="com.vmware.appliance.logging_client.Forwarding.Config"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Forwarding.Config</span></code></a>) – The cfgList is a list of Config structure that contains the log
message forwarding rules in terms of the host, port, protocol of
<codeclass="descname">test</code><spanclass="sig-paren">(</span><em>send_test_message=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.logging_client.Forwarding.test"title="Permalink to this definition">¶</a></dt>
<dd><p>Validates the current log forwarding configuration by checking the
liveness of the remote machine and optionally sending a test diagnostic
log message from the appliance to all configured logging servers to
allow manual end-to-end validation. The message that is sent is: “This
is a diagnostic log test message from vCenter Server.”. This method was
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>send_test_message</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 specifying whether a default test message should be sent to
the configured logging servers.
If None, no test message will be sent to the configured remote
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.logging_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.logging_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-appliance-monitoring-client-module"></span><h2>com.vmware.appliance.monitoring_client module<aclass="headerlink"href="#module-com.vmware.appliance.monitoring_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.appliance.monitoring_client</span></code> module provides classes for
monitoring of the appliance. The module is available starting in vSphere 6.5.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.monitoring_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.monitoring_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-appliance-networking-client-module"></span><h2>com.vmware.appliance.networking_client module<aclass="headerlink"href="#module-com.vmware.appliance.networking_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.appliance.networking_client</span></code> module provides classes for
managing network configuration of the appliance. The module is available
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.networking_client.</code><codeclass="descname">Interfaces</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking_client.Interfaces"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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.</td>
<emclass="property">class </em><codeclass="descname">InterfaceInfo</code><spanclass="sig-paren">(</span><em>name=None</em>, <em>status=None</em>, <em>mac=None</em>, <em>ipv4=None</em>, <em>ipv6=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking_client.Interfaces.InterfaceInfo"title="Permalink to this definition">¶</a></dt>
<li><strong>mac</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – MAC address. For example 00:0C:29:94:BB:5A.</li>
<li><strong>ipv4</strong> (<aclass="reference internal"href="com.vmware.appliance.networking.html#com.vmware.appliance.networking.interfaces_client.Ipv4.Info"title="com.vmware.appliance.networking.interfaces_client.Ipv4.Info"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.appliance.networking.interfaces_client.Ipv4.Info</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – IPv4 Address information. This attribute was added in vSphere API
6.7.
ipv4 This attribute will be None if IPv4 is not enabled.</li>
<li><strong>ipv6</strong> (<aclass="reference internal"href="com.vmware.appliance.networking.html#com.vmware.appliance.networking.interfaces_client.Ipv6.Info"title="com.vmware.appliance.networking.interfaces_client.Ipv6.Info"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.appliance.networking.interfaces_client.Ipv6.Info</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – IPv6 Address information. This attribute was added in vSphere API
6.7.
ipv6 This attribute will be None if IPv6 is not enabled.</li>
<emclass="property">class </em><codeclass="descname">InterfaceStatus</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking_client.Interfaces.InterfaceStatus"title="Permalink to this definition">¶</a></dt>
<p><codeclass="docutils literal notranslate"><spanclass="pre">Interfaces.InterfaceStatus</span></code> class Defines interface status</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">This class represents an enumerated type in the interface language
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">down</code><emclass="property"> = InterfaceStatus(string='down')</em><aclass="headerlink"href="#com.vmware.appliance.networking_client.Interfaces.InterfaceStatus.down"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">up</code><emclass="property"> = InterfaceStatus(string='up')</em><aclass="headerlink"href="#com.vmware.appliance.networking_client.Interfaces.InterfaceStatus.up"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>interface_name</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking_client.Interfaces.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Get information about a particular network interface.</p>
<codeclass="descname">list</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking_client.Interfaces.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Get list of available network interfaces, including those that are not
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.networking_client.</code><codeclass="descname">NoProxy</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking_client.NoProxy"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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.</td>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking_client.NoProxy.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns servers for which no proxy configuration will be applied. This
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body">List of servers for which no proxy configuration will be applied.</td>
<codeclass="descname">set</code><spanclass="sig-paren">(</span><em>servers</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking_client.NoProxy.set"title="Permalink to this definition">¶</a></dt>
<dd><p>Sets servers for which no proxy configuration should be applied. This
operation sets environment variables. In order for this operation to
take effect, a logout from appliance or a service restart is required.
If IPv4 is enabled, “127.0.0.1” and “localhost” will always bypass the
proxy (even if they are not explicitly configured). This method was
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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 strings representing servers to bypass proxy. A server can
be a FQDN, IP address, FQDN:port or IP:port combinations.</td>
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.networking_client.</code><codeclass="descname">Proxy</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking_client.Proxy"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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.</td>
<emclass="property">class </em><codeclass="descname">Config</code><spanclass="sig-paren">(</span><em>server=None</em>, <em>port=None</em>, <em>username=None</em>, <em>password=None</em>, <em>enabled=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking_client.Proxy.Config"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>server</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Hostname or IP address of the proxy server. This attribute was
added in vSphere API 6.7.</li>
<li><strong>port</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Port to connect to the proxy server. In a ‘get’ call, indicates the
port connected to the proxy server. In a ‘set’ call, specifies the
port to connect to the proxy server. A value of -1 indicates the
default port. This attribute was added in vSphere API 6.7.</li>
<li><strong>username</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Username for proxy server. This attribute was added in vSphere API
6.7.
Only <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> if proxy requires username.</li>
<li><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 for proxy server. This attribute was added in vSphere API
6.7.
Only <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> if proxy requires password.</li>
<li><strong>enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – In the result of the <codeclass="docutils literal notranslate"><spanclass="pre">#get</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">#list</span></code> methods this attribute
indicates whether proxying is enabled for a particular protocol. In
the input to the <codeclass="docutils literal notranslate"><spanclass="pre">test</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">set</span></code> methods this attribute
specifies whether proxying should be enabled for a particular
protocol. This attribute was added in vSphere API 6.7.</li>
<emclass="property">class </em><codeclass="descname">Protocol</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking_client.Proxy.Protocol"title="Permalink to this definition">¶</a></dt>
<p><codeclass="docutils literal notranslate"><spanclass="pre">Proxy.Protocol</span></code> class defines the protocols for which proxying is
supported. This enumeration was added in vSphere API 6.7.</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">This class represents an enumerated type in the interface language
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">FTP</code><emclass="property"> = Protocol(string='FTP')</em><aclass="headerlink"href="#com.vmware.appliance.networking_client.Proxy.Protocol.FTP"title="Permalink to this definition">¶</a></dt>
<dd><p>Proxy configuration for ftp. This class attribute was added in vSphere API
<codeclass="descname">HTTP</code><emclass="property"> = Protocol(string='HTTP')</em><aclass="headerlink"href="#com.vmware.appliance.networking_client.Proxy.Protocol.HTTP"title="Permalink to this definition">¶</a></dt>
<dd><p>Proxy configuration for http. This class attribute was added in vSphere API
<codeclass="descname">HTTPS</code><emclass="property"> = Protocol(string='HTTPS')</em><aclass="headerlink"href="#com.vmware.appliance.networking_client.Proxy.Protocol.HTTPS"title="Permalink to this definition">¶</a></dt>
<dd><p>Proxy configuration for https. This class attribute was added in vSphere
<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.networking_client.Proxy.ServerStatus"title="Permalink to this definition">¶</a></dt>
<p><codeclass="docutils literal notranslate"><spanclass="pre">Proxy.ServerStatus</span></code> class defines the status of the server associated
with the test run. This enumeration was added in vSphere API 6.7.</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">This class represents an enumerated type in the interface language
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.networking_client.Proxy.ServerStatus.SERVER_REACHABLE"title="Permalink to this definition">¶</a></dt>
<dd><p>Server is reachable. This class attribute was added in vSphere API 6.7.</p>
<codeclass="descname">SERVER_UNREACHABLE</code><emclass="property"> = ServerStatus(string='SERVER_UNREACHABLE')</em><aclass="headerlink"href="#com.vmware.appliance.networking_client.Proxy.ServerStatus.SERVER_UNREACHABLE"title="Permalink to this definition">¶</a></dt>
<dd><p>Server is unreachable. This class attribute was added in vSphere API 6.7.</p>
<emclass="property">class </em><codeclass="descname">TestResult</code><spanclass="sig-paren">(</span><em>status=None</em>, <em>message=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking_client.Proxy.TestResult"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>status</strong> (<aclass="reference internal"href="#com.vmware.appliance.networking_client.Proxy.ServerStatus"title="com.vmware.appliance.networking_client.Proxy.ServerStatus"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Proxy.ServerStatus</span></code></a>) – Status of the proxy server indicating whether the proxy server is
reachable. This attribute was added in vSphere API 6.7.</li>
<li><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>) – Message associated with status. This attribute was added in vSphere
<codeclass="descname">delete</code><spanclass="sig-paren">(</span><em>protocol</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking_client.Proxy.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Deletes a proxy configuration for a specific protocol. This method was
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>protocol</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – ID whose proxy is to be deleted.</td>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>protocol</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking_client.Proxy.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Gets the proxy configuration for a specific protocol. This method was
<codeclass="descname">list</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking_client.Proxy.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Gets proxy configuration for all configured protocols. This method was
<codeclass="descname">set</code><spanclass="sig-paren">(</span><em>protocol</em>, <em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking_client.Proxy.set"title="Permalink to this definition">¶</a></dt>
<dd><p>Configures which proxy server to use for the specified protocol. This
operation sets environment variables for using proxy. In order for this
configuration to take effect a logout / service restart is required.
<li><strong>protocol</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The protocol for which proxy should be set.</li>
<li><strong>config</strong> (<aclass="reference internal"href="#com.vmware.appliance.networking_client.Proxy.Config"title="com.vmware.appliance.networking_client.Proxy.Config"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Proxy.Config</span></code></a>) – Proxy configuration for the specific protocol.</li>
<codeclass="descname">test</code><spanclass="sig-paren">(</span><em>host</em>, <em>protocol</em>, <em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking_client.Proxy.test"title="Permalink to this definition">¶</a></dt>
<dd><p>Tests a proxy configuration by testing the connection to the proxy
server and test host. This method was added in vSphere API 6.7.</p>
<li><strong>host</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – A hostname, IPv4 or Ipv6 address.</li>
<li><strong>protocol</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Protocol whose proxy is to be tested.</li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.networking_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.networking_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-appliance-ntp-client-module"></span><h2>com.vmware.appliance.ntp_client module<aclass="headerlink"href="#module-com.vmware.appliance.ntp_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.appliance.ntp_client</span></code> module provides classes for managing
NTP settings of the appliance. The module is available starting in vSphere 6.5.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.ntp_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.ntp_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-appliance-recovery-client-module"></span><h2>com.vmware.appliance.recovery_client module<aclass="headerlink"href="#module-com.vmware.appliance.recovery_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.appliance.recovery_client</span></code> module provides classes for backin
up and restoring vCenter Appliance configuration. The module is available
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.recovery_client.</code><codeclass="descname">Backup</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery_client.Backup"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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.</td>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>parts</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>) – a list of optional parts. Run backup parts APIs to get list of
optional parts and description</li>
<li><strong>backup_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>) – a password for a backup piece The backupPassword must adhere to the
following password requirements: At least 8 characters, cannot be
more than 20 characters in length. At least 1 uppercase letter. At
least 1 lowercase letter. At least 1 numeric digit. At least 1
special character (i.e. any character not in [0-9,a-z,A-Z]). Only
visible ASCII characters (for example, no space).
backupPassword If no password then the piece will not be encrypted</li>
<li><strong>location_type</strong> (<aclass="reference internal"href="#com.vmware.appliance.recovery_client.Backup.LocationType"title="com.vmware.appliance.recovery_client.Backup.LocationType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Backup.LocationType</span></code></a>) – a type of location</li>
<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.recovery_client.Backup.LocalizableMessage"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descname">LocationType</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery_client.Backup.LocationType"title="Permalink to this definition">¶</a></dt>
<p><codeclass="docutils literal notranslate"><spanclass="pre">Backup.LocationType</span></code> class Defines type of all locations for
backup/restore</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">This class represents an enumerated type in the interface language
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">FTP</code><emclass="property"> = LocationType(string='FTP')</em><aclass="headerlink"href="#com.vmware.appliance.recovery_client.Backup.LocationType.FTP"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">FTPS</code><emclass="property"> = LocationType(string='FTPS')</em><aclass="headerlink"href="#com.vmware.appliance.recovery_client.Backup.LocationType.FTPS"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">HTTP</code><emclass="property"> = LocationType(string='HTTP')</em><aclass="headerlink"href="#com.vmware.appliance.recovery_client.Backup.LocationType.HTTP"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">HTTPS</code><emclass="property"> = LocationType(string='HTTPS')</em><aclass="headerlink"href="#com.vmware.appliance.recovery_client.Backup.LocationType.HTTPS"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">SCP</code><emclass="property"> = LocationType(string='SCP')</em><aclass="headerlink"href="#com.vmware.appliance.recovery_client.Backup.LocationType.SCP"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descname">ReturnResult</code><spanclass="sig-paren">(</span><em>status=None</em>, <em>messages=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery_client.Backup.ReturnResult"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descname">ReturnStatus</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery_client.Backup.ReturnStatus"title="Permalink to this definition">¶</a></dt>
<p><codeclass="docutils literal notranslate"><spanclass="pre">Backup.ReturnStatus</span></code> class Defines the state of precheck</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">This class represents an enumerated type in the interface language
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">FAIL</code><emclass="property"> = ReturnStatus(string='FAIL')</em><aclass="headerlink"href="#com.vmware.appliance.recovery_client.Backup.ReturnStatus.FAIL"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">OK</code><emclass="property"> = ReturnStatus(string='OK')</em><aclass="headerlink"href="#com.vmware.appliance.recovery_client.Backup.ReturnStatus.OK"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">WARNING</code><emclass="property"> = ReturnStatus(string='WARNING')</em><aclass="headerlink"href="#com.vmware.appliance.recovery_client.Backup.ReturnStatus.WARNING"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">validate</code><spanclass="sig-paren">(</span><em>piece</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery_client.Backup.validate"title="Permalink to this definition">¶</a></dt>
<dd><p>Check for backup errors without starting backup.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.recovery_client.</code><codeclass="descname">Restore</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery_client.Restore"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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.</td>
<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.recovery_client.Restore.LocalizableMessage"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descname">LocationType</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery_client.Restore.LocationType"title="Permalink to this definition">¶</a></dt>
<p><codeclass="docutils literal notranslate"><spanclass="pre">Restore.LocationType</span></code> class Defines type of all locations for
backup/restore</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">This class represents an enumerated type in the interface language
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">FTP</code><emclass="property"> = LocationType(string='FTP')</em><aclass="headerlink"href="#com.vmware.appliance.recovery_client.Restore.LocationType.FTP"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">FTPS</code><emclass="property"> = LocationType(string='FTPS')</em><aclass="headerlink"href="#com.vmware.appliance.recovery_client.Restore.LocationType.FTPS"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">HTTP</code><emclass="property"> = LocationType(string='HTTP')</em><aclass="headerlink"href="#com.vmware.appliance.recovery_client.Restore.LocationType.HTTP"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">HTTPS</code><emclass="property"> = LocationType(string='HTTPS')</em><aclass="headerlink"href="#com.vmware.appliance.recovery_client.Restore.LocationType.HTTPS"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">SCP</code><emclass="property"> = LocationType(string='SCP')</em><aclass="headerlink"href="#com.vmware.appliance.recovery_client.Restore.LocationType.SCP"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>timestamp</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Time when this backup was completed.</li>
<li><strong>parts</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 parts included in the backup.</li>
<li><strong>boxname</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Box name is PNID/ FQDN etc</li>
<li><strong>sso_login_required</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Is SSO login required for the vCenter server. This attribute was
added in vSphere API 6.7.
This attribute is optional because it was added in a newer version
<li><strong>applicable</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Does the VCSA match the deployment type, network properties and
version of backed up VC</li>
<li><strong>messages</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.appliance.recovery_client.Restore.LocalizableMessage"title="com.vmware.appliance.recovery_client.Restore.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Restore.LocalizableMessage</span></code></a>) – Any messages if the backup is not aplicable</li>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>backup_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>) – a password for a backup piece
backupPassword If no password then the piece will not be decrypted</li>
<li><strong>location_type</strong> (<aclass="reference internal"href="#com.vmware.appliance.recovery_client.Restore.LocationType"title="com.vmware.appliance.recovery_client.Restore.LocationType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Restore.LocationType</span></code></a>) – a type of location</li>
<li><strong>location_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>) – username for location
locationUser User name for this location if login is required.</li>
<li><strong>location_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 for location
locationPassword Password for the specified user if login is
required at this location.</li>
<li><strong>sso_admin_user_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>) – Administrators username for SSO. This attribute was added in
vSphere API 6.7.
If None SSO authentication will not be used. If the vCenter Server
is a management node or an embedded node, authentication is
required.</li>
<li><strong>sso_admin_user_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>) – The password for SSO admin user. This attribute was added in
vSphere API 6.7.
If None SSO authentication will not be used. If the vCenter Server
is a management node or an embedded node, authentication is
<codeclass="descname">validate</code><spanclass="sig-paren">(</span><em>piece</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery_client.Restore.validate"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.recovery_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-appliance-shutdown-client-module"></span><h2>com.vmware.appliance.shutdown_client module<aclass="headerlink"href="#module-com.vmware.appliance.shutdown_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.appliance.shutdown_client</span></code> module provides classes to
shutdown and reboot the appliance. The module is available starting in vSphere
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.shutdown_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.shutdown_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-appliance-system-client-module"></span><h2>com.vmware.appliance.system_client module<aclass="headerlink"href="#module-com.vmware.appliance.system_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.appliance.system_client</span></code> module provides classes to query the
appliance system information. The module is available starting in vSphere 6.5.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.system_client.</code><codeclass="descname">Storage</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.system_client.Storage"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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.</td>
<emclass="property">class </em><codeclass="descname">StorageChange</code><spanclass="sig-paren">(</span><em>old_size=None</em>, <em>new_size=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.system_client.Storage.StorageChange"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>old_size</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Original size of the partition in MB. This attribute was added in
vSphere API 6.7.</li>
<li><strong>new_size</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Nedw size of the partition in MB. This attribute was added in
<emclass="property">class </em><codeclass="descname">StorageMapping</code><spanclass="sig-paren">(</span><em>disk=None</em>, <em>partition=None</em>, <em>description=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.system_client.Storage.StorageMapping"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>disk</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The disk number in the vSphere Web Client.
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.appliance.system.storage</span></code>. When methods return a
value of this class as a return value, the attribute will be an
<li><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 partition. This attribute was added in vSphere API
6.7.
This attribute is optional because it was added in a newer version
<codeclass="descname">list</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.system_client.Storage.list"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">resize</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.system_client.Storage.resize"title="Permalink to this definition">¶</a></dt>
<dd><p>Resize all partitions to 100 percent of disk size.</p>
<codeclass="descname">resize_ex</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.system_client.Storage.resize_ex"title="Permalink to this definition">¶</a></dt>
<dd><p>Resize all partitions to 100 percent of disk size. This method was
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body">List of the partitions with the size before and after resizing</td>
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.system_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.system_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.system_client.</code><codeclass="descname">Time</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.system_client.Time"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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.</td>
<emclass="property">class </em><codeclass="descname">SystemTimeStruct</code><spanclass="sig-paren">(</span><em>seconds_since_epoch=None</em>, <em>date=None</em>, <em>time=None</em>, <em>timezone=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.system_client.Time.SystemTimeStruct"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.system_client.Time.get"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.system_client.</code><codeclass="descname">Uptime</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.system_client.Uptime"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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.</td>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.system_client.Uptime.get"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.system_client.</code><codeclass="descname">Version</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.system_client.Version"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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.</td>
<li><strong>type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Type of product. Same product can have different deployment
options, which is represented by type.</li>
<li><strong>summary</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Summary of patch (empty string, if the appliance has not been
patched)</li>
<li><strong>releasedate</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Release date of patch (empty string, if the appliance has not been
patched)</li>
<li><strong>install_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Display the date and time when this system was first installed.
<codeclass="descname">get</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.system_client.Version.get"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-appliance-tymesync-client-module"></span><h2>com.vmware.appliance.tymesync_client module<aclass="headerlink"href="#module-com.vmware.appliance.tymesync_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.appliance.tymesync_client</span></code> module provides classes for
managing tyme synchronization settings of the appliance. The module is
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.tymesync_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.tymesync_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-appliance-update-client-module"></span><h2>com.vmware.appliance.update_client module<aclass="headerlink"href="#module-com.vmware.appliance.update_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.appliance.update_client</span></code> module provides classes for updating
the software in the appliance. The module is available starting in vSphere 6.5.</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><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 update. The short information what this update
is. E.g. “Update2 for vCenter Server Appliance 6.5”. This attribute
was added in vSphere API 6.7.</li>
<li><strong>priority</strong> (<aclass="reference internal"href="#com.vmware.appliance.update_client.CommonInfo.Priority"title="com.vmware.appliance.update_client.CommonInfo.Priority"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">CommonInfo.Priority</span></code></a>) – Update priority. This attribute was added in vSphere API 6.7.</li>
<li><strong>severity</strong> (<aclass="reference internal"href="#com.vmware.appliance.update_client.CommonInfo.Severity"title="com.vmware.appliance.update_client.CommonInfo.Severity"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">CommonInfo.Severity</span></code></a>) – Update severity. This attribute was added in vSphere API 6.7.</li>
<li><strong>update_type</strong> (<aclass="reference internal"href="#com.vmware.appliance.update_client.CommonInfo.Category"title="com.vmware.appliance.update_client.CommonInfo.Category"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">CommonInfo.Category</span></code></a>) – Update category. This attribute was added in vSphere API 6.7.</li>
<li><strong>release_date</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Update release date. This attribute was added in vSphere API 6.7.</li>
<li><strong>reboot_required</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag indicating whether reboot is required after update. This
attribute was added in vSphere API 6.7.</li>
<li><strong>size</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Download Size of update in Megabytes. This attribute was added in
<emclass="property">class </em><codeclass="descname">Category</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.update_client.CommonInfo.Category"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">CommonInfo.Category</span></code> class defines update type. This enumeration was
added in vSphere API 6.7.</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">This class represents an enumerated type in the interface language
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">FIX</code><emclass="property"> = Category(string='FIX')</em><aclass="headerlink"href="#com.vmware.appliance.update_client.CommonInfo.Category.FIX"title="Permalink to this definition">¶</a></dt>
<dd><p>Fixes bugs/vulnerabilities, doesn’t change functionality. This class
<codeclass="descname">SECURITY</code><emclass="property"> = Category(string='SECURITY')</em><aclass="headerlink"href="#com.vmware.appliance.update_client.CommonInfo.Category.SECURITY"title="Permalink to this definition">¶</a></dt>
<dd><p>Fixes vulnerabilities, doesn’t change functionality. This class attribute
<codeclass="descname">UPDATE</code><emclass="property"> = Category(string='UPDATE')</em><aclass="headerlink"href="#com.vmware.appliance.update_client.CommonInfo.Category.UPDATE"title="Permalink to this definition">¶</a></dt>
<dd><p>Changes product functionality. This class attribute was added in vSphere
<codeclass="descname">UPGRADE</code><emclass="property"> = Category(string='UPGRADE')</em><aclass="headerlink"href="#com.vmware.appliance.update_client.CommonInfo.Category.UPGRADE"title="Permalink to this definition">¶</a></dt>
<dd><p>Introduces new features, significantly changes product functionality. This
<emclass="property">class </em><codeclass="descname">Priority</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.update_client.CommonInfo.Priority"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">CommonInfo.Priority</span></code> class defines the update installation priority
recommendations. This enumeration was added in vSphere API 6.7.</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">This class represents an enumerated type in the interface language
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">HIGH</code><emclass="property"> = Priority(string='HIGH')</em><aclass="headerlink"href="#com.vmware.appliance.update_client.CommonInfo.Priority.HIGH"title="Permalink to this definition">¶</a></dt>
<dd><p>Install ASAP. This class attribute was added in vSphere API 6.7.</p>
<codeclass="descname">LOW</code><emclass="property"> = Priority(string='LOW')</em><aclass="headerlink"href="#com.vmware.appliance.update_client.CommonInfo.Priority.LOW"title="Permalink to this definition">¶</a></dt>
<dd><p>Install at your discretion. This class attribute was added in vSphere API
<codeclass="descname">MEDIUM</code><emclass="property"> = Priority(string='MEDIUM')</em><aclass="headerlink"href="#com.vmware.appliance.update_client.CommonInfo.Priority.MEDIUM"title="Permalink to this definition">¶</a></dt>
<dd><p>Install at the earliest convenience. This class attribute was added in
<emclass="property">class </em><codeclass="descname">Severity</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.update_client.CommonInfo.Severity"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">CommonInfo.Severity</span></code> class defines the severity of the issues fixed
in the update. This enumeration was added in vSphere API 6.7.</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">This class represents an enumerated type in the interface language
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">CRITICAL</code><emclass="property"> = Severity(string='CRITICAL')</em><aclass="headerlink"href="#com.vmware.appliance.update_client.CommonInfo.Severity.CRITICAL"title="Permalink to this definition">¶</a></dt>
<dd><p>Vulnerabilities that can be exploited by an unauthenticated attacker from
the Internet or those that break the guest/host Operating System isolation.
The exploitation results in the complete compromise of confidentiality,
integrity, and availability of user data and/or processing resources
without user interaction. Exploitation could be leveraged to propagate an
Internet worm or execute arbitrary code between Virtual Machines and/or the
Host Operating System. This class attribute was added in vSphere API 6.7.</p>
<codeclass="descname">IMPORTANT</code><emclass="property"> = Severity(string='IMPORTANT')</em><aclass="headerlink"href="#com.vmware.appliance.update_client.CommonInfo.Severity.IMPORTANT"title="Permalink to this definition">¶</a></dt>
<dd><p>Vulnerabilities that are not rated critical but whose exploitation results
in the complete compromise of confidentiality and/or integrity of user data
and/or processing resources through user assistance or by authenticated
attackers. This rating also applies to those vulnerabilities which could
lead to the complete compromise of availability when exploitation is by a
remote unauthenticated attacker from the Internet or through a breach of
virtual machine isolation. This class attribute was added in vSphere API
<codeclass="descname">LOW</code><emclass="property"> = Severity(string='LOW')</em><aclass="headerlink"href="#com.vmware.appliance.update_client.CommonInfo.Severity.LOW"title="Permalink to this definition">¶</a></dt>
<dd><p>All other issues that have a security impact. Vulnerabilities where
exploitation is believed to be extremely difficult, or where successful
exploitation would have minimal impact. This class attribute was added in
<codeclass="descname">MODERATE</code><emclass="property"> = Severity(string='MODERATE')</em><aclass="headerlink"href="#com.vmware.appliance.update_client.CommonInfo.Severity.MODERATE"title="Permalink to this definition">¶</a></dt>
<dd><p>Vulnerabilities where the ability to exploit is mitigated to a significant
degree by configuration or difficulty of exploitation, but in certain
deployment scenarios could still lead to the compromise of confidentiality,
integrity, or availability of user data and/or processing resources. This
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.update_client.</code><codeclass="descname">Pending</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.update_client.Pending"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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.</td>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>contents</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>) – List of the 1. issues addressed since previous/current version 2.
new features/improvements. This attribute was added in vSphere API
6.7.</li>
<li><strong>services_will_be_stopped</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.appliance.update_client.ServiceInfo"title="com.vmware.appliance.update_client.ServiceInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ServiceInfo</span></code></a>) – List of the services that will be stopped and restarted during the
update installation. This attribute was added in vSphere API 6.7.</li>
<li><strong>eulas</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>) – List of EULAs. This list has multiple entries and can be dynamic
based on what we are actually installing. This attribute was added
in vSphere API 6.7.</li>
<li><strong>staged</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Is the update staged. This attribute was added in vSphere API 6.7.</li>
<li><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 update. The short information what this update
is. E.g. “Update2 for vCenter Server Appliance 6.5”. This attribute
was added in vSphere API 6.7.</li>
<li><strong>priority</strong> (<aclass="reference internal"href="#com.vmware.appliance.update_client.CommonInfo.Priority"title="com.vmware.appliance.update_client.CommonInfo.Priority"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">CommonInfo.Priority</span></code></a>) – Update priority. This attribute was added in vSphere API 6.7.</li>
<li><strong>severity</strong> (<aclass="reference internal"href="#com.vmware.appliance.update_client.CommonInfo.Severity"title="com.vmware.appliance.update_client.CommonInfo.Severity"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">CommonInfo.Severity</span></code></a>) – Update severity. This attribute was added in vSphere API 6.7.</li>
<li><strong>update_type</strong> (<aclass="reference internal"href="#com.vmware.appliance.update_client.CommonInfo.Category"title="com.vmware.appliance.update_client.CommonInfo.Category"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">CommonInfo.Category</span></code></a>) – Update category. This attribute was added in vSphere API 6.7.</li>
<li><strong>release_date</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Update release date. This attribute was added in vSphere API 6.7.</li>
<li><strong>reboot_required</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag indicating whether reboot is required after update. This
attribute was added in vSphere API 6.7.</li>
<li><strong>size</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Download Size of update in Megabytes. This attribute was added in
<emclass="property">class </em><codeclass="descname">PrecheckResult</code><spanclass="sig-paren">(</span><em>check_time=None</em>, <em>estimated_time_to_install=None</em>, <em>estimated_time_to_rollback=None</em>, <em>reboot_required=None</em>, <em>issues=None</em>, <em>questions=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.update_client.Pending.PrecheckResult"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>check_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Time when this precheck was run. This attribute was added in
vSphere API 6.7.</li>
<li><strong>estimated_time_to_install</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Rough estimate of time to install the update (minutes). This
attribute was added in vSphere API 6.7.
estimatedTimeToInstall If None N/A</li>
<li><strong>estimated_time_to_rollback</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Rough estimate of time to rollback the update (minutes). This
attribute was added in vSphere API 6.7.
estimatedTimeToRollback If None N/A</li>
<li><strong>reboot_required</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Is reboot required to install the update. This attribute was added
in vSphere API 6.7.</li>
<li><strong>issues</strong> (<aclass="reference internal"href="com.vmware.html#com.vmware.appliance_client.Notifications"title="com.vmware.appliance_client.Notifications"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.appliance_client.Notifications</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Lists of the issues and warnings. This attribute was added in
vSphere API 6.7.
issues If None N/A</li>
<li><strong>questions</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.appliance.update_client.Pending.Question"title="com.vmware.appliance.update_client.Pending.Question"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Pending.Question</span></code></a>) – List of questions that must be answered to install the update. This
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>data_item</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – ID of the data item. This attribute was added in vSphere API 6.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">com.vmware.applicance.update.pending.dataitem</span></code>. When methods
return a value of this class as a return value, the attribute will
<li><strong>text</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>) – Label for the item to be used in GUI/CLI. This attribute was added
in vSphere API 6.7.</li>
<li><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 item. This attribute was added in vSphere API
6.7.</li>
<li><strong>type</strong> (<aclass="reference internal"href="#com.vmware.appliance.update_client.Pending.Question.InputType"title="com.vmware.appliance.update_client.Pending.Question.InputType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Pending.Question.InputType</span></code></a>) – How this field shoudl be represented in GUI or CLI. This attribute
was added in vSphere API 6.7.</li>
<li><strong>allowed_values</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>) – List of allowed values. This attribute was added in vSphere API
6.7.
allowedValues If None any value is valid.</li>
<li><strong>regexp</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Regexp to validate the input. This attribute was added in vSphere
API 6.7.
regexp If None no validation will be performed.</li>
<li><strong>default_answer</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Default answer. This attribute was added in vSphere API 6.7.
defaultAnswer If None then there is no default answer, so an
<emclass="property">class </em><codeclass="descname">InputType</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.update_client.Pending.Question.InputType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Pending.Question.InputType</span></code> class defines representation of field
fields in GUI or CLI. This enumeration was added in vSphere API 6.7.</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">This class represents an enumerated type in the interface language
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">BOOLEAN</code><emclass="property"> = InputType(string='BOOLEAN')</em><aclass="headerlink"href="#com.vmware.appliance.update_client.Pending.Question.InputType.BOOLEAN"title="Permalink to this definition">¶</a></dt>
<dd><p>Yes/No,On/Off,Checkbox answer. This class attribute was added in vSphere
<codeclass="descname">PASSWORD</code><emclass="property"> = InputType(string='PASSWORD')</em><aclass="headerlink"href="#com.vmware.appliance.update_client.Pending.Question.InputType.PASSWORD"title="Permalink to this definition">¶</a></dt>
<dd><p>Password (masked) answer. This class attribute was added in vSphere API
<codeclass="descname">PLAIN_TEXT</code><emclass="property"> = InputType(string='PLAIN_TEXT')</em><aclass="headerlink"href="#com.vmware.appliance.update_client.Pending.Question.InputType.PLAIN_TEXT"title="Permalink to this definition">¶</a></dt>
<dd><p>plain text answer. This class attribute was added in vSphere API 6.7.</p>
<emclass="property">class </em><codeclass="descname">SourceType</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.update_client.Pending.SourceType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Pending.SourceType</span></code> class defines the supported types of sources of
updates. This enumeration was added in vSphere API 6.7.</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">This class represents an enumerated type in the interface language
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">LAST_CHECK</code><emclass="property"> = SourceType(string='LAST_CHECK')</em><aclass="headerlink"href="#com.vmware.appliance.update_client.Pending.SourceType.LAST_CHECK"title="Permalink to this definition">¶</a></dt>
<dd><p>Do not perform a new check, return the previous result. This class
<codeclass="descname">LOCAL</code><emclass="property"> = SourceType(string='LOCAL')</em><aclass="headerlink"href="#com.vmware.appliance.update_client.Pending.SourceType.LOCAL"title="Permalink to this definition">¶</a></dt>
<dd><p>Check the local sources, ISO devices, staged area. This class attribute was
<codeclass="descname">LOCAL_AND_ONLINE</code><emclass="property"> = SourceType(string='LOCAL_AND_ONLINE')</em><aclass="headerlink"href="#com.vmware.appliance.update_client.Pending.SourceType.LOCAL_AND_ONLINE"title="Permalink to this definition">¶</a></dt>
<dd><p>Check the local sources, ISO devices, staged area, then online repository
as stated in update policy. This class attribute was added in vSphere API
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>version</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.update_client.Pending.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Gets update information. This method was added in vSphere API 6.7.</p>
<codeclass="descname">install</code><spanclass="sig-paren">(</span><em>version</em>, <em>user_data</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.update_client.Pending.install"title="Permalink to this definition">¶</a></dt>
<dd><p>Starts operation of installing the appliance update. Will fail is the
update is not staged. This method was added in vSphere API 6.7.</p>
<li><strong>user_data</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 <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – map of user provided data with IDs
The key in the parameter <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> must be an identifier for
<codeclass="descname">list</code><spanclass="sig-paren">(</span><em>source_type</em>, <em>url=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.update_client.Pending.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Checks if new updates are available. This method was added in vSphere
<li><strong>source_type</strong> (<aclass="reference internal"href="#com.vmware.appliance.update_client.Pending.SourceType"title="com.vmware.appliance.update_client.Pending.SourceType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Pending.SourceType</span></code></a>) – type of the source</li>
<li><strong>url</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – specific URL to check at
If None then URL is taken from the policy settings</li>
<codeclass="descname">precheck</code><spanclass="sig-paren">(</span><em>version</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.update_client.Pending.precheck"title="Permalink to this definition">¶</a></dt>
<dd><p>Runs update precheck. This method was added in vSphere API 6.7.</p>
<codeclass="descname">stage</code><spanclass="sig-paren">(</span><em>version</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.update_client.Pending.stage"title="Permalink to this definition">¶</a></dt>
<dd><p>Starts staging the appliance update. The updates are searched for in
the following order: staged, CDROM, URL. This method was added in
<codeclass="descname">stage_and_install</code><spanclass="sig-paren">(</span><em>version</em>, <em>user_data</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.update_client.Pending.stage_and_install"title="Permalink to this definition">¶</a></dt>
<dd><p>Starts operation of installing the appliance update. Will stage update
if not already staged The updates are searched for in the following
order: staged, CDROM, URL. This method was added in vSphere API 6.7.</p>
<li><strong>user_data</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 <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – map of user provided data with IDs
The key in the parameter <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> must be an identifier for
<codeclass="descname">validate</code><spanclass="sig-paren">(</span><em>version</em>, <em>user_data</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.update_client.Pending.validate"title="Permalink to this definition">¶</a></dt>
<dd><p>Validates the user provided data before the update installation. This
<li><strong>user_data</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 <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – map of user provided data with IDs
The key in the parameter <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> must be an identifier for
<trclass="field-odd field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first">Issues struct with the issues found during the validation</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.update_client.</code><codeclass="descname">Policy</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.update_client.Policy"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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.</td>
<emclass="property">class </em><codeclass="descname">Config</code><spanclass="sig-paren">(</span><em>custom_url=None</em>, <em>username=None</em>, <em>password=None</em>, <em>check_schedule=None</em>, <em>auto_stage=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.update_client.Policy.Config"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>custom_url</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Current appliance update repository URL. This attribute was added
in vSphere API 6.7.
If None then default URL is assumed</li>
<li><strong>username</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Username for the update repository. This attribute was added in
vSphere API 6.7.
If None username will not be used to login</li>
<li><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 for the update repository. This attribute was added in
vSphere API 6.7.
password If None password will not be used to login</li>
<li><strong>check_schedule</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.appliance.update_client.Policy.Time"title="com.vmware.appliance.update_client.Policy.Time"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Policy.Time</span></code></a>) – Schedule when the automatic check will be run. This attribute was
added in vSphere API 6.7.</li>
<li><strong>auto_stage</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Automatically stage the latest update if available. This attribute
<emclass="property">class </em><codeclass="descname">DayOfWeek</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.update_client.Policy.DayOfWeek"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Policy.DayOfWeek</span></code> class defines the set of days. This enumeration
was added in vSphere API 6.7.</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">This class represents an enumerated type in the interface language
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">FRIDAY</code><emclass="property"> = DayOfWeek(string='FRIDAY')</em><aclass="headerlink"href="#com.vmware.appliance.update_client.Policy.DayOfWeek.FRIDAY"title="Permalink to this definition">¶</a></dt>
<dd><p>Friday. This class attribute was added in vSphere API 6.7.</p>
<codeclass="descname">MONDAY</code><emclass="property"> = DayOfWeek(string='MONDAY')</em><aclass="headerlink"href="#com.vmware.appliance.update_client.Policy.DayOfWeek.MONDAY"title="Permalink to this definition">¶</a></dt>
<dd><p>Monday. This class attribute was added in vSphere API 6.7.</p>
<codeclass="descname">SATURDAY</code><emclass="property"> = DayOfWeek(string='SATURDAY')</em><aclass="headerlink"href="#com.vmware.appliance.update_client.Policy.DayOfWeek.SATURDAY"title="Permalink to this definition">¶</a></dt>
<dd><p>Saturday. This class attribute was added in vSphere API 6.7.</p>
<codeclass="descname">SUNDAY</code><emclass="property"> = DayOfWeek(string='SUNDAY')</em><aclass="headerlink"href="#com.vmware.appliance.update_client.Policy.DayOfWeek.SUNDAY"title="Permalink to this definition">¶</a></dt>
<dd><p>Sunday. This class attribute was added in vSphere API 6.7.</p>
<codeclass="descname">THURSDAY</code><emclass="property"> = DayOfWeek(string='THURSDAY')</em><aclass="headerlink"href="#com.vmware.appliance.update_client.Policy.DayOfWeek.THURSDAY"title="Permalink to this definition">¶</a></dt>
<dd><p>Thursday. This class attribute was added in vSphere API 6.7.</p>
<codeclass="descname">TUESDAY</code><emclass="property"> = DayOfWeek(string='TUESDAY')</em><aclass="headerlink"href="#com.vmware.appliance.update_client.Policy.DayOfWeek.TUESDAY"title="Permalink to this definition">¶</a></dt>
<dd><p>Tuesday. This class attribute was added in vSphere API 6.7.</p>
<codeclass="descname">WEDNESDAY</code><emclass="property"> = DayOfWeek(string='WEDNESDAY')</em><aclass="headerlink"href="#com.vmware.appliance.update_client.Policy.DayOfWeek.WEDNESDAY"title="Permalink to this definition">¶</a></dt>
<dd><p>Wednesday. This class attribute was added in vSphere API 6.7.</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>custom_url</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Current appliance update custom repository URL. This attribute was
added in vSphere API 6.7.
If None update is checked at defaut URL.</li>
<li><strong>default_url</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Current appliance update default repository URL. This attribute was
added in vSphere API 6.7.</li>
<li><strong>username</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Username for the update repository. This attribute was added in
vSphere API 6.7.
If None username will not be used to login</li>
<li><strong>check_schedule</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.appliance.update_client.Policy.Time"title="com.vmware.appliance.update_client.Policy.Time"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Policy.Time</span></code></a>) – Schedule when the automatic check will be run. This attribute was
added in vSphere API 6.7.</li>
<li><strong>auto_stage</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Automatically stage the latest update if available. This attribute
was added in vSphere API 6.7.</li>
<li><strong>auto_update</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Is the appliance updated automatically. If <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> the
appliance may ignore the check schedule or auto-stage settings.
This attribute was added in vSphere API 6.7.</li>
<li><strong>manual_control</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Whether API client should allow the user to start update manually.
<emclass="property">class </em><codeclass="descname">Time</code><spanclass="sig-paren">(</span><em>day=None</em>, <em>hour=None</em>, <em>minute=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.update_client.Policy.Time"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>day</strong> (<aclass="reference internal"href="#com.vmware.appliance.update_client.Policy.DayOfWeek"title="com.vmware.appliance.update_client.Policy.DayOfWeek"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Policy.DayOfWeek</span></code></a>) – weekday to check for updates. This attribute was added in vSphere
API 6.7.</li>
<li><strong>hour</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Hour: 0-24. This attribute was added in vSphere API 6.7.</li>
<li><strong>minute</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Minute: 0-59. This attribute was added in vSphere API 6.7.</li>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.update_client.Policy.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Gets the automatic update checking and staging policy. This method was
<codeclass="descname">set</code><spanclass="sig-paren">(</span><em>policy</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.update_client.Policy.set"title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the automatic update checking and staging policy. This method was
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>policy</strong> (<aclass="reference internal"href="#com.vmware.appliance.update_client.Policy.Config"title="com.vmware.appliance.update_client.Policy.Config"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Policy.Config</span></code></a>) – Info structure containing the policy for the appliance update.</td>
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.update_client.</code><codeclass="descname">ServiceInfo</code><spanclass="sig-paren">(</span><em>service=None</em>, <em>description=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.update_client.ServiceInfo"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>service</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Service ID. This attribute was added in vSphere API 6.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">com.vmware.appliance.service</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.appliance.service</span></code>.</li>
<li><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>) – Service description. This attribute was added in vSphere API 6.7.</li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.update_client.</code><codeclass="descname">Staged</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.update_client.Staged"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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.</td>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>staging_complete</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Is staging complete. This attribute was added in vSphere API 6.7.</li>
<li><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Version in form of X.Y.Z.P. e.g. 6.5.1.5400. This attribute was
added in vSphere API 6.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">com.vmware.appliance.update.pending</span></code>. When methods return a
value of this class as a return value, the attribute will be an
<li><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 update. The short information what this update
is. E.g. “Update2 for vCenter Server Appliance 6.5”. This attribute
was added in vSphere API 6.7.</li>
<li><strong>priority</strong> (<aclass="reference internal"href="#com.vmware.appliance.update_client.CommonInfo.Priority"title="com.vmware.appliance.update_client.CommonInfo.Priority"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">CommonInfo.Priority</span></code></a>) – Update priority. This attribute was added in vSphere API 6.7.</li>
<li><strong>severity</strong> (<aclass="reference internal"href="#com.vmware.appliance.update_client.CommonInfo.Severity"title="com.vmware.appliance.update_client.CommonInfo.Severity"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">CommonInfo.Severity</span></code></a>) – Update severity. This attribute was added in vSphere API 6.7.</li>
<li><strong>update_type</strong> (<aclass="reference internal"href="#com.vmware.appliance.update_client.CommonInfo.Category"title="com.vmware.appliance.update_client.CommonInfo.Category"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">CommonInfo.Category</span></code></a>) – Update category. This attribute was added in vSphere API 6.7.</li>
<li><strong>release_date</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Update release date. This attribute was added in vSphere API 6.7.</li>
<li><strong>reboot_required</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag indicating whether reboot is required after update. This
attribute was added in vSphere API 6.7.</li>
<li><strong>size</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Download Size of update in Megabytes. This attribute was added in
<codeclass="descname">delete</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.update_client.Staged.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Deletes the staged update. This method was added in vSphere API 6.7.</p>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.update_client.Staged.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Gets the current status of the staged update. This method was added in
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.update_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.update_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Version in form of X.Y.Z.P. e.g. 6.5.1.5400. This attribute was
added in vSphere API 6.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">com.vmware.appliance.update.pending</span></code>. When methods return a
value of this class as a return value, the attribute will be an
<li><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 update. The short information what this update
is. E.g. “Update2 for vCenter Server Appliance 6.5”. This attribute
was added in vSphere API 6.7.</li>
<li><strong>priority</strong> (<aclass="reference internal"href="#com.vmware.appliance.update_client.CommonInfo.Priority"title="com.vmware.appliance.update_client.CommonInfo.Priority"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">CommonInfo.Priority</span></code></a>) – Update priority. This attribute was added in vSphere API 6.7.</li>
<li><strong>severity</strong> (<aclass="reference internal"href="#com.vmware.appliance.update_client.CommonInfo.Severity"title="com.vmware.appliance.update_client.CommonInfo.Severity"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">CommonInfo.Severity</span></code></a>) – Update severity. This attribute was added in vSphere API 6.7.</li>
<li><strong>update_type</strong> (<aclass="reference internal"href="#com.vmware.appliance.update_client.CommonInfo.Category"title="com.vmware.appliance.update_client.CommonInfo.Category"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">CommonInfo.Category</span></code></a>) – Update category. This attribute was added in vSphere API 6.7.</li>
<li><strong>release_date</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Update release date. This attribute was added in vSphere API 6.7.</li>
<li><strong>reboot_required</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag indicating whether reboot is required after update. This
attribute was added in vSphere API 6.7.</li>
<li><strong>size</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Download Size of update in Megabytes. This attribute was added in
<spanid="com-vmware-appliance-vmon-client-module"></span><h2>com.vmware.appliance.vmon_client module<aclass="headerlink"href="#module-com.vmware.appliance.vmon_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.appliance.vmon_client</span></code> module provides classes to manage a
set of services that are part of the vCenter Server.</p>
<dlclass="class">
<dtid="com.vmware.appliance.vmon_client.Service">
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.vmon_client.</code><codeclass="descname">Service</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.vmon_client.Service"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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.</td>
<emclass="property">class </em><codeclass="descname">Health</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.vmon_client.Service.Health"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Service.Health</span></code> class defines the possible values for health of a
service.</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">This class represents an enumerated type in the interface language
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">DEGRADED</code><emclass="property"> = Health(string='DEGRADED')</em><aclass="headerlink"href="#com.vmware.appliance.vmon_client.Service.Health.DEGRADED"title="Permalink to this definition">¶</a></dt>
<dd><p>Service is in degraded state, it is not functional.</p>
<codeclass="descname">HEALTHY</code><emclass="property"> = Health(string='HEALTHY')</em><aclass="headerlink"href="#com.vmware.appliance.vmon_client.Service.Health.HEALTHY"title="Permalink to this definition">¶</a></dt>
<dd><p>Service is in a healthy state and is fully functional.</p>
<codeclass="descname">HEALTHY_WITH_WARNINGS</code><emclass="property"> = Health(string='HEALTHY_WITH_WARNINGS')</em><aclass="headerlink"href="#com.vmware.appliance.vmon_client.Service.Health.HEALTHY_WITH_WARNINGS"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descname">Info</code><spanclass="sig-paren">(</span><em>name_key=None</em>, <em>description_key=None</em>, <em>startup_type=None</em>, <em>state=None</em>, <em>health=None</em>, <em>health_messages=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.vmon_client.Service.Info"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>name_key</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Service name key. Can be used to lookup resource bundle</li>
<li><strong>description_key</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Service description key. Can be used to lookup resource bundle</li>
<li><strong>health</strong> (<aclass="reference internal"href="#com.vmware.appliance.vmon_client.Service.Health"title="com.vmware.appliance.vmon_client.Service.Health"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Service.Health</span></code></a>) – Health of service.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">state</span></code> is <aclass="reference internal"href="#com.vmware.appliance.vmon_client.Service.State.STARTED"title="com.vmware.appliance.vmon_client.Service.State.STARTED"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Service.State.STARTED</span></code></a>.</li>
<li><strong>health_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>) – Localizable messages associated with the health of the service
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">state</span></code> is <aclass="reference internal"href="#com.vmware.appliance.vmon_client.Service.State.STARTED"title="com.vmware.appliance.vmon_client.Service.State.STARTED"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Service.State.STARTED</span></code></a>.</li>
<emclass="property">class </em><codeclass="descname">StartupType</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.vmon_client.Service.StartupType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Service.StartupType</span></code> class defines valid Startup Type for services
managed by vMon.</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">This class represents an enumerated type in the interface language
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">AUTOMATIC</code><emclass="property"> = StartupType(string='AUTOMATIC')</em><aclass="headerlink"href="#com.vmware.appliance.vmon_client.Service.StartupType.AUTOMATIC"title="Permalink to this definition">¶</a></dt>
<dd><p>Service Startup type is Automatic, thus during starting all services or
issuing explicit start on the service will start it.</p>
<codeclass="descname">DISABLED</code><emclass="property"> = StartupType(string='DISABLED')</em><aclass="headerlink"href="#com.vmware.appliance.vmon_client.Service.StartupType.DISABLED"title="Permalink to this definition">¶</a></dt>
<dd><p>Service Startup type is Disabled, thus it will not start unless the startup
<codeclass="descname">MANUAL</code><emclass="property"> = StartupType(string='MANUAL')</em><aclass="headerlink"href="#com.vmware.appliance.vmon_client.Service.StartupType.MANUAL"title="Permalink to this definition">¶</a></dt>
<dd><p>Service Startup type is Manual, thus issuing an explicit start on the
<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.vmon_client.Service.State"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Service.State</span></code> class defines valid Run State for services.</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">This class represents an enumerated type in the interface language
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.vmon_client.Service.State.STARTED"title="Permalink to this definition">¶</a></dt>
<dd><p>Service Run State is Started, it is fully functional</p>
<codeclass="descname">STARTING</code><emclass="property"> = State(string='STARTING')</em><aclass="headerlink"href="#com.vmware.appliance.vmon_client.Service.State.STARTING"title="Permalink to this definition">¶</a></dt>
<dd><p>Service Run State is Starting, it is still not functional</p>
<codeclass="descname">STOPPED</code><emclass="property"> = State(string='STOPPED')</em><aclass="headerlink"href="#com.vmware.appliance.vmon_client.Service.State.STOPPED"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">STOPPING</code><emclass="property"> = State(string='STOPPING')</em><aclass="headerlink"href="#com.vmware.appliance.vmon_client.Service.State.STOPPING"title="Permalink to this definition">¶</a></dt>
<dd><p>Service Run State is Stopping, it is not functional</p>
<emclass="property">class </em><codeclass="descname">UpdateSpec</code><spanclass="sig-paren">(</span><em>startup_type=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.vmon_client.Service.UpdateSpec"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>service</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.vmon_client.Service.get"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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.
The parameter must be an identifier for the resource type:
<codeclass="descname">list_details</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.vmon_client.Service.list_details"title="Permalink to this definition">¶</a></dt>
<dd><p>Lists details of services managed by vMon.</p>
<codeclass="descname">restart</code><spanclass="sig-paren">(</span><em>service</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.vmon_client.Service.restart"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>service</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – identifier of the service to restart
The parameter must be an identifier for the resource type:
<codeclass="descname">start</code><spanclass="sig-paren">(</span><em>service</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.vmon_client.Service.start"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>service</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – identifier of the service to start
The parameter must be an identifier for the resource type:
<codeclass="descname">stop</code><spanclass="sig-paren">(</span><em>service</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.vmon_client.Service.stop"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>service</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – identifier of the service to stop
The parameter must be an identifier for the resource type:
<codeclass="descname">update</code><spanclass="sig-paren">(</span><em>service</em>, <em>spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.vmon_client.Service.update"title="Permalink to this definition">¶</a></dt>
<li><strong>service</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – identifier of the service whose properties are being updated.
The parameter must be an identifier for the resource type:
if a request to set the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Service.UpdateSpec.startup_type</span></code>
attribute of <codeclass="docutils literal notranslate"><spanclass="pre">spec</span></code> to <aclass="reference internal"href="#com.vmware.appliance.vmon_client.Service.StartupType.DISABLED"title="com.vmware.appliance.vmon_client.Service.StartupType.DISABLED"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Service.StartupType.DISABLED</span></code></a> comes
in for a service that is not in <aclass="reference internal"href="#com.vmware.appliance.vmon_client.Service.State.STOPPED"title="com.vmware.appliance.vmon_client.Service.State.STOPPED"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Service.State.STOPPED</span></code></a>
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.vmon_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.vmon_client.StubFactory"title="Permalink to this definition">¶</a></dt>
Built with <ahref="http://sphinx-doc.org/">Sphinx</a> using a <ahref="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <ahref="https://readthedocs.org">Read the Docs</a>.
