Mirrors/vsphere-automation-sdk-python
1
0
Fork 0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-22 17:39:59 -05:00
Code
8e216b20a8
vsphere-automation-sdk-python/vsphere/6.5/com.vmware.appliance.recovery.html

971 lines
76 KiB
HTML
Raw Normal View History

add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>recovery Package &mdash; vSphere Automation SDK for Python 6.5.0 documentation</title>
<link rel="stylesheet" href="_static/vapitheme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '6.5.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="vSphere Automation SDK for Python 6.5.0 documentation" href="index.html" />
<link rel="up" title="appliance Package" href="com.vmware.appliance.html" />
<link rel="next" title="techpreview Package" href="com.vmware.appliance.techpreview.html" />
<link rel="prev" title="networking Package" href="com.vmware.appliance.networking.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="com.vmware.appliance.techpreview.html" title="techpreview Package"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="com.vmware.appliance.networking.html" title="networking Package"
accesskey="P">previous</a> |</li>
<li><a href="index.html">vSphere Automation SDK for Python 6.5.0 documentation</a> &raquo;</li>
<li><a href="com.html" >com Package</a> &raquo;</li>
<li><a href="com.vmware.html" >vmware Package</a> &raquo;</li>
<li><a href="com.vmware.appliance.html" accesskey="U">appliance Package</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="recovery-package">
<h1>recovery Package<a class="headerlink" href="#recovery-package" title="Permalink to this headline"></a></h1>
<div class="section" id="id1">
<h2><tt class="xref py py-mod docutils literal"><span class="pre">recovery</span></tt> Package<a class="headerlink" href="#id1" title="Permalink to this headline"></a></h2>
<span class="target" id="module-com.vmware.appliance.recovery"></span></div>
<div class="section" id="module-com.vmware.appliance.recovery.backup_client">
<span id="backup-client-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">backup_client</span></tt> Module<a class="headerlink" href="#module-com.vmware.appliance.recovery.backup_client" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="com.vmware.appliance.recovery.backup_client.Job">
<em class="property">class </em><tt class="descclassname">com.vmware.appliance.recovery.backup_client.</tt><tt class="descname">Job</tt><big>(</big><em>config</em><big>)</big><a class="reference internal" href="_modules/com/vmware/appliance/recovery/backup_client.html#Job"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.stub.VapiInterface" title="vmware.vapi.bindings.stub.VapiInterface"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></a></p>
<p><tt class="docutils literal"><span class="pre">Job</span></tt> class provides methods Performs backup restore operations</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.stub.StubConfiguration" title="vmware.vapi.bindings.stub.StubConfiguration"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt></a>) &#8211; Configuration to be used for creating the stub.</td>
</tr>
</tbody>
</table>
<dl class="class">
<dt id="com.vmware.appliance.recovery.backup_client.Job.BackupJobStatus">
<em class="property">class </em><tt class="descname">BackupJobStatus</tt><big>(</big><em>id=None</em>, <em>state=None</em>, <em>messages=None</em>, <em>progress=None</em>, <em>start_time=None</em>, <em>end_time=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/appliance/recovery/backup_client.html#Job.BackupJobStatus"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.BackupJobStatus" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
<p><tt class="docutils literal"><span class="pre">Job.BackupJobStatus</span></tt> class Structure representing backup restore status</p>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) &#8211; TimeStamp based ID</li>
<li><strong>state</strong> (<a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState" title="com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState"><tt class="xref py py-class docutils literal"><span class="pre">Job.BackupRestoreProcessState</span></tt></a>) &#8211; process state</li>
<li><strong>messages</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.Job.LocalizableMessage" title="com.vmware.appliance.recovery.backup_client.Job.LocalizableMessage"><tt class="xref py py-class docutils literal"><span class="pre">Job.LocalizableMessage</span></tt></a>) &#8211; list of messages</li>
<li><strong>progress</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) &#8211; percentage complete</li>
<li><strong>start_time</strong> (<tt class="xref py py-class docutils literal"><span class="pre">datetime.datetime</span></tt>) &#8211; Time when this backup was started.</li>
<li><strong>end_time</strong> (<tt class="xref py py-class docutils literal"><span class="pre">datetime.datetime</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) &#8211; Time when this backup was finished.
endTime End time is None till backup is finished.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.recovery.backup_client.Job.BackupRequest">
<em class="property">class </em><tt class="descclassname">Job.</tt><tt class="descname">BackupRequest</tt><big>(</big><em>parts=None</em>, <em>backup_password=None</em>, <em>location_type=None</em>, <em>location=None</em>, <em>location_user=None</em>, <em>location_password=None</em>, <em>comment=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/appliance/recovery/backup_client.html#Job.BackupRequest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.BackupRequest" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
<p><tt class="docutils literal"><span class="pre">Job.BackupRequest</span></tt> class Structure representing requested backup piece</p>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>parts</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) &#8211; a list of optional parts. Run backup parts APIs to get list of
optional parts and description</li>
<li><strong>backup_password</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) &#8211; a password for a backup piece The backupPassword must adhere to the
following password requirements: At least 8 characters, cannot be
more than 20 characters in length. At least 1 uppercase letter. At
least 1 lowercase letter. At least 1 numeric digit. At least 1
special character (i.e. any character not in [0-9,a-z,A-Z]). Only
visible ASCII characters (for example, no space).
backupPassword If no password then the piece will not be encrypted</li>
<li><strong>location_type</strong> (<a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.Job.LocationType" title="com.vmware.appliance.recovery.backup_client.Job.LocationType"><tt class="xref py py-class docutils literal"><span class="pre">Job.LocationType</span></tt></a>) &#8211; a type of location</li>
<li><strong>location</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) &#8211; path or url</li>
<li><strong>location_user</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) &#8211; username for location
locationUser User name for this location if login is required.</li>
<li><strong>location_password</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) &#8211; password for location
locationPassword Password for the specified user if login is
required at this location.</li>
<li><strong>comment</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) &#8211; Custom comment
comment an optional comment</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState">
<em class="property">class </em><tt class="descclassname">Job.</tt><tt class="descname">BackupRestoreProcessState</tt><big>(</big><em>string</em><big>)</big><a class="reference internal" href="_modules/com/vmware/appliance/recovery/backup_client.html#Job.BackupRestoreProcessState"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.enum.Enum" title="vmware.vapi.bindings.enum.Enum"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></a></p>
<p><tt class="docutils literal"><span class="pre">Job.BackupRestoreProcessState</span></tt> class Defines state of backup/restore
process</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="custom/rst/enumeration.html#enumeration-description"><em>enumerated
type description page</em></a>.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) &#8211; String value for the <tt class="xref py py-class docutils literal"><span class="pre">BackupRestoreProcessState</span></tt> instance.</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState.FAILED">
<tt class="descname">FAILED</tt><em class="property"> = BackupRestoreProcessState(string=u'FAILED')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState.FAILED" title="Permalink to this definition"></a></dt>
<dd><p>Failed</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState.INPROGRESS">
<tt class="descname">INPROGRESS</tt><em class="property"> = BackupRestoreProcessState(string=u'INPROGRESS')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState.INPROGRESS" title="Permalink to this definition"></a></dt>
<dd><p>In progress</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState.NONE">
<tt class="descname">NONE</tt><em class="property"> = BackupRestoreProcessState(string=u'NONE')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState.NONE" title="Permalink to this definition"></a></dt>
<dd><p>Not started</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState.SUCCEEDED">
<tt class="descname">SUCCEEDED</tt><em class="property"> = BackupRestoreProcessState(string=u'SUCCEEDED')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState.SUCCEEDED" title="Permalink to this definition"></a></dt>
<dd><p>Completed successfully</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.recovery.backup_client.Job.LocalizableMessage">
<em class="property">class </em><tt class="descclassname">Job.</tt><tt class="descname">LocalizableMessage</tt><big>(</big><em>id=None</em>, <em>default_message=None</em>, <em>args=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/appliance/recovery/backup_client.html#Job.LocalizableMessage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.LocalizableMessage" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
<p><tt class="docutils literal"><span class="pre">Job.LocalizableMessage</span></tt> class Structure representing message</p>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) &#8211; id in message bundle</li>
<li><strong>default_message</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) &#8211; text in english</li>
<li><strong>args</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) &#8211; nested data</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.recovery.backup_client.Job.LocationType">
<em class="property">class </em><tt class="descclassname">Job.</tt><tt class="descname">LocationType</tt><big>(</big><em>string</em><big>)</big><a class="reference internal" href="_modules/com/vmware/appliance/recovery/backup_client.html#Job.LocationType"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.LocationType" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.enum.Enum" title="vmware.vapi.bindings.enum.Enum"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></a></p>
<p><tt class="docutils literal"><span class="pre">Job.LocationType</span></tt> class Defines type of all locations for backup/restore</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="custom/rst/enumeration.html#enumeration-description"><em>enumerated
type description page</em></a>.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) &#8211; String value for the <tt class="xref py py-class docutils literal"><span class="pre">LocationType</span></tt> instance.</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="com.vmware.appliance.recovery.backup_client.Job.LocationType.FTP">
<tt class="descname">FTP</tt><em class="property"> = LocationType(string=u'FTP')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.LocationType.FTP" title="Permalink to this definition"></a></dt>
<dd><p>Destination is FTP server</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.recovery.backup_client.Job.LocationType.FTPS">
<tt class="descname">FTPS</tt><em class="property"> = LocationType(string=u'FTPS')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.LocationType.FTPS" title="Permalink to this definition"></a></dt>
<dd><p>Destination is FTPS server</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.recovery.backup_client.Job.LocationType.HTTP">
<tt class="descname">HTTP</tt><em class="property"> = LocationType(string=u'HTTP')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.LocationType.HTTP" title="Permalink to this definition"></a></dt>
<dd><p>Destination is HTTP server</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.recovery.backup_client.Job.LocationType.HTTPS">
<tt class="descname">HTTPS</tt><em class="property"> = LocationType(string=u'HTTPS')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.LocationType.HTTPS" title="Permalink to this definition"></a></dt>
<dd><p>Destination is HTTPS server</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.recovery.backup_client.Job.LocationType.SCP">
<tt class="descname">SCP</tt><em class="property"> = LocationType(string=u'SCP')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.LocationType.SCP" title="Permalink to this definition"></a></dt>
<dd><p>Destination is SSH server</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.recovery.backup_client.Job.ReturnResult">
<em class="property">class </em><tt class="descclassname">Job.</tt><tt class="descname">ReturnResult</tt><big>(</big><em>status=None</em>, <em>messages=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/appliance/recovery/backup_client.html#Job.ReturnResult"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.ReturnResult" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
<p><tt class="docutils literal"><span class="pre">Job.ReturnResult</span></tt> class Structure representing precheck result</p>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>status</strong> (<a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.Job.ReturnStatus" title="com.vmware.appliance.recovery.backup_client.Job.ReturnStatus"><tt class="xref py py-class docutils literal"><span class="pre">Job.ReturnStatus</span></tt></a>) &#8211; Check status</li>
<li><strong>messages</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.Job.LocalizableMessage" title="com.vmware.appliance.recovery.backup_client.Job.LocalizableMessage"><tt class="xref py py-class docutils literal"><span class="pre">Job.LocalizableMessage</span></tt></a>) &#8211; List of messages</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.recovery.backup_client.Job.ReturnStatus">
<em class="property">class </em><tt class="descclassname">Job.</tt><tt class="descname">ReturnStatus</tt><big>(</big><em>string</em><big>)</big><a class="reference internal" href="_modules/com/vmware/appliance/recovery/backup_client.html#Job.ReturnStatus"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.ReturnStatus" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.enum.Enum" title="vmware.vapi.bindings.enum.Enum"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></a></p>
<p><tt class="docutils literal"><span class="pre">Job.ReturnStatus</span></tt> class Defines the state of precheck</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="custom/rst/enumeration.html#enumeration-description"><em>enumerated
type description page</em></a>.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) &#8211; String value for the <tt class="xref py py-class docutils literal"><span class="pre">ReturnStatus</span></tt> instance.</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="com.vmware.appliance.recovery.backup_client.Job.ReturnStatus.FAIL">
<tt class="descname">FAIL</tt><em class="property"> = ReturnStatus(string=u'FAIL')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.ReturnStatus.FAIL" title="Permalink to this definition"></a></dt>
<dd><p>Check failed</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.recovery.backup_client.Job.ReturnStatus.OK">
<tt class="descname">OK</tt><em class="property"> = ReturnStatus(string=u'OK')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.ReturnStatus.OK" title="Permalink to this definition"></a></dt>
<dd><p>Check passed</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.recovery.backup_client.Job.ReturnStatus.WARNING">
<tt class="descname">WARNING</tt><em class="property"> = ReturnStatus(string=u'WARNING')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.ReturnStatus.WARNING" title="Permalink to this definition"></a></dt>
<dd><p>Passed with warnings</p>
</dd></dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.recovery.backup_client.Job.cancel">
<tt class="descclassname">Job.</tt><tt class="descname">cancel</tt><big>(</big><em>id</em><big>)</big><a class="reference internal" href="_modules/com/vmware/appliance/recovery/backup_client.html#Job.cancel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.cancel" title="Permalink to this definition"></a></dt>
<dd><p>Cancel the backup job</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) &#8211; ID (ID of job)
The parameter must be an identifier for the resource type:
<tt class="docutils literal"><span class="pre">com.vmware.appliance.recovery.backup.job</span></tt>.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.Job.ReturnResult" title="com.vmware.appliance.recovery.backup_client.Job.ReturnResult"><tt class="xref py py-class docutils literal"><span class="pre">Job.ReturnResult</span></tt></a></td>
</tr>
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">BackupJobStatus Structure</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise :</th><td class="field-body"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt></a>
ID is not found</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise :</th><td class="field-body"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt></a>
Generic error</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.recovery.backup_client.Job.create">
<tt class="descclassname">Job.</tt><tt class="descname">create</tt><big>(</big><em>piece</em><big>)</big><a class="reference internal" href="_modules/com/vmware/appliance/recovery/backup_client.html#Job.create"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.create" title="Permalink to this definition"></a></dt>
<dd><p>Initiate backup.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>piece</strong> (<a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.Job.BackupRequest" title="com.vmware.appliance.recovery.backup_client.Job.BackupRequest"><tt class="xref py py-class docutils literal"><span class="pre">Job.BackupRequest</span></tt></a>) &#8211; BackupRequest Structure</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.Job.BackupJobStatus" title="com.vmware.appliance.recovery.backup_client.Job.BackupJobStatus"><tt class="xref py py-class docutils literal"><span class="pre">Job.BackupJobStatus</span></tt></a></td>
</tr>
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">BackupJobStatus Structure</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise :</th><td class="field-body"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.FeatureInUse" title="com.vmware.vapi.std.errors_client.FeatureInUse"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.FeatureInUse</span></tt></a>
A backup or restore is already in progress</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise :</th><td class="field-body"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt></a>
Generic error</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.recovery.backup_client.Job.get">
<tt class="descclassname">Job.</tt><tt class="descname">get</tt><big>(</big><em>id</em><big>)</big><a class="reference internal" href="_modules/com/vmware/appliance/recovery/backup_client.html#Job.get"><span class="viewcode-link">[source]</span></a><a class="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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) &#8211; ID (ID of job)
The parameter must be an identifier for the resource type:
<tt class="docutils literal"><span class="pre">com.vmware.appliance.recovery.backup.job</span></tt>.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.Job.BackupJobStatus" title="com.vmware.appliance.recovery.backup_client.Job.BackupJobStatus"><tt class="xref py py-class docutils literal"><span class="pre">Job.BackupJobStatus</span></tt></a></td>
</tr>
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">BackupJobStatus Structure</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise :</th><td class="field-body"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt></a>
ID is not found</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise :</th><td class="field-body"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt></a>
Generic error</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.recovery.backup_client.Job.list">
<tt class="descclassname">Job.</tt><tt class="descname">list</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/com/vmware/appliance/recovery/backup_client.html#Job.list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.list" title="Permalink to this definition"></a></dt>
<dd><p>Get list of backup jobs</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.Job.list" title="com.vmware.appliance.recovery.backup_client.Job.list"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">list of BackupJob IDs
The return value will contain identifiers for the resource type:
<tt class="docutils literal"><span class="pre">com.vmware.appliance.recovery.backup.job</span></tt>.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise :</th><td class="field-body"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt></a>
Generic error</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.recovery.backup_client.Parts">
<em class="property">class </em><tt class="descclassname">com.vmware.appliance.recovery.backup_client.</tt><tt class="descname">Parts</tt><big>(</big><em>config</em><big>)</big><a class="reference internal" href="_modules/com/vmware/appliance/recovery/backup_client.html#Parts"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Parts" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.stub.VapiInterface" title="vmware.vapi.bindings.stub.VapiInterface"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></a></p>
<p><tt class="docutils literal"><span class="pre">Parts</span></tt> class provides methods Provides list of parts optional for the
backup</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.stub.StubConfiguration" title="vmware.vapi.bindings.stub.StubConfiguration"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt></a>) &#8211; Configuration to be used for creating the stub.</td>
</tr>
</tbody>
</table>
<dl class="class">
<dt id="com.vmware.appliance.recovery.backup_client.Parts.LocalizableMessage">
<em class="property">class </em><tt class="descname">LocalizableMessage</tt><big>(</big><em>id=None</em>, <em>default_message=None</em>, <em>args=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/appliance/recovery/backup_client.html#Parts.LocalizableMessage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Parts.LocalizableMessage" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
<p><tt class="docutils literal"><span class="pre">Parts.LocalizableMessage</span></tt> class Structure representing message</p>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) &#8211; id in message bundle</li>
<li><strong>default_message</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) &#8211; text in english</li>
<li><strong>args</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) &#8211; nested data</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.recovery.backup_client.Parts.Part">
<em class="property">class </em><tt class="descclassname">Parts.</tt><tt class="descname">Part</tt><big>(</big><em>id=None</em>, <em>name=None</em>, <em>description=None</em>, <em>selected_by_default=None</em>, <em>optional=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/appliance/recovery/backup_client.html#Parts.Part"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Parts.Part" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
<p><tt class="docutils literal"><span class="pre">Parts.Part</span></tt> class Structure representing backup restore part</p>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) &#8211; part ID
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<tt class="docutils literal"><span class="pre">com.vmware.appliance.recovery.backup.parts</span></tt>. When methods return
a value of this class as a return value, the attribute will be an
identifier for the resource type:
<tt class="docutils literal"><span class="pre">com.vmware.appliance.recovery.backup.parts</span></tt>.</li>
<li><strong>name</strong> (<a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.Parts.LocalizableMessage" title="com.vmware.appliance.recovery.backup_client.Parts.LocalizableMessage"><tt class="xref py py-class docutils literal"><span class="pre">Parts.LocalizableMessage</span></tt></a>) &#8211; part name id in message bundle</li>
<li><strong>description</strong> (<a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.Parts.LocalizableMessage" title="com.vmware.appliance.recovery.backup_client.Parts.LocalizableMessage"><tt class="xref py py-class docutils literal"><span class="pre">Parts.LocalizableMessage</span></tt></a>) &#8211; part description id in message bundle</li>
<li><strong>selected_by_default</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) &#8211; Is part selected by default in UI</li>
<li><strong>optional</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) &#8211; Estimated size of this piece</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.recovery.backup_client.Parts.get">
<tt class="descclassname">Parts.</tt><tt class="descname">get</tt><big>(</big><em>id</em><big>)</big><a class="reference internal" href="_modules/com/vmware/appliance/recovery/backup_client.html#Parts.get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Parts.get" title="Permalink to this definition"></a></dt>
<dd><p>Get size of the optional part</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) &#8211; part id
The parameter must be an identifier for the resource type:
<tt class="docutils literal"><span class="pre">com.vmware.appliance.recovery.backup.parts</span></tt>.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">long</span></tt></td>
</tr>
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">int size</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise :</th><td class="field-body"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt></a>
Generic error</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.recovery.backup_client.Parts.list">
<tt class="descclassname">Parts.</tt><tt class="descname">list</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/com/vmware/appliance/recovery/backup_client.html#Parts.list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Parts.list" title="Permalink to this definition"></a></dt>
<dd><p>Get a list of the backup parts</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.Parts.list" title="com.vmware.appliance.recovery.backup_client.Parts.list"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of <a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.Parts.Part" title="com.vmware.appliance.recovery.backup_client.Parts.Part"><tt class="xref py py-class docutils literal"><span class="pre">Parts.Part</span></tt></a></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">list of parts</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise :</th><td class="field-body"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt></a>
Generic error</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.appliance.recovery.restore_client">
<span id="restore-client-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">restore_client</span></tt> Module<a class="headerlink" href="#module-com.vmware.appliance.recovery.restore_client" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="com.vmware.appliance.recovery.restore_client.Job">
<em class="property">class </em><tt class="descclassname">com.vmware.appliance.recovery.restore_client.</tt><tt class="descname">Job</tt><big>(</big><em>config</em><big>)</big><a class="reference internal" href="_modules/com/vmware/appliance/recovery/restore_client.html#Job"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.stub.VapiInterface" title="vmware.vapi.bindings.stub.VapiInterface"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></a></p>
<p><tt class="docutils literal"><span class="pre">Job</span></tt> class provides methods Performs restore operations</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.stub.StubConfiguration" title="vmware.vapi.bindings.stub.StubConfiguration"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt></a>) &#8211; Configuration to be used for creating the stub.</td>
</tr>
</tbody>
</table>
<dl class="class">
<dt id="com.vmware.appliance.recovery.restore_client.Job.BackupRestoreProcessState">
<em class="property">class </em><tt class="descname">BackupRestoreProcessState</tt><big>(</big><em>string</em><big>)</big><a class="reference internal" href="_modules/com/vmware/appliance/recovery/restore_client.html#Job.BackupRestoreProcessState"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.BackupRestoreProcessState" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.enum.Enum" title="vmware.vapi.bindings.enum.Enum"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></a></p>
<p><tt class="docutils literal"><span class="pre">Job.BackupRestoreProcessState</span></tt> class Defines state of backup/restore
process</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="custom/rst/enumeration.html#enumeration-description"><em>enumerated
type description page</em></a>.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) &#8211; String value for the <tt class="xref py py-class docutils literal"><span class="pre">BackupRestoreProcessState</span></tt> instance.</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="com.vmware.appliance.recovery.restore_client.Job.BackupRestoreProcessState.FAILED">
<tt class="descname">FAILED</tt><em class="property"> = BackupRestoreProcessState(string=u'FAILED')</em><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.BackupRestoreProcessState.FAILED" title="Permalink to this definition"></a></dt>
<dd><p>Failed</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.recovery.restore_client.Job.BackupRestoreProcessState.INPROGRESS">
<tt class="descname">INPROGRESS</tt><em class="property"> = BackupRestoreProcessState(string=u'INPROGRESS')</em><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.BackupRestoreProcessState.INPROGRESS" title="Permalink to this definition"></a></dt>
<dd><p>In progress</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.recovery.restore_client.Job.BackupRestoreProcessState.NONE">
<tt class="descname">NONE</tt><em class="property"> = BackupRestoreProcessState(string=u'NONE')</em><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.BackupRestoreProcessState.NONE" title="Permalink to this definition"></a></dt>
<dd><p>Not started</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.recovery.restore_client.Job.BackupRestoreProcessState.SUCCEEDED">
<tt class="descname">SUCCEEDED</tt><em class="property"> = BackupRestoreProcessState(string=u'SUCCEEDED')</em><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.BackupRestoreProcessState.SUCCEEDED" title="Permalink to this definition"></a></dt>
<dd><p>Completed successfully</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.recovery.restore_client.Job.LocalizableMessage">
<em class="property">class </em><tt class="descclassname">Job.</tt><tt class="descname">LocalizableMessage</tt><big>(</big><em>id=None</em>, <em>default_message=None</em>, <em>args=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/appliance/recovery/restore_client.html#Job.LocalizableMessage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.LocalizableMessage" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
<p><tt class="docutils literal"><span class="pre">Job.LocalizableMessage</span></tt> class Structure representing message</p>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) &#8211; id in message bundle</li>
<li><strong>default_message</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) &#8211; text in english</li>
<li><strong>args</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) &#8211; nested data</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.recovery.restore_client.Job.LocationType">
<em class="property">class </em><tt class="descclassname">Job.</tt><tt class="descname">LocationType</tt><big>(</big><em>string</em><big>)</big><a class="reference internal" href="_modules/com/vmware/appliance/recovery/restore_client.html#Job.LocationType"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.LocationType" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.enum.Enum" title="vmware.vapi.bindings.enum.Enum"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></a></p>
<p><tt class="docutils literal"><span class="pre">Job.LocationType</span></tt> class Defines type of all locations for backup/restore</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="custom/rst/enumeration.html#enumeration-description"><em>enumerated
type description page</em></a>.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) &#8211; String value for the <tt class="xref py py-class docutils literal"><span class="pre">LocationType</span></tt> instance.</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="com.vmware.appliance.recovery.restore_client.Job.LocationType.FTP">
<tt class="descname">FTP</tt><em class="property"> = LocationType(string=u'FTP')</em><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.LocationType.FTP" title="Permalink to this definition"></a></dt>
<dd><p>Destination is FTP server</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.recovery.restore_client.Job.LocationType.FTPS">
<tt class="descname">FTPS</tt><em class="property"> = LocationType(string=u'FTPS')</em><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.LocationType.FTPS" title="Permalink to this definition"></a></dt>
<dd><p>Destination is FTPS server</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.recovery.restore_client.Job.LocationType.HTTP">
<tt class="descname">HTTP</tt><em class="property"> = LocationType(string=u'HTTP')</em><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.LocationType.HTTP" title="Permalink to this definition"></a></dt>
<dd><p>Destination is HTTP server</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.recovery.restore_client.Job.LocationType.HTTPS">
<tt class="descname">HTTPS</tt><em class="property"> = LocationType(string=u'HTTPS')</em><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.LocationType.HTTPS" title="Permalink to this definition"></a></dt>
<dd><p>Destination is HTTPS server</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.recovery.restore_client.Job.LocationType.SCP">
<tt class="descname">SCP</tt><em class="property"> = LocationType(string=u'SCP')</em><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.LocationType.SCP" title="Permalink to this definition"></a></dt>
<dd><p>Destination is SSH server</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.recovery.restore_client.Job.RestoreJobStatus">
<em class="property">class </em><tt class="descclassname">Job.</tt><tt class="descname">RestoreJobStatus</tt><big>(</big><em>state=None</em>, <em>messages=None</em>, <em>progress=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/appliance/recovery/restore_client.html#Job.RestoreJobStatus"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.RestoreJobStatus" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
<p><tt class="docutils literal"><span class="pre">Job.RestoreJobStatus</span></tt> class Structure representing backup restore status</p>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>state</strong> (<a class="reference internal" href="#com.vmware.appliance.recovery.restore_client.Job.BackupRestoreProcessState" title="com.vmware.appliance.recovery.restore_client.Job.BackupRestoreProcessState"><tt class="xref py py-class docutils literal"><span class="pre">Job.BackupRestoreProcessState</span></tt></a>) &#8211; process state</li>
<li><strong>messages</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="#com.vmware.appliance.recovery.restore_client.Job.LocalizableMessage" title="com.vmware.appliance.recovery.restore_client.Job.LocalizableMessage"><tt class="xref py py-class docutils literal"><span class="pre">Job.LocalizableMessage</span></tt></a>) &#8211; list of messages</li>
<li><strong>progress</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) &#8211; percentage complete</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.recovery.restore_client.Job.RestoreRequest">
<em class="property">class </em><tt class="descclassname">Job.</tt><tt class="descname">RestoreRequest</tt><big>(</big><em>backup_password=None</em>, <em>location_type=None</em>, <em>location=None</em>, <em>location_user=None</em>, <em>location_password=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/appliance/recovery/restore_client.html#Job.RestoreRequest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.RestoreRequest" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
<p><tt class="docutils literal"><span class="pre">Job.RestoreRequest</span></tt> class Structure representing requested restore piece</p>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>backup_password</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) &#8211; a password for a backup piece
backupPassword If no password then the piece will not be decrypted</li>
<li><strong>location_type</strong> (<a class="reference internal" href="#com.vmware.appliance.recovery.restore_client.Job.LocationType" title="com.vmware.appliance.recovery.restore_client.Job.LocationType"><tt class="xref py py-class docutils literal"><span class="pre">Job.LocationType</span></tt></a>) &#8211; a type of location</li>
<li><strong>location</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) &#8211; path or url</li>
<li><strong>location_user</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) &#8211; username for location
locationUser User name for this location if login is required.</li>
<li><strong>location_password</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) &#8211; password for location
locationPassword Password for the specified user if login is
required at this location.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.recovery.restore_client.Job.ReturnResult">
<em class="property">class </em><tt class="descclassname">Job.</tt><tt class="descname">ReturnResult</tt><big>(</big><em>status=None</em>, <em>messages=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/appliance/recovery/restore_client.html#Job.ReturnResult"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.ReturnResult" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
<p><tt class="docutils literal"><span class="pre">Job.ReturnResult</span></tt> class Structure representing precheck result</p>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>status</strong> (<a class="reference internal" href="#com.vmware.appliance.recovery.restore_client.Job.ReturnStatus" title="com.vmware.appliance.recovery.restore_client.Job.ReturnStatus"><tt class="xref py py-class docutils literal"><span class="pre">Job.ReturnStatus</span></tt></a>) &#8211; Check status</li>
<li><strong>messages</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="#com.vmware.appliance.recovery.restore_client.Job.LocalizableMessage" title="com.vmware.appliance.recovery.restore_client.Job.LocalizableMessage"><tt class="xref py py-class docutils literal"><span class="pre">Job.LocalizableMessage</span></tt></a>) &#8211; List of messages</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.recovery.restore_client.Job.ReturnStatus">
<em class="property">class </em><tt class="descclassname">Job.</tt><tt class="descname">ReturnStatus</tt><big>(</big><em>string</em><big>)</big><a class="reference internal" href="_modules/com/vmware/appliance/recovery/restore_client.html#Job.ReturnStatus"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.ReturnStatus" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.enum.Enum" title="vmware.vapi.bindings.enum.Enum"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></a></p>
<p><tt class="docutils literal"><span class="pre">Job.ReturnStatus</span></tt> class Defines the state of precheck</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="custom/rst/enumeration.html#enumeration-description"><em>enumerated
type description page</em></a>.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) &#8211; String value for the <tt class="xref py py-class docutils literal"><span class="pre">ReturnStatus</span></tt> instance.</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="com.vmware.appliance.recovery.restore_client.Job.ReturnStatus.FAIL">
<tt class="descname">FAIL</tt><em class="property"> = ReturnStatus(string=u'FAIL')</em><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.ReturnStatus.FAIL" title="Permalink to this definition"></a></dt>
<dd><p>Check failed</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.recovery.restore_client.Job.ReturnStatus.OK">
<tt class="descname">OK</tt><em class="property"> = ReturnStatus(string=u'OK')</em><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.ReturnStatus.OK" title="Permalink to this definition"></a></dt>
<dd><p>Check passed</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.recovery.restore_client.Job.ReturnStatus.WARNING">
<tt class="descname">WARNING</tt><em class="property"> = ReturnStatus(string=u'WARNING')</em><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.ReturnStatus.WARNING" title="Permalink to this definition"></a></dt>
<dd><p>Passed with warnings</p>
</dd></dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.recovery.restore_client.Job.cancel">
<tt class="descclassname">Job.</tt><tt class="descname">cancel</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/com/vmware/appliance/recovery/restore_client.html#Job.cancel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.cancel" title="Permalink to this definition"></a></dt>
<dd><p>Cancel the backup job</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.appliance.recovery.restore_client.Job.ReturnResult" title="com.vmware.appliance.recovery.restore_client.Job.ReturnResult"><tt class="xref py py-class docutils literal"><span class="pre">Job.ReturnResult</span></tt></a></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">RestoreJobStatus Structure</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise :</th><td class="field-body"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt></a>
Generic error</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.recovery.restore_client.Job.create">
<tt class="descclassname">Job.</tt><tt class="descname">create</tt><big>(</big><em>piece</em><big>)</big><a class="reference internal" href="_modules/com/vmware/appliance/recovery/restore_client.html#Job.create"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.create" title="Permalink to this definition"></a></dt>
<dd><p>Initiate restore.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>piece</strong> (<a class="reference internal" href="#com.vmware.appliance.recovery.restore_client.Job.RestoreRequest" title="com.vmware.appliance.recovery.restore_client.Job.RestoreRequest"><tt class="xref py py-class docutils literal"><span class="pre">Job.RestoreRequest</span></tt></a>) &#8211; RestoreRequest Structure</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.appliance.recovery.restore_client.Job.RestoreJobStatus" title="com.vmware.appliance.recovery.restore_client.Job.RestoreJobStatus"><tt class="xref py py-class docutils literal"><span class="pre">Job.RestoreJobStatus</span></tt></a></td>
</tr>
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">RestoreJobStatus Structure</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise :</th><td class="field-body"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.FeatureInUse" title="com.vmware.vapi.std.errors_client.FeatureInUse"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.FeatureInUse</span></tt></a>
A backup or restore is already in progress</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise :</th><td class="field-body"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></tt></a>
Restore is allowed only after deployment and before firstboot</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise :</th><td class="field-body"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt></a>
Generic error</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.recovery.restore_client.Job.get">
<tt class="descclassname">Job.</tt><tt class="descname">get</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/com/vmware/appliance/recovery/restore_client.html#Job.get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.get" title="Permalink to this definition"></a></dt>
<dd><p>See restore job progress/result.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.appliance.recovery.restore_client.Job.RestoreJobStatus" title="com.vmware.appliance.recovery.restore_client.Job.RestoreJobStatus"><tt class="xref py py-class docutils literal"><span class="pre">Job.RestoreJobStatus</span></tt></a></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">RestoreJobStatus Structure</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise :</th><td class="field-body"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt></a>
Generic error</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">recovery Package</a><ul>
<li><a class="reference internal" href="#id1"><tt class="docutils literal"><span class="pre">recovery</span></tt> Package</a></li>
<li><a class="reference internal" href="#module-com.vmware.appliance.recovery.backup_client"><tt class="docutils literal"><span class="pre">backup_client</span></tt> Module</a></li>
<li><a class="reference internal" href="#module-com.vmware.appliance.recovery.restore_client"><tt class="docutils literal"><span class="pre">restore_client</span></tt> Module</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="com.vmware.appliance.networking.html"
title="previous chapter">networking Package</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="com.vmware.appliance.techpreview.html"
title="next chapter">techpreview Package</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/com.vmware.appliance.recovery.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="com.vmware.appliance.techpreview.html" title="techpreview Package"
>next</a> |</li>
<li class="right" >
<a href="com.vmware.appliance.networking.html" title="networking Package"
>previous</a> |</li>
<li><a href="index.html">vSphere Automation SDK for Python 6.5.0 documentation</a> &raquo;</li>
<li><a href="com.html" >com Package</a> &raquo;</li>
<li><a href="com.vmware.html" >vmware Package</a> &raquo;</li>
<li><a href="com.vmware.appliance.html" >appliance Package</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2014, VMware, Inc..
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>
Copy Permalink