<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="descclassname">com.vmware.appliance.recovery.backup.job_client.</code><codeclass="descname">Details</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.backup.job_client.Details"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">FilterSpec</code><spanclass="sig-paren">(</span><em>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
class was added in vSphere API 6.7</p>
<divclass="admonition tip">
<pclass="first admonition-title">Tip</p>
<pclass="last">The arguments are used to initialize data attributes with the same
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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
attribute was added in vSphere API 6.7
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.appliance.recovery.backup.job</span></code>. When methods return a
value of this class as a return value, the attribute will contain
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><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</li>
<li><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
took to complete the backup job. This attribute was added in
vSphere API 6.7
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">#status</span></code> is one of
<li><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
attribute was added in vSphere API 6.7
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">#status</span></code> is one of
<li><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
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">#status</span></code> is one of
<li><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</li>
<li><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
manually or as a scheduled backup. This attribute was added in
vSphere API 6.7</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.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</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 operation associated with the task.</li>
<li><strong>service</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the service containing the operation.
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.vapi.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.vapi.service</span></code>.</li>
<li><strong>operation</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the operation associated with the task.
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.vapi.operation</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.vapi.operation</span></code>.</li>
<li><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.
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.cis.task</span></code>. When methods return a value of this class
as a return value, the attribute will be an identifier for the
This attribute will be None if the task has no parent.</li>
<li><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
one the operation performed on.
This attribute will be None if the operation has no target or
multiple targets.</li>
<li><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.</li>
<li><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.</li>
<li><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”.
If None the description of why the operation failed will be
<li><strong>start_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Time when the operation is started.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">status</span></code> is one of
<li><strong>end_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Time when the operation is completed.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">status</span></code> is one of
<aclass="reference internal"href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED"title="com.vmware.cis.task_client.Status.SUCCEEDED"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a> or
<li><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.
This attribute will be None if the operation is performed by the
<emclass="property">class </em><codeclass="descname">Type</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.backup.job_client.Details.Type"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Details.Type</span></code> class defines the type of backup job. 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">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>
<dd><p>Job type is Manual. This class attribute was added in vSphere API 6.7</p>
<codeclass="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>
<dd><p>Job type is Scheduled. This class attribute was added in vSphere API 6.7</p>
<codeclass="descname">list</code><spanclass="sig-paren">(</span><em>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>
<dd><p>Returns detailed information about the current and historical backup
jobs. This method was added in vSphere API 6.7</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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
be returned.
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="descclassname">com.vmware.appliance.recovery.backup.job_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.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="descclassname">com.vmware.appliance.recovery.backup.system_name_client.</code><codeclass="descname">Archive</code><spanclass="sig-paren">(</span><em>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>
<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">FilterSpec</code><spanclass="sig-paren">(</span><em>start_timestamp=None</em>, <em>end_timestamp=None</em>, <em>comment_substring=None</em>, <em>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
attributes match the filter. This class was added in vSphere API 6.7</p>
<divclass="admonition tip">
<pclass="first admonition-title">Tip</p>
<pclass="last">The arguments are used to initialize data attributes with the same
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><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.</li>
<li><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.</li>
<li><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.</li>
<li><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
<emclass="property">class </em><codeclass="descname">Info</code><spanclass="sig-paren">(</span><em>timestamp=None</em>, <em>location=None</em>, <em>parts=None</em>, <em>version=None</em>, <em>system_name=None</em>, <em>comment=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.backup.system_name_client.Archive.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>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</li>
<li><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</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. 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>) – The version of the appliance represented by the backup. This
attribute was added in vSphere API 6.7</li>
<li><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
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.recovery.backup.system_name</span></code>. When methods
return a value of this class as a return value, the attribute will
<li><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="descname">Summary</code><spanclass="sig-paren">(</span><em>archive=None</em>, <em>timestamp=None</em>, <em>version=None</em>, <em>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>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><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
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.recovery.backup.system_name.archive</span></code>. When
methods return a value of this class as a return value, the
attribute will be an identifier for the resource type:
<li><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</li>
<li><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</li>
<li><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="descname">get</code><spanclass="sig-paren">(</span><em>spec</em>, <em>system_name</em>, <em>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>
<dd><p>Returns the information for backup corresponding to given backup
location and system name. This method was added in vSphere API 6.7</p>
<codeclass="descname">list</code><spanclass="sig-paren">(</span><em>loc_spec</em>, <em>system_name</em>, <em>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><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
<trclass="field-odd field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first">Commonly used information about the backup archives.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.appliance.recovery.backup.system_name_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.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>.
