<spanid="com-vmware-appliance-recovery-backup-package"></span><h1>com.vmware.appliance.recovery.backup package<aclass="headerlink"href="#module-com.vmware.appliance.recovery.backup"title="Permalink to this headline">¶</a></h1>
<divclass="section"id="submodules">
<h2>Submodules<aclass="headerlink"href="#submodules"title="Permalink to this headline">¶</a></h2>
<spanid="com-vmware-appliance-recovery-backup-job-client-module"></span><h2>com.vmware.appliance.recovery.backup.job_client module<aclass="headerlink"href="#module-com.vmware.appliance.recovery.backup.job_client"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.appliance.recovery.backup.job_client.</code><codeclass="sig-name descname">Details</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.backup.job_client.Details"title="Permalink to this definition">¶</a></dt>
jobs. This class was added in vSphere API 6.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property">class </em><codeclass="sig-name descname">BuildInfo</code><spanclass="sig-paren">(</span><emclass="sig-param">version_name=None</em>, <emclass="sig-param">version=None</em>, <emclass="sig-param">build_number=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.backup.job_client.Details.BuildInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Details.BuildInfo</span></code> class contains information about the build of the
appliance. This class was added in vSphere API 6.7.2.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>version_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Appliance product type, for example 6.8.2 GA. This attribute was
added in vSphere API 6.7.2.</p></li>
<li><p><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Appliance version, for example 6.8.2.10000. This attribute was
added in vSphere API 6.7.2.</p></li>
<li><p><strong>build_number</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Build Number of the appliance. This attribute was added in vSphere
<emclass="property">class </em><codeclass="sig-name descname">FilterSpec</code><spanclass="sig-paren">(</span><emclass="sig-param">jobs=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.backup.job_client.Details.FilterSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Details.FilterSpec</span></code> class contains attributes used to filter the
results when listing backup jobs details (see <aclass="reference internal"href="#com.vmware.appliance.recovery.backup.job_client.Details.list"title="com.vmware.appliance.recovery.backup.job_client.Details.list"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Details.list()</span></code></a>). This
<ddclass="field-odd"><p><strong>jobs</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifiers of backup jobs that can match the filter. This
<li><p><strong>location</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – URL of the backup location. This attribute was added in vSphere API
6.7.</p></li>
<li><p><strong>duration</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Time in seconds since the backup job was started or the time it
<li><p><strong>size</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Size of the backup data transferred to remote location. This
<li><p><strong>progress</strong> (<aclass="reference internal"href="com.vmware.cis.html#com.vmware.cis.task_client.Progress"title="com.vmware.cis.task_client.Progress"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.cis.task_client.Progress</span></code></a>) – Progress of the job. This attribute was added in vSphere API 6.7.
<li><p><strong>location_user</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The username for the remote backup location. This attribute was
added in vSphere API 6.7.</p></li>
<li><p><strong>type</strong> (<aclass="reference internal"href="#com.vmware.appliance.recovery.backup.job_client.Details.Type"title="com.vmware.appliance.recovery.backup.job_client.Details.Type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Details.Type</span></code></a>) – Type of the backup job. Indicates whether the backup was started
<li><p><strong>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>) – List of any info/warning/error messages returned by the backup job.
This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>build</strong> (<aclass="reference internal"href="#com.vmware.appliance.recovery.backup.job_client.Details.BuildInfo"title="com.vmware.appliance.recovery.backup.job_client.Details.BuildInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Details.BuildInfo</span></code></a>) – Information about the build of the appliance. This attribute was
added in vSphere API 6.7.2.
This attribute is optional because it was added in a newer version
than its parent node.</p></li>
<li><p><strong>description</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Description of the operation associated with the task.</p></li>
<li><p><strong>service</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the service containing the operation.
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.service</span></code>.</p></li>
<li><p><strong>operation</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the operation associated with the task.
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.operation</span></code>.</p></li>
<li><p><strong>parent</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Parent of the current task.
This attribute will be None if the task has no parent.</p></li>
<li><p><strong>target</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID"title="com.vmware.vapi.std_client.DynamicID"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifier of the target created by the operation or an existing
<li><p><strong>status</strong> (<aclass="reference internal"href="com.vmware.cis.html#com.vmware.cis.task_client.Status"title="com.vmware.cis.task_client.Status"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.cis.task_client.Status</span></code></a>) – Status of the operation associated with the task.</p></li>
<li><p><strong>cancelable</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag to indicate whether or not the operation can be cancelled. The
value may change as the operation progresses.</p></li>
<li><p><strong>error</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Exception</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Description of the error if the operation status is “FAILED”.
<li><p><strong>start_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Time when the operation is started.
<li><p><strong>end_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Time when the operation is completed.
<li><p><strong>user</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name of the user who performed the operation.
<emclass="property">class </em><codeclass="sig-name descname">Type</code><spanclass="sig-paren">(</span><emclass="sig-param">string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.backup.job_client.Details.Type"title="Permalink to this definition">¶</a></dt>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="sig-name descname">MANUAL</code><emclass="property"> = Type(string='MANUAL')</em><aclass="headerlink"href="#com.vmware.appliance.recovery.backup.job_client.Details.Type.MANUAL"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">SCHEDULED</code><emclass="property"> = Type(string='SCHEDULED')</em><aclass="headerlink"href="#com.vmware.appliance.recovery.backup.job_client.Details.Type.SCHEDULED"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">list</code><spanclass="sig-paren">(</span><emclass="sig-param">filter=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.backup.job_client.Details.list"title="Permalink to this definition">¶</a></dt>
jobs. This method was added in vSphere API 6.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>filter</strong> (<aclass="reference internal"href="#com.vmware.appliance.recovery.backup.job_client.Details.FilterSpec"title="com.vmware.appliance.recovery.backup.job_client.Details.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Details.FilterSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specification of matching backup jobs for which information should
If None, the behavior is equivalent to <aclass="reference internal"href="#com.vmware.appliance.recovery.backup.job_client.Details.FilterSpec"title="com.vmware.appliance.recovery.backup.job_client.Details.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Details.FilterSpec</span></code></a>
with all attributes None which means all the backup jobs match the
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.appliance.recovery.backup.job_client.</code><codeclass="sig-name descname">StubFactory</code><spanclass="sig-paren">(</span><emclass="sig-param">stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.backup.job_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-appliance-recovery-backup-system-name-client-module"></span><h2>com.vmware.appliance.recovery.backup.system_name_client module<aclass="headerlink"href="#module-com.vmware.appliance.recovery.backup.system_name_client"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.appliance.recovery.backup.system_name_client.</code><codeclass="sig-name descname">Archive</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.backup.system_name_client.Archive"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property">class </em><codeclass="sig-name descname">FilterSpec</code><spanclass="sig-paren">(</span><emclass="sig-param">start_timestamp=None</em>, <emclass="sig-param">end_timestamp=None</em>, <emclass="sig-param">comment_substring=None</em>, <emclass="sig-param">max_results=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.backup.system_name_client.Archive.FilterSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Archive.FilterSpec</span></code> class contains attributes used to filter the
results when listing backup archives (see <aclass="reference internal"href="#com.vmware.appliance.recovery.backup.system_name_client.Archive.list"title="com.vmware.appliance.recovery.backup.system_name_client.Archive.list"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Archive.list()</span></code></a>). If
multiple attributes are specified, only backup archives matching all of the
<li><p><strong>start_timestamp</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Backup must have been taken on or after this time to match the
filter. This attribute was added in vSphere API 6.7.
If None the filter will match oldest backups.</p></li>
<li><p><strong>end_timestamp</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Backup must have been taken on or before this time to match the
filter. This attribute was added in vSphere API 6.7.
If None the filter will match most recent backups.</p></li>
<li><p><strong>comment_substring</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Backup comment must contain this <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> to match the filter.
This attribute was added in vSphere API 6.7.
If None the filter will match backups with any comment.</p></li>
<li><p><strong>max_results</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Limit result to a max count of most recent backups. This attribute
<li><p><strong>timestamp</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Time when this backup was completed. This attribute was added in
vSphere API 6.7.</p></li>
<li><p><strong>location</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Backup location URL. This attribute was added in vSphere API 6.7.</p></li>
<li><p><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. This attribute was added in
vSphere API 6.7.</p></li>
<li><p><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The version of the appliance represented by the backup. This
attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>system_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The system name identifier of the appliance represented by the
backup. This attribute was added in vSphere API 6.7.
<li><p><strong>comment</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Custom comment added by the user for this backup. This attribute
<emclass="property">class </em><codeclass="sig-name descname">Summary</code><spanclass="sig-paren">(</span><emclass="sig-param">archive=None</em>, <emclass="sig-param">timestamp=None</em>, <emclass="sig-param">version=None</em>, <emclass="sig-param">comment=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.backup.system_name_client.Archive.Summary"title="Permalink to this definition">¶</a></dt>
<li><p><strong>archive</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Backup archive identifier. This attribute was added in vSphere API
<li><p><strong>timestamp</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Time when this backup was started. This attribute was added in
vSphere API 6.7.</p></li>
<li><p><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The version of the appliance represented by the backup archive.
This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>comment</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Custom comment added by the user for this backup. This attribute
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">spec</em>, <emclass="sig-param">system_name</em>, <emclass="sig-param">archive</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.backup.system_name_client.Archive.get"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">list</code><spanclass="sig-paren">(</span><emclass="sig-param">loc_spec</em>, <emclass="sig-param">system_name</em>, <emclass="sig-param">filter_spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.backup.system_name_client.Archive.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about backup archives corresponding to given backup
location and system name, which match the <aclass="reference internal"href="#com.vmware.appliance.recovery.backup.system_name_client.Archive.FilterSpec"title="com.vmware.appliance.recovery.backup.system_name_client.Archive.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Archive.FilterSpec</span></code></a>.
<li><p><strong>filter_spec</strong> (<aclass="reference internal"href="#com.vmware.appliance.recovery.backup.system_name_client.Archive.FilterSpec"title="com.vmware.appliance.recovery.backup.system_name_client.Archive.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Archive.FilterSpec</span></code></a>) – Specification of matching backups for which information should be
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.appliance.recovery.backup.system_name_client.</code><codeclass="sig-name descname">StubFactory</code><spanclass="sig-paren">(</span><emclass="sig-param">stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.backup.system_name_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>.
