<spanid="com-vmware-appliance-recovery-package"></span><h1>com.vmware.appliance.recovery package<aclass="headerlink"href="#module-com.vmware.appliance.recovery"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-recovery-backup-client-module"></span><h2>com.vmware.appliance.recovery.backup_client module<aclass="headerlink"href="#module-com.vmware.appliance.recovery.backup_client"title="Permalink to this headline">¶</a></h2>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.recovery.backup_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Job</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Job"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Job</span></code> class provides methods to be performed on a backup job.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">BackupJobStatus</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">id</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">state</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">messages</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">progress</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">start_time</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">end_time</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Job.BackupJobStatus"title="Permalink to this definition">¶</a></dt>
<li><p><strong>state</strong> (<aclass="reference internal"href="#com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState"title="com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Job.BackupRestoreProcessState</span></code></a>) – The state of the backup job.</p></li>
<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.appliance.recovery.backup_client.Job.LocalizableMessage"title="com.vmware.appliance.recovery.backup_client.Job.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Job.LocalizableMessage</span></code></a>) – List of messages.</p></li>
<li><p><strong>progress</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Progress of the job in percentage.</p></li>
<li><p><strong>start_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Time when the backup was started.</p></li>
<li><p><strong>end_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Time when the backup was finished.
If None end time is None until backup is finished.</p></li>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Job.BackupRequest</span></code> class represents a requested backup piece.</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>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 optional parts that will be included in the backup. Use the
<aclass="reference internal"href="#com.vmware.appliance.recovery.backup_client.Parts.list"title="com.vmware.appliance.recovery.backup_client.Parts.list"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Parts.list()</span></code></a> method to get information about the supported
parts.</p></li>
<li><p><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>) – 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</p></li>
<li><p><strong>location_type</strong> (<aclass="reference internal"href="#com.vmware.appliance.recovery.backup_client.Job.LocationType"title="com.vmware.appliance.recovery.backup_client.Job.LocationType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Job.LocationType</span></code></a>) – Type of backup location.</p></li>
<li><p><strong>location</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Path or URL of the backup location.</p></li>
<li><p><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 the given location.
If None authentication will not be used for the specified location.</p></li>
<li><p><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 the given location.
If None authentication will not be used for the specified location.</p></li>
<li><p><strong>comment</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Custom comment provided by the user.
If None comment will be empty.</p></li>
<li><p><strong>fast_backup</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Option to enable Postgres DB/ VCDB fast backup Setting this true
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">BackupRestoreProcessState</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Job.BackupRestoreProcessState</span></code> class defines the possible states of
a backup/restore process.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>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
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">BackupRestoreProcessState</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">FAILED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">BackupRestoreProcessState(string='FAILED')</span></em><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState.FAILED"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">INPROGRESS</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">BackupRestoreProcessState(string='INPROGRESS')</span></em><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState.INPROGRESS"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">NONE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">BackupRestoreProcessState(string='NONE')</span></em><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState.NONE"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">SUCCEEDED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">BackupRestoreProcessState(string='SUCCEEDED')</span></em><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState.SUCCEEDED"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">LocalizableMessage</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">id</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">default_message</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">args</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Job.LocalizableMessage"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">LocationType</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Job.LocationType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Job.LocationType</span></code> class defines the type of destination location for
backup/restore. You specify the location type when you create a backup job.
See <aclass="reference internal"href="#com.vmware.appliance.recovery.backup_client.Job.BackupRequest"title="com.vmware.appliance.recovery.backup_client.Job.BackupRequest"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Job.BackupRequest</span></code></a>.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>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
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LocationType</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">FTP</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">LocationType(string='FTP')</span></em><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Job.LocationType.FTP"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">FTPS</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">LocationType(string='FTPS')</span></em><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Job.LocationType.FTPS"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">HTTP</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">LocationType(string='HTTP')</span></em><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Job.LocationType.HTTP"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">HTTPS</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">LocationType(string='HTTPS')</span></em><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Job.LocationType.HTTPS"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">NFS</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">LocationType(string='NFS')</span></em><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Job.LocationType.NFS"title="Permalink to this definition">¶</a></dt>
<dd><p>Destination is NFS server. This class attribute was added in vSphere API
<codeclass="sig-name descname"><spanclass="pre">SCP</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">LocationType(string='SCP')</span></em><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Job.LocationType.SCP"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">SFTP</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">LocationType(string='SFTP')</span></em><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Job.LocationType.SFTP"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">SMB</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">LocationType(string='SMB')</span></em><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Job.LocationType.SMB"title="Permalink to this definition">¶</a></dt>
<dd><p>Destination is SMB server. This class attribute was added in vSphere API
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">ReturnResult</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">status</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">messages</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Job.ReturnResult"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Job.ReturnResult</span></code> class contains the result information for the
cancel operation.</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>status</strong> (<aclass="reference internal"href="#com.vmware.appliance.recovery.backup_client.Job.ReturnStatus"title="com.vmware.appliance.recovery.backup_client.Job.ReturnStatus"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Job.ReturnStatus</span></code></a>) – Status of the cancel operation.</p></li>
<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.appliance.recovery.backup_client.Job.LocalizableMessage"title="com.vmware.appliance.recovery.backup_client.Job.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Job.LocalizableMessage</span></code></a>) – List of messages.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">ReturnStatus</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Job.ReturnStatus"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Job.ReturnStatus</span></code> class defines the return type for the cancel
operation. You specify the return status when you return the result of
cancel job. See <aclass="reference internal"href="#com.vmware.appliance.recovery.backup_client.Job.ReturnResult"title="com.vmware.appliance.recovery.backup_client.Job.ReturnResult"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Job.ReturnResult</span></code></a>.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>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
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ReturnStatus</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">FAIL</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ReturnStatus(string='FAIL')</span></em><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Job.ReturnStatus.FAIL"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">OK</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ReturnStatus(string='OK')</span></em><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Job.ReturnStatus.OK"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">WARNING</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ReturnStatus(string='WARNING')</span></em><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Job.ReturnStatus.WARNING"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">cancel</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">id</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Job.cancel"title="Permalink to this definition">¶</a></dt>
<dd><p>Cancel the backup job.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – ID (ID of job)
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">create</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">piece</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Job.create"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">id</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Job.get"title="Permalink to this definition">¶</a></dt>
<dd><p>See backup job progress/result.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – ID (ID of job)
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Job.list"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.recovery.backup_client.</span></code><codeclass="sig-name descname"><spanclass="pre">LocationSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">location</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">location_user</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">location_password</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.LocationSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">LocationSpec</span></code> class has fields to represent a location on the backup
server. This class was added in vSphere API 6.7.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>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>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 the given location. This attribute was added in
vSphere API 6.7.
If None authentication will not be used.</p></li>
<li><p><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 the given location. This attribute was added in
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.recovery.backup_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Parts</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Parts"title="Permalink to this definition">¶</a></dt>
<p><codeclass="docutils literal notranslate"><spanclass="pre">Parts</span></code> class provides methods Provides list of parts optional for the
backup</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">LocalizableMessage</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">id</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">default_message</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">args</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Parts.LocalizableMessage"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Part</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">id</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">description</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">selected_by_default</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">optional</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Parts.Part"title="Permalink to this definition">¶</a></dt>
<li><p><strong>name</strong> (<aclass="reference internal"href="#com.vmware.appliance.recovery.backup_client.Parts.LocalizableMessage"title="com.vmware.appliance.recovery.backup_client.Parts.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Parts.LocalizableMessage</span></code></a>) – part name id in message bundle</p></li>
<li><p><strong>description</strong> (<aclass="reference internal"href="#com.vmware.appliance.recovery.backup_client.Parts.LocalizableMessage"title="com.vmware.appliance.recovery.backup_client.Parts.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Parts.LocalizableMessage</span></code></a>) – part description id in message bundle</p></li>
<li><p><strong>selected_by_default</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Is this part selected by default in the user interface.</p></li>
<li><p><strong>optional</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Is this part optional.</p></li>
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">id</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Parts.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Gets the size (in MB) of the part.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the part.
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Parts.list"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.recovery.backup_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Schedules</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Schedules"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Schedules</span></code> class provides methods to be performed to manage backup
schedules. 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>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Schedules.CreateSpec</span></code> class contains fields to be specified for
creating a new schedule. The structure includes parts, location
information, encryption password and enable flag. This class was added in
vSphere API 6.7.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>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> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of optional parts to be backed up. Use the <aclass="reference internal"href="#com.vmware.appliance.recovery.backup_client.Parts.list"title="com.vmware.appliance.recovery.backup_client.Parts.list"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Parts.list()</span></code></a>
method to get information about the supported parts. This attribute
was added in vSphere API 6.7.
If None all the optional parts will not be backed up.</p></li>
<li><p><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>) – 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). This attribute
was added in vSphere API 6.7.
If None the backup piece will not be encrypted.</p></li>
<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>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 the given location. This attribute was added in
vSphere API 6.7.
If None authentication will not be used for the specified location.</p></li>
<li><p><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 the given location. This attribute was added in
vSphere API 6.7.
If None authentication will not be used for the specified location.</p></li>
<li><p><strong>enable</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Enable or disable a schedule. This attribute was added in vSphere
API 6.7.
If None the schedule will be enabled.</p></li>
<li><p><strong>recurrence_info</strong> (<aclass="reference internal"href="#com.vmware.appliance.recovery.backup_client.Schedules.RecurrenceInfo"title="com.vmware.appliance.recovery.backup_client.Schedules.RecurrenceInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Schedules.RecurrenceInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Recurrence information for the schedule. This attribute was added
<li><p><strong>retention_info</strong> (<aclass="reference internal"href="#com.vmware.appliance.recovery.backup_client.Schedules.RetentionInfo"title="com.vmware.appliance.recovery.backup_client.Schedules.RetentionInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Schedules.RetentionInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Retention information for the schedule. This attribute was added in
vSphere API 6.7.
If None all the completed backup jobs will be retained forever. See
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">DayOfWeek</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Schedules.DayOfWeek"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Schedules.DayOfWeek</span></code> class defines the set of days when backup can
be scheduled. The days can be specified as a list of individual days. You
specify the days when you set the recurrence for a schedule. See
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Schedules.RecurrenceInfo.days</span></code>. This enumeration was added in
vSphere API 6.7.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>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
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DayOfWeek</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">FRIDAY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">DayOfWeek(string='FRIDAY')</span></em><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Schedules.DayOfWeek.FRIDAY"title="Permalink to this definition">¶</a></dt>
<dd><p>Friday. This class attribute was added in vSphere API 6.7.</p>
<codeclass="sig-name descname"><spanclass="pre">MONDAY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">DayOfWeek(string='MONDAY')</span></em><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Schedules.DayOfWeek.MONDAY"title="Permalink to this definition">¶</a></dt>
<dd><p>Monday. This class attribute was added in vSphere API 6.7.</p>
<codeclass="sig-name descname"><spanclass="pre">SATURDAY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">DayOfWeek(string='SATURDAY')</span></em><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Schedules.DayOfWeek.SATURDAY"title="Permalink to this definition">¶</a></dt>
<dd><p>Saturday. This class attribute was added in vSphere API 6.7.</p>
<codeclass="sig-name descname"><spanclass="pre">SUNDAY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">DayOfWeek(string='SUNDAY')</span></em><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Schedules.DayOfWeek.SUNDAY"title="Permalink to this definition">¶</a></dt>
<dd><p>Sunday. This class attribute was added in vSphere API 6.7.</p>
<codeclass="sig-name descname"><spanclass="pre">THURSDAY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">DayOfWeek(string='THURSDAY')</span></em><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Schedules.DayOfWeek.THURSDAY"title="Permalink to this definition">¶</a></dt>
<dd><p>Thursday. This class attribute was added in vSphere API 6.7.</p>
<codeclass="sig-name descname"><spanclass="pre">TUESDAY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">DayOfWeek(string='TUESDAY')</span></em><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Schedules.DayOfWeek.TUESDAY"title="Permalink to this definition">¶</a></dt>
<dd><p>Tuesday. This class attribute was added in vSphere API 6.7.</p>
<codeclass="sig-name descname"><spanclass="pre">WEDNESDAY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">DayOfWeek(string='WEDNESDAY')</span></em><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Schedules.DayOfWeek.WEDNESDAY"title="Permalink to this definition">¶</a></dt>
<dd><p>Wednesday. This class attribute was added in vSphere API 6.7.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Info</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">parts</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">location</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">location_user</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">enable</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">recurrence_info</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">retention_info</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Schedules.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Schedules.Info</span></code> class contains information about an existing
schedule. The structure includes Schedule ID, parts, location information,
encryption password, enable flag, recurrence and retention information.
This class was added in vSphere API 6.7.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>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 optional parts that will be included in backups based on
this schedule details. Use the <aclass="reference internal"href="#com.vmware.appliance.recovery.backup_client.Parts.list"title="com.vmware.appliance.recovery.backup_client.Parts.list"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Parts.list()</span></code></a> method to get
information about the supported parts. 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>) – URL of the backup location. This attribute was added in vSphere API
6.7.</p></li>
<li><p><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 the given location. This attribute was added in
vSphere API 6.7.
If None location user will not be used.</p></li>
<li><p><strong>enable</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Enable or disable a schedule, by default when created a schedule
will be enabled. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>recurrence_info</strong> (<aclass="reference internal"href="#com.vmware.appliance.recovery.backup_client.Schedules.RecurrenceInfo"title="com.vmware.appliance.recovery.backup_client.Schedules.RecurrenceInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Schedules.RecurrenceInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Recurrence information for the schedule. This attribute was added
<li><p><strong>retention_info</strong> (<aclass="reference internal"href="#com.vmware.appliance.recovery.backup_client.Schedules.RetentionInfo"title="com.vmware.appliance.recovery.backup_client.Schedules.RetentionInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Schedules.RetentionInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Retention information for the schedule. This attribute was added in
vSphere API 6.7.
If None all the completed backup jobs are retained forever. See
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">RecurrenceInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">minute</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">hour</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">days</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Schedules.RecurrenceInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Schedules.RecurrenceInfo</span></code> class contains the recurrence information
associated with a schedule. This class was added in vSphere API 6.7.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>minute</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Minute when backup should run. This attribute was added in vSphere
API 6.7.</p></li>
<li><p><strong>hour</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Hour when backup should run. The hour should be specified in
24-hour clock format. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>days</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.appliance.recovery.backup_client.Schedules.DayOfWeek"title="com.vmware.appliance.recovery.backup_client.Schedules.DayOfWeek"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Schedules.DayOfWeek</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Day of week when the backup should be run. Days can be specified as
list of days. This attribute was added in vSphere API 6.7.
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">RetentionInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">max_count</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Schedules.RetentionInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Schedules.RetentionInfo</span></code> class contains retention information
associated with a schedule. This class was added in vSphere API 6.7.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>max_count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Number of backups which should be retained. If retention is not
set, all the backups will be retained forever. This attribute was
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Schedules.UpdateSpec</span></code> class contains the fields of the existing
schedule which can be updated. This class was added in vSphere API 6.7.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>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> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of optional parts. Use the <aclass="reference internal"href="#com.vmware.appliance.recovery.backup_client.Parts.list"title="com.vmware.appliance.recovery.backup_client.Parts.list"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Parts.list()</span></code></a> method to get
information about the supported parts. This attribute was added in
vSphere API 6.7.
If None the value will not be changed.</p></li>
<li><p><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>) – 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). This attribute
was added in vSphere API 6.7.
If None the value will not be changed.</p></li>
<li><p><strong>location</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – URL of the backup location. This attribute was added in vSphere API
6.7.
If None the value will not be changed.</p></li>
<li><p><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 the given location. This attribute was added in
vSphere API 6.7.
If None the value will not be changed.</p></li>
<li><p><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 the given location. This attribute was added in
vSphere API 6.7.
If None the value will not be changed.</p></li>
<li><p><strong>enable</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Enable or disable a schedule. This attribute was added in vSphere
API 6.7.
If None the value will not be changed.</p></li>
<li><p><strong>recurrence_info</strong> (<aclass="reference internal"href="#com.vmware.appliance.recovery.backup_client.Schedules.RecurrenceInfo"title="com.vmware.appliance.recovery.backup_client.Schedules.RecurrenceInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Schedules.RecurrenceInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Recurrence information for the schedule. This attribute was added
<li><p><strong>retention_info</strong> (<aclass="reference internal"href="#com.vmware.appliance.recovery.backup_client.Schedules.RetentionInfo"title="com.vmware.appliance.recovery.backup_client.Schedules.RetentionInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Schedules.RetentionInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Retention information for the schedule. This attribute was added in
<codeclass="sig-name descname"><spanclass="pre">create</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">schedule</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Schedules.create"title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a schedule. This method was added in vSphere API 6.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>schedule</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the schedule
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">delete</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">schedule</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Schedules.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Deletes an existing schedule. This method was added in vSphere API 6.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>schedule</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the schedule
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">schedule</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Schedules.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns an existing schedule information based on id. This method was
added in vSphere API 6.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>schedule</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the schedule
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Schedules.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a list of existing schedules with details. This method was
<codeclass="sig-name descname"><spanclass="pre">run</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">schedule</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">comment</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Schedules.run"title="Permalink to this definition">¶</a></dt>
<dd><p>Initiate backup with the specified schedule. This method was added in
vSphere API 6.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>schedule</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the schedule
The parameter must be an identifier for the resource type:
<li><p><strong>comment</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – field that specifies the description for the backup.
If None the backup will have an empty comment.</p></li>
<codeclass="sig-name descname"><spanclass="pre">update</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">schedule</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.Schedules.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Updates a schedule. This method was added in vSphere API 6.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>schedule</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the schedule
The parameter must be an identifier for the resource type:
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.recovery.backup_client.</span></code><codeclass="sig-name descname"><spanclass="pre">StubFactory</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">stub_config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.recovery.backup_client.</span></code><codeclass="sig-name descname"><spanclass="pre">SystemName</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.SystemName"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">SystemName</span></code> class provides methods to enumerate system names of
appliance backups. This class was added in vSphere API 6.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">loc_spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.backup_client.SystemName.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a list of system names for which backup archives exist under
<codeclass="docutils literal notranslate"><spanclass="pre">loc_spec</span></code>. This method was added in vSphere API 6.7.</p>
<spanid="com-vmware-appliance-recovery-reconciliation-client-module"></span><h2>com.vmware.appliance.recovery.reconciliation_client module<aclass="headerlink"href="#module-com.vmware.appliance.recovery.reconciliation_client"title="Permalink to this headline">¶</a></h2>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.recovery.reconciliation_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Job</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.reconciliation_client.Job"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Job</span></code> class provides methods to create and get the status of
reconciliation job. 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"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">CreateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">sso_admin_user_name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">sso_admin_user_password</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">ignore_warnings</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.reconciliation_client.Job.CreateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Job.CreateSpec</span></code> class has the fields to request the start of
reconciliation job. This class was added in vSphere API 6.7.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>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.</p></li>
<li><p><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>) – 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
required.</p></li>
<li><p><strong>ignore_warnings</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating whether warnings should be ignored during
reconciliation. This attribute was added in vSphere API 6.7.
If None, validation warnings will fail the reconciliation
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Job.Info</span></code> class represents the reconciliation job information. It
contains information related to current Status, any associated messages and
progress as percentage. This class was added in vSphere API 6.7.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>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. This
attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>service</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the service containing the operation. 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.reconciliation.job</span></code>. When methods
return a value of this class as a return value, the attribute will
<li><p><strong>operation</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the operation associated with the task. This attribute was
added in vSphere API 6.7.</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 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.reconciliation.job</span></code>. When methods
return a value of this class as a return value, the attribute will
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 resource the operation modifies. This
attribute was added in vSphere API 6.7.
This attribute will be None if the task has multiple targets or no
target.</p></li>
<li><p><strong>status</strong> (<aclass="reference internal"href="#com.vmware.appliance.recovery.reconciliation_client.Job.Status"title="com.vmware.appliance.recovery.reconciliation_client.Job.Status"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Job.Status</span></code></a>) – Status of the operation associated with the task. This attribute
was added in vSphere API 6.7.</p></li>
<li><p><strong>cancelable</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 to indicate whether or not the operation can be cancelled. The
value may change as the operation progresses. This attribute was
added in vSphere API 6.7.
If None, the operation cannot be canceled.</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”. This
attribute was added in vSphere API 6.7.
If None the description of why the operation failed will be
included in the result of the operation (see Info#result).</p></li>
<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. 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 <aclass="reference internal"href="#com.vmware.appliance.recovery.reconciliation_client.Job.Status.RUNNING"title="com.vmware.appliance.recovery.reconciliation_client.Job.Status.RUNNING"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Job.Status.RUNNING</span></code></a>,
<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. 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 <aclass="reference internal"href="#com.vmware.appliance.recovery.reconciliation_client.Job.Status.SUCCEEDED"title="com.vmware.appliance.recovery.reconciliation_client.Job.Status.SUCCEEDED"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Job.Status.SUCCEEDED</span></code></a> or
<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>) – A list of localized messages. This attribute was added in vSphere
API 6.7.</p></li>
<li><p><strong>progress</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – The progress of the job as a percentage. This attribute was added
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Status</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.reconciliation_client.Job.Status"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Job.Status</span></code> class defines the status values that can be reported for
an operation. This enumeration was added in vSphere API 6.7.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>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
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Status</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">FAILED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Status(string='FAILED')</span></em><aclass="headerlink"href="#com.vmware.appliance.recovery.reconciliation_client.Job.Status.FAILED"title="Permalink to this definition">¶</a></dt>
<dd><p>The operation failed. This class attribute was added in vSphere API 6.7.</p>
<codeclass="sig-name descname"><spanclass="pre">NONE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Status(string='NONE')</span></em><aclass="headerlink"href="#com.vmware.appliance.recovery.reconciliation_client.Job.Status.NONE"title="Permalink to this definition">¶</a></dt>
<dd><p>The operation is not running. This class attribute was added in vSphere API
<codeclass="sig-name descname"><spanclass="pre">RUNNING</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Status(string='RUNNING')</span></em><aclass="headerlink"href="#com.vmware.appliance.recovery.reconciliation_client.Job.Status.RUNNING"title="Permalink to this definition">¶</a></dt>
<dd><p>The operation is in progress. This class attribute was added in vSphere API
<codeclass="sig-name descname"><spanclass="pre">SUCCEEDED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Status(string='SUCCEEDED')</span></em><aclass="headerlink"href="#com.vmware.appliance.recovery.reconciliation_client.Job.Status.SUCCEEDED"title="Permalink to this definition">¶</a></dt>
<dd><p>The operation completed successfully. This class attribute was added in
<codeclass="sig-name descname"><spanclass="pre">create</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.reconciliation_client.Job.create"title="Permalink to this definition">¶</a></dt>
<dd><p>Initiate reconciliation. This method was added in vSphere API 6.7.</p>
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.reconciliation_client.Job.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Get reconciliation job progress/result. This method was added in
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.recovery.reconciliation_client.</span></code><codeclass="sig-name descname"><spanclass="pre">StubFactory</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">stub_config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.reconciliation_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-appliance-recovery-restore-client-module"></span><h2>com.vmware.appliance.recovery.restore_client module<aclass="headerlink"href="#module-com.vmware.appliance.recovery.restore_client"title="Permalink to this headline">¶</a></h2>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.recovery.restore_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Job</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.restore_client.Job"title="Permalink to this definition">¶</a></dt>
<p><codeclass="docutils literal notranslate"><spanclass="pre">Job</span></code> class provides methods Performs restore operations</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">BackupRestoreProcessState</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.restore_client.Job.BackupRestoreProcessState"title="Permalink to this definition">¶</a></dt>
<p><codeclass="docutils literal notranslate"><spanclass="pre">Job.BackupRestoreProcessState</span></code> class Defines state of backup/restore
process</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>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
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">BackupRestoreProcessState</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">FAILED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">BackupRestoreProcessState(string='FAILED')</span></em><aclass="headerlink"href="#com.vmware.appliance.recovery.restore_client.Job.BackupRestoreProcessState.FAILED"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">INPROGRESS</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">BackupRestoreProcessState(string='INPROGRESS')</span></em><aclass="headerlink"href="#com.vmware.appliance.recovery.restore_client.Job.BackupRestoreProcessState.INPROGRESS"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">NONE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">BackupRestoreProcessState(string='NONE')</span></em><aclass="headerlink"href="#com.vmware.appliance.recovery.restore_client.Job.BackupRestoreProcessState.NONE"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">SUCCEEDED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">BackupRestoreProcessState(string='SUCCEEDED')</span></em><aclass="headerlink"href="#com.vmware.appliance.recovery.restore_client.Job.BackupRestoreProcessState.SUCCEEDED"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">LocalizableMessage</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">id</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">default_message</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">args</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.restore_client.Job.LocalizableMessage"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">LocationType</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.restore_client.Job.LocationType"title="Permalink to this definition">¶</a></dt>
<p><codeclass="docutils literal notranslate"><spanclass="pre">Job.LocationType</span></code> class Defines type of all locations for backup/restore</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>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
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LocationType</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">FTP</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">LocationType(string='FTP')</span></em><aclass="headerlink"href="#com.vmware.appliance.recovery.restore_client.Job.LocationType.FTP"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">FTPS</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">LocationType(string='FTPS')</span></em><aclass="headerlink"href="#com.vmware.appliance.recovery.restore_client.Job.LocationType.FTPS"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">HTTP</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">LocationType(string='HTTP')</span></em><aclass="headerlink"href="#com.vmware.appliance.recovery.restore_client.Job.LocationType.HTTP"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">HTTPS</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">LocationType(string='HTTPS')</span></em><aclass="headerlink"href="#com.vmware.appliance.recovery.restore_client.Job.LocationType.HTTPS"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">NFS</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">LocationType(string='NFS')</span></em><aclass="headerlink"href="#com.vmware.appliance.recovery.restore_client.Job.LocationType.NFS"title="Permalink to this definition">¶</a></dt>
<dd><p>Destination is NFS server. This class attribute was added in vSphere API
<codeclass="sig-name descname"><spanclass="pre">SCP</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">LocationType(string='SCP')</span></em><aclass="headerlink"href="#com.vmware.appliance.recovery.restore_client.Job.LocationType.SCP"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">SFTP</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">LocationType(string='SFTP')</span></em><aclass="headerlink"href="#com.vmware.appliance.recovery.restore_client.Job.LocationType.SFTP"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">SMB</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">LocationType(string='SMB')</span></em><aclass="headerlink"href="#com.vmware.appliance.recovery.restore_client.Job.LocationType.SMB"title="Permalink to this definition">¶</a></dt>
<dd><p>Destination is SMB server. This class attribute was added in vSphere API
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">RestoreJobStatus</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">state</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">messages</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">progress</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.restore_client.Job.RestoreJobStatus"title="Permalink to this definition">¶</a></dt>
<p><codeclass="docutils literal notranslate"><spanclass="pre">Job.RestoreRequest</span></code> class Structure representing requested restore piece</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>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</p></li>
<li><p><strong>location_type</strong> (<aclass="reference internal"href="#com.vmware.appliance.recovery.restore_client.Job.LocationType"title="com.vmware.appliance.recovery.restore_client.Job.LocationType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Job.LocationType</span></code></a>) – a type of location</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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
required.</p></li>
<li><p><strong>ignore_warnings</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The flag to ignore warnings during restore. This attribute was
added in vSphere API 6.7.
If None, validation warnings will fail the restore operation</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">ReturnResult</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">status</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">messages</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.restore_client.Job.ReturnResult"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">ReturnStatus</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.restore_client.Job.ReturnStatus"title="Permalink to this definition">¶</a></dt>
<p><codeclass="docutils literal notranslate"><spanclass="pre">Job.ReturnStatus</span></code> class Defines the state of precheck</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>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
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ReturnStatus</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">FAIL</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ReturnStatus(string='FAIL')</span></em><aclass="headerlink"href="#com.vmware.appliance.recovery.restore_client.Job.ReturnStatus.FAIL"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">OK</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ReturnStatus(string='OK')</span></em><aclass="headerlink"href="#com.vmware.appliance.recovery.restore_client.Job.ReturnStatus.OK"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">WARNING</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ReturnStatus(string='WARNING')</span></em><aclass="headerlink"href="#com.vmware.appliance.recovery.restore_client.Job.ReturnStatus.WARNING"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">cancel</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.restore_client.Job.cancel"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">create</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">piece</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.restore_client.Job.create"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.restore_client.Job.get"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.recovery.restore_client.</span></code><codeclass="sig-name descname"><spanclass="pre">StubFactory</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">stub_config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.appliance.recovery.restore_client.StubFactory"title="Permalink to this definition">¶</a></dt>
