mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-22 17:39:59 -05:00
1829 lines
144 KiB
HTML
1829 lines
144 KiB
HTML
|
|
|||
|
|
|
|||
|
|
<!DOCTYPE html>
|
|||
|
|
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
|||
|
|
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
|||
|
|
<head>
|
|||
|
|
<meta charset="utf-8">
|
|||
|
|
|
|||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|||
|
|
|
|||
|
|
<title>com.vmware.appliance.recovery package — vSphere Automation SDK for Python. 6.9.1 documentation</title>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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>
|
|||
|
|
<script type="text/javascript" src="_static/language_data.js"></script>
|
|||
|
|
|
|||
|
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
|||
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|||
|
|
<link rel="index" title="Index" href="genindex.html" />
|
|||
|
|
<link rel="search" title="Search" href="search.html" />
|
|||
|
|
<link rel="next" title="com.vmware.appliance.recovery.backup package" href="com.vmware.appliance.recovery.backup.html" />
|
|||
|
|
<link rel="prev" title="com.vmware.appliance.networking package" href="com.vmware.appliance.networking.html" />
|
|||
|
|
</head>
|
|||
|
|
|
|||
|
|
<body class="wy-body-for-nav">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="wy-grid-for-nav">
|
|||
|
|
|
|||
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|||
|
|
<div class="wy-side-scroll">
|
|||
|
|
<div class="wy-side-nav-search" >
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python.
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="version">
|
|||
|
|
6.9.1
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div role="search">
|
|||
|
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
|||
|
|
<input type="text" name="q" placeholder="Search docs" />
|
|||
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|||
|
|
<input type="hidden" name="area" value="default" />
|
|||
|
|
</form>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<p class="caption"><span class="caption-text">Contents:</span></p>
|
|||
|
|
<ul class="current">
|
|||
|
|
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
|
|||
|
|
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
|
|||
|
|
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
|||
|
|
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="vmware.html">vmware package</a></li>
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<nav class="wy-nav-top" aria-label="top navigation">
|
|||
|
|
|
|||
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|||
|
|
<a href="index.html">vSphere Automation SDK for Python.</a>
|
|||
|
|
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="wy-nav-content">
|
|||
|
|
|
|||
|
|
<div class="rst-content">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
|||
|
|
|
|||
|
|
<ul class="wy-breadcrumbs">
|
|||
|
|
|
|||
|
|
<li><a href="index.html">Docs</a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.html">com package</a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.vmware.html">com.vmware package</a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.vmware.appliance.html">com.vmware.appliance package</a> »</li>
|
|||
|
|
|
|||
|
|
<li>com.vmware.appliance.recovery package</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="wy-breadcrumbs-aside">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a href="_sources/com.vmware.appliance.recovery.rst.txt" rel="nofollow"> View page source</a>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<hr/>
|
|||
|
|
</div>
|
|||
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|||
|
|
<div itemprop="articleBody">
|
|||
|
|
|
|||
|
|
<div class="section" id="module-com.vmware.appliance.recovery">
|
|||
|
|
<span id="com-vmware-appliance-recovery-package"></span><h1>com.vmware.appliance.recovery package<a class="headerlink" href="#module-com.vmware.appliance.recovery" title="Permalink to this headline">¶</a></h1>
|
|||
|
|
<div class="section" id="subpackages">
|
|||
|
|
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<div class="toctree-wrapper compound">
|
|||
|
|
<ul>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="com.vmware.appliance.recovery.backup.html">com.vmware.appliance.recovery.backup package</a><ul>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.recovery.backup.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.recovery.backup.html#module-com.vmware.appliance.recovery.backup.job_client">com.vmware.appliance.recovery.backup.job_client module</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.appliance.recovery.backup.html#module-com.vmware.appliance.recovery.backup.system_name_client">com.vmware.appliance.recovery.backup.system_name_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<div class="section" id="submodules">
|
|||
|
|
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
</div>
|
|||
|
|
<div class="section" id="module-com.vmware.appliance.recovery.backup_client">
|
|||
|
|
<span id="com-vmware-appliance-recovery-backup-client-module"></span><h2>com.vmware.appliance.recovery.backup_client 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><code class="sig-prename descclassname">com.vmware.appliance.recovery.backup_client.</code><code class="sig-name descname">Job</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Job</span></code> class provides methods to be performed on a backup job.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.Job.BackupJobStatus">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">BackupJobStatus</code><span class="sig-paren">(</span><em class="sig-param">id=None</em>, <em class="sig-param">state=None</em>, <em class="sig-param">messages=None</em>, <em class="sig-param">progress=None</em>, <em class="sig-param">start_time=None</em>, <em class="sig-param">end_time=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.BackupJobStatus" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Job.BackupJobStatus</span></code> class represents the status of a backup/restore
|
|||
|
|
job.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – TimeStamp based ID.</p></li>
|
|||
|
|
<li><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Job.BackupRestoreProcessState</span></code></a>) – The state of the backup job.</p></li>
|
|||
|
|
<li><p><strong>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.Job.LocalizableMessage" title="com.vmware.appliance.recovery.backup_client.Job.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">Job.LocalizableMessage</span></code></a>) – List of messages.</p></li>
|
|||
|
|
<li><p><strong>progress</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Progress of the job in percentage.</p></li>
|
|||
|
|
<li><p><strong>start_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the backup was started.</p></li>
|
|||
|
|
<li><p><strong>end_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Time when the backup was finished.
|
|||
|
|
If None end time is None until backup is finished.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.Job.BackupRequest">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">BackupRequest</code><span class="sig-paren">(</span><em class="sig-param">parts=None</em>, <em class="sig-param">backup_password=None</em>, <em class="sig-param">location_type=None</em>, <em class="sig-param">location=None</em>, <em class="sig-param">location_user=None</em>, <em class="sig-param">location_password=None</em>, <em class="sig-param">comment=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.BackupRequest" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Job.BackupRequest</span></code> class represents a requested backup piece.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>parts</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – List of optional parts that will be included in the backup. Use the
|
|||
|
|
<a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.Parts.list" title="com.vmware.appliance.recovery.backup_client.Parts.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Parts.list()</span></code></a> method to get information about the supported
|
|||
|
|
parts.</p></li>
|
|||
|
|
<li><p><strong>backup_password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.Job.LocationType" title="com.vmware.appliance.recovery.backup_client.Job.LocationType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Job.LocationType</span></code></a>) – Type of backup location.</p></li>
|
|||
|
|
<li><p><strong>location</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Path or URL of the backup location.</p></li>
|
|||
|
|
<li><p><strong>location_user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Custom comment provided by the user.
|
|||
|
|
If None comment will be empty.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">BackupRestoreProcessState</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Job.BackupRestoreProcessState</span></code> class defines the possible states of
|
|||
|
|
a backup/restore process.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="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 <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">BackupRestoreProcessState</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState.FAILED">
|
|||
|
|
<code class="sig-name descname">FAILED</code><em class="property"> = BackupRestoreProcessState(string='FAILED')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState.FAILED" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Backup/Restore job failed.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState.INPROGRESS">
|
|||
|
|
<code class="sig-name descname">INPROGRESS</code><em class="property"> = BackupRestoreProcessState(string='INPROGRESS')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState.INPROGRESS" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Backup/Restore job is in progress.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState.NONE">
|
|||
|
|
<code class="sig-name descname">NONE</code><em class="property"> = BackupRestoreProcessState(string='NONE')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState.NONE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Backup/Restore job is not started.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState.SUCCEEDED">
|
|||
|
|
<code class="sig-name descname">SUCCEEDED</code><em class="property"> = BackupRestoreProcessState(string='SUCCEEDED')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState.SUCCEEDED" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Backup/Restore job 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><code class="sig-name descname">LocalizableMessage</code><span class="sig-paren">(</span><em class="sig-param">id=None</em>, <em class="sig-param">default_message=None</em>, <em class="sig-param">args=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.LocalizableMessage" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Job.LocalizableMessage</span></code> class represents a localizable message.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Id in message bundle.</p></li>
|
|||
|
|
<li><p><strong>default_message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Text in english.</p></li>
|
|||
|
|
<li><p><strong>args</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Nested data.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.Job.LocationType">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">LocationType</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.LocationType" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="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 <a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.Job.BackupRequest" title="com.vmware.appliance.recovery.backup_client.Job.BackupRequest"><code class="xref py py-class docutils literal notranslate"><span class="pre">Job.BackupRequest</span></code></a>.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="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 <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">LocationType</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.Job.LocationType.FTP">
|
|||
|
|
<code class="sig-name descname">FTP</code><em class="property"> = LocationType(string='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">
|
|||
|
|
<code class="sig-name descname">FTPS</code><em class="property"> = LocationType(string='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">
|
|||
|
|
<code class="sig-name descname">HTTP</code><em class="property"> = LocationType(string='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">
|
|||
|
|
<code class="sig-name descname">HTTPS</code><em class="property"> = LocationType(string='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.NFS">
|
|||
|
|
<code class="sig-name descname">NFS</code><em class="property"> = LocationType(string='NFS')</em><a class="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
|
|||
|
|
6.7.2.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.Job.LocationType.SCP">
|
|||
|
|
<code class="sig-name descname">SCP</code><em class="property"> = LocationType(string='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>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.Job.LocationType.SFTP">
|
|||
|
|
<code class="sig-name descname">SFTP</code><em class="property"> = LocationType(string='SFTP')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.LocationType.SFTP" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Destination is SFTP server.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.Job.LocationType.SMB">
|
|||
|
|
<code class="sig-name descname">SMB</code><em class="property"> = LocationType(string='SMB')</em><a class="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
|
|||
|
|
6.7.2.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.Job.ReturnResult">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">ReturnResult</code><span class="sig-paren">(</span><em class="sig-param">status=None</em>, <em class="sig-param">messages=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.ReturnResult" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Job.ReturnResult</span></code> class contains the result information for the
|
|||
|
|
cancel operation.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Job.ReturnStatus</span></code></a>) – Status of the cancel operation.</p></li>
|
|||
|
|
<li><p><strong>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.Job.LocalizableMessage" title="com.vmware.appliance.recovery.backup_client.Job.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">Job.LocalizableMessage</span></code></a>) – List of messages.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.Job.ReturnStatus">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">ReturnStatus</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.ReturnStatus" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="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 <a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.Job.ReturnResult" title="com.vmware.appliance.recovery.backup_client.Job.ReturnResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">Job.ReturnResult</span></code></a>.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="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 <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">ReturnStatus</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.Job.ReturnStatus.FAIL">
|
|||
|
|
<code class="sig-name descname">FAIL</code><em class="property"> = ReturnStatus(string='FAIL')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.ReturnStatus.FAIL" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Cancel operation failed.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.Job.ReturnStatus.OK">
|
|||
|
|
<code class="sig-name descname">OK</code><em class="property"> = ReturnStatus(string='OK')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.ReturnStatus.OK" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Cancel operation succeeded.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.Job.ReturnStatus.WARNING">
|
|||
|
|
<code class="sig-name descname">WARNING</code><em class="property"> = ReturnStatus(string='WARNING')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.ReturnStatus.WARNING" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Cancel operation passed with warnings.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.Job.cancel">
|
|||
|
|
<code class="sig-name descname">cancel</code><span class="sig-paren">(</span><em class="sig-param">id</em><span class="sig-paren">)</span><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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – ID (ID of job)
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.backup.job</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.Job.ReturnResult" title="com.vmware.appliance.recovery.backup_client.Job.ReturnResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">Job.ReturnResult</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>BackupJobStatus Structure</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if backup associated with id does not exist.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if any error occurs during the execution of the operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.Job.create">
|
|||
|
|
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param">piece</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Job.create" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Initiate backup.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Job.BackupRequest</span></code></a>) – BackupRequest Structure</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.Job.BackupJobStatus" title="com.vmware.appliance.recovery.backup_client.Job.BackupJobStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">Job.BackupJobStatus</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>BackupJobStatus Structure</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.FeatureInUse</span></code></a>
|
|||
|
|
A backup or restore is already in progress.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if any error occurs during the execution of the operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.Job.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">id</em><span class="sig-paren">)</span><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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – ID (ID of job)
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.backup.job</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.Job.BackupJobStatus" title="com.vmware.appliance.recovery.backup_client.Job.BackupJobStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">Job.BackupJobStatus</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>BackupJobStatus Structure</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if backup associated with id does not exist.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if any error occurs during the execution of the operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.Job.list">
|
|||
|
|
<code class="sig-name descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.Job.list" title="com.vmware.appliance.recovery.backup_client.Job.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Returns</dt>
|
|||
|
|
<dd class="field-even"><p>list of BackupJob IDs
|
|||
|
|
The return value will contain identifiers for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.backup.job</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if any error occurs during the execution of the operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.LocationSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.recovery.backup_client.</code><code class="sig-name descname">LocationSpec</code><span class="sig-paren">(</span><em class="sig-param">location=None</em>, <em class="sig-param">location_user=None</em>, <em class="sig-param">location_password=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.LocationSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="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>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>location</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Backup location URL. This attribute was added in vSphere API 6.7.</p></li>
|
|||
|
|
<li><p><strong>location_user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="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.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.Parts">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.recovery.backup_client.</code><code class="sig-name descname">Parts</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Parts" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p><code class="docutils literal notranslate"><span class="pre">Parts</span></code> class provides methods Provides list of parts optional for the
|
|||
|
|
backup</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.Parts.LocalizableMessage">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">LocalizableMessage</code><span class="sig-paren">(</span><em class="sig-param">id=None</em>, <em class="sig-param">default_message=None</em>, <em class="sig-param">args=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Parts.LocalizableMessage" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p><code class="docutils literal notranslate"><span class="pre">Parts.LocalizableMessage</span></code> class Structure representing message</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – id in message bundle</p></li>
|
|||
|
|
<li><p><strong>default_message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – text in english</p></li>
|
|||
|
|
<li><p><strong>args</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – nested data</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.Parts.Part">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Part</code><span class="sig-paren">(</span><em class="sig-param">id=None</em>, <em class="sig-param">name=None</em>, <em class="sig-param">description=None</em>, <em class="sig-param">selected_by_default=None</em>, <em class="sig-param">optional=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Parts.Part" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p><code class="docutils literal notranslate"><span class="pre">Parts.Part</span></code> class Structure representing backup restore part</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – part ID
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.backup.parts</span></code>. When methods return
|
|||
|
|
a value of this class as a return value, the attribute will be an
|
|||
|
|
identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.backup.parts</span></code>.</p></li>
|
|||
|
|
<li><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Parts.LocalizableMessage</span></code></a>) – part name id in message bundle</p></li>
|
|||
|
|
<li><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Parts.LocalizableMessage</span></code></a>) – part description id in message bundle</p></li>
|
|||
|
|
<li><p><strong>selected_by_default</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Is this part selected by default in the user interface.</p></li>
|
|||
|
|
<li><p><strong>optional</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Is this part optional.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.Parts.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">id</em><span class="sig-paren">)</span><a class="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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the part.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.backup.parts</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>long Size of the part in megabytes.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if any error occurs during the execution of the operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.Parts.list">
|
|||
|
|
<code class="sig-name descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Parts.list" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Gets a list of the backup parts.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.Parts.list" title="com.vmware.appliance.recovery.backup_client.Parts.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.Parts.Part" title="com.vmware.appliance.recovery.backup_client.Parts.Part"><code class="xref py py-class docutils literal notranslate"><span class="pre">Parts.Part</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Returns</dt>
|
|||
|
|
<dd class="field-even"><p>Information about each of the backup parts.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if any error occurs during the execution of the operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.Schedules">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.recovery.backup_client.</code><code class="sig-name descname">Schedules</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Schedules" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Schedules</span></code> class provides methods to be performed to manage backup
|
|||
|
|
schedules. This class was added in vSphere API 6.7.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.Schedules.CreateSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">CreateSpec</code><span class="sig-paren">(</span><em class="sig-param">parts=None</em>, <em class="sig-param">backup_password=None</em>, <em class="sig-param">location=None</em>, <em class="sig-param">location_user=None</em>, <em class="sig-param">location_password=None</em>, <em class="sig-param">enable=None</em>, <em class="sig-param">recurrence_info=None</em>, <em class="sig-param">retention_info=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Schedules.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="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>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>parts</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of optional parts to be backed up. Use the <a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.Parts.list" title="com.vmware.appliance.recovery.backup_client.Parts.list"><code class="xref py py-func docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.Schedules.RecurrenceInfo" title="com.vmware.appliance.recovery.backup_client.Schedules.RecurrenceInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Schedules.RecurrenceInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Recurrence information for the schedule. This attribute was added
|
|||
|
|
in vSphere API 6.7.
|
|||
|
|
If None backup job will not be scheduled. See
|
|||
|
|
<a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.Schedules.RecurrenceInfo" title="com.vmware.appliance.recovery.backup_client.Schedules.RecurrenceInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Schedules.RecurrenceInfo</span></code></a></p></li>
|
|||
|
|
<li><p><strong>retention_info</strong> (<a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.Schedules.RetentionInfo" title="com.vmware.appliance.recovery.backup_client.Schedules.RetentionInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Schedules.RetentionInfo</span></code></a> or <code class="docutils literal notranslate"><span class="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
|
|||
|
|
<a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.Schedules.RetentionInfo" title="com.vmware.appliance.recovery.backup_client.Schedules.RetentionInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Schedules.RetentionInfo</span></code></a></p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.Schedules.DayOfWeek">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">DayOfWeek</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Schedules.DayOfWeek" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="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
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Schedules.RecurrenceInfo.days</span></code>. This enumeration was added in
|
|||
|
|
vSphere API 6.7.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="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 <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">DayOfWeek</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.Schedules.DayOfWeek.FRIDAY">
|
|||
|
|
<code class="sig-name descname">FRIDAY</code><em class="property"> = DayOfWeek(string='FRIDAY')</em><a class="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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.Schedules.DayOfWeek.MONDAY">
|
|||
|
|
<code class="sig-name descname">MONDAY</code><em class="property"> = DayOfWeek(string='MONDAY')</em><a class="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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.Schedules.DayOfWeek.SATURDAY">
|
|||
|
|
<code class="sig-name descname">SATURDAY</code><em class="property"> = DayOfWeek(string='SATURDAY')</em><a class="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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.Schedules.DayOfWeek.SUNDAY">
|
|||
|
|
<code class="sig-name descname">SUNDAY</code><em class="property"> = DayOfWeek(string='SUNDAY')</em><a class="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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.Schedules.DayOfWeek.THURSDAY">
|
|||
|
|
<code class="sig-name descname">THURSDAY</code><em class="property"> = DayOfWeek(string='THURSDAY')</em><a class="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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.Schedules.DayOfWeek.TUESDAY">
|
|||
|
|
<code class="sig-name descname">TUESDAY</code><em class="property"> = DayOfWeek(string='TUESDAY')</em><a class="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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.Schedules.DayOfWeek.WEDNESDAY">
|
|||
|
|
<code class="sig-name descname">WEDNESDAY</code><em class="property"> = DayOfWeek(string='WEDNESDAY')</em><a class="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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.Schedules.Info">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">parts=None</em>, <em class="sig-param">location=None</em>, <em class="sig-param">location_user=None</em>, <em class="sig-param">enable=None</em>, <em class="sig-param">recurrence_info=None</em>, <em class="sig-param">retention_info=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Schedules.Info" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="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>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>parts</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – List of optional parts that will be included in backups based on
|
|||
|
|
this schedule details. Use the <a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.Parts.list" title="com.vmware.appliance.recovery.backup_client.Parts.list"><code class="xref py py-func docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.Schedules.RecurrenceInfo" title="com.vmware.appliance.recovery.backup_client.Schedules.RecurrenceInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Schedules.RecurrenceInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Recurrence information for the schedule. This attribute was added
|
|||
|
|
in vSphere API 6.7.
|
|||
|
|
If None backup job is not scheduled. See
|
|||
|
|
<a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.Schedules.RecurrenceInfo" title="com.vmware.appliance.recovery.backup_client.Schedules.RecurrenceInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Schedules.RecurrenceInfo</span></code></a></p></li>
|
|||
|
|
<li><p><strong>retention_info</strong> (<a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.Schedules.RetentionInfo" title="com.vmware.appliance.recovery.backup_client.Schedules.RetentionInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Schedules.RetentionInfo</span></code></a> or <code class="docutils literal notranslate"><span class="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
|
|||
|
|
<a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.Schedules.RetentionInfo" title="com.vmware.appliance.recovery.backup_client.Schedules.RetentionInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Schedules.RetentionInfo</span></code></a></p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.Schedules.RecurrenceInfo">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">RecurrenceInfo</code><span class="sig-paren">(</span><em class="sig-param">minute=None</em>, <em class="sig-param">hour=None</em>, <em class="sig-param">days=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Schedules.RecurrenceInfo" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Schedules.RecurrenceInfo</span></code> class contains the recurrence information
|
|||
|
|
associated with a schedule. This class was added in vSphere API 6.7.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>minute</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.Schedules.DayOfWeek" title="com.vmware.appliance.recovery.backup_client.Schedules.DayOfWeek"><code class="xref py py-class docutils literal notranslate"><span class="pre">Schedules.DayOfWeek</span></code></a> or <code class="docutils literal notranslate"><span class="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.
|
|||
|
|
If None the backup will be run everyday.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.Schedules.RetentionInfo">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">RetentionInfo</code><span class="sig-paren">(</span><em class="sig-param">max_count=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Schedules.RetentionInfo" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Schedules.RetentionInfo</span></code> class contains retention information
|
|||
|
|
associated with a schedule. This class was added in vSphere API 6.7.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>max_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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
|
|||
|
|
added in vSphere API 6.7.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.Schedules.UpdateSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">UpdateSpec</code><span class="sig-paren">(</span><em class="sig-param">parts=None</em>, <em class="sig-param">backup_password=None</em>, <em class="sig-param">location=None</em>, <em class="sig-param">location_user=None</em>, <em class="sig-param">location_password=None</em>, <em class="sig-param">enable=None</em>, <em class="sig-param">recurrence_info=None</em>, <em class="sig-param">retention_info=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.Schedules.UpdateSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="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>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>parts</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of optional parts. Use the <a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.Parts.list" title="com.vmware.appliance.recovery.backup_client.Parts.list"><code class="xref py py-func docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.Schedules.RecurrenceInfo" title="com.vmware.appliance.recovery.backup_client.Schedules.RecurrenceInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Schedules.RecurrenceInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Recurrence information for the schedule. This attribute was added
|
|||
|
|
in vSphere API 6.7.
|
|||
|
|
If None the infomration will not be changed. See
|
|||
|
|
<a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.Schedules.RecurrenceInfo" title="com.vmware.appliance.recovery.backup_client.Schedules.RecurrenceInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Schedules.RecurrenceInfo</span></code></a></p></li>
|
|||
|
|
<li><p><strong>retention_info</strong> (<a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.Schedules.RetentionInfo" title="com.vmware.appliance.recovery.backup_client.Schedules.RetentionInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Schedules.RetentionInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Retention information for the schedule. This attribute was added in
|
|||
|
|
vSphere API 6.7.
|
|||
|
|
If None the information will not be changed. See
|
|||
|
|
<a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.Schedules.RetentionInfo" title="com.vmware.appliance.recovery.backup_client.Schedules.RetentionInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Schedules.RetentionInfo</span></code></a></p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.Schedules.create">
|
|||
|
|
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param">schedule</em>, <em class="sig-param">spec</em><span class="sig-paren">)</span><a class="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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>schedule</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the schedule
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.backup.schedule</span></code>.</p></li>
|
|||
|
|
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.Schedules.CreateSpec" title="com.vmware.appliance.recovery.backup_client.Schedules.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Schedules.CreateSpec</span></code></a>) – CreateSpec Structure</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if provided with invalid schedule specification.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
|
|||
|
|
if the schedule with the given id already exists.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if any error occurs during the execution of the operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.Schedules.delete">
|
|||
|
|
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param">schedule</em><span class="sig-paren">)</span><a class="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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>schedule</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the schedule
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.backup.schedule</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if schedule associated with id does not exist.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if any error occurs during the execution of the operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.Schedules.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">schedule</em><span class="sig-paren">)</span><a class="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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>schedule</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the schedule
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.backup.schedule</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.Schedules.Info" title="com.vmware.appliance.recovery.backup_client.Schedules.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Schedules.Info</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>Info Structure</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if schedule associated with id does not exist.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if any error occurs during the execution of the operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.Schedules.list">
|
|||
|
|
<code class="sig-name descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="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
|
|||
|
|
added in vSphere API 6.7.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type</dt>
|
|||
|
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.Schedules.Info" title="com.vmware.appliance.recovery.backup_client.Schedules.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Schedules.Info</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Returns</dt>
|
|||
|
|
<dd class="field-even"><p>Map of schedule id to Info Structure
|
|||
|
|
The key in the return value <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for
|
|||
|
|
the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.backup.schedule</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if any error occurs during the execution of the operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.Schedules.run">
|
|||
|
|
<code class="sig-name descname">run</code><span class="sig-paren">(</span><em class="sig-param">schedule</em>, <em class="sig-param">comment=None</em><span class="sig-paren">)</span><a class="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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>schedule</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the schedule
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.backup.schedule</span></code>.</p></li>
|
|||
|
|
<li><p><strong>comment</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – field that specifies the description for the backup.
|
|||
|
|
If None the backup will have an empty comment.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.Job.BackupJobStatus" title="com.vmware.appliance.recovery.backup_client.Job.BackupJobStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">Job.BackupJobStatus</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>BackupJobStatus Structure</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.FeatureInUse</span></code></a>
|
|||
|
|
if a backup or restore is already in progress.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if schedule associated with id does not exist.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if any error occurs during the execution of the operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.Schedules.update">
|
|||
|
|
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">schedule</em>, <em class="sig-param">spec</em><span class="sig-paren">)</span><a class="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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>schedule</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the schedule
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.backup.schedule</span></code>.</p></li>
|
|||
|
|
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.Schedules.UpdateSpec" title="com.vmware.appliance.recovery.backup_client.Schedules.UpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Schedules.UpdateSpec</span></code></a>) – UpdateSpec Structure</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if provided with invalid schedule specification.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if schedule associated with id does not exist.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if any error occurs during the execution of the operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.StubFactory">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.recovery.backup_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
|||
|
|
<p>Initialize StubFactoryBase</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.SystemName">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.recovery.backup_client.</code><code class="sig-name descname">SystemName</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.backup_client.SystemName" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">SystemName</span></code> class provides methods to enumerate system names of
|
|||
|
|
appliance backups. This class was added in vSphere API 6.7.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.backup_client.SystemName.list">
|
|||
|
|
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">loc_spec</em><span class="sig-paren">)</span><a class="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
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">loc_spec</span></code>. This method was added in vSphere API 6.7.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>loc_spec</strong> (<a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.LocationSpec" title="com.vmware.appliance.recovery.backup_client.LocationSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LocationSpec</span></code></a>) – LocationSpec Structure</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.appliance.recovery.backup_client.SystemName.list" title="com.vmware.appliance.recovery.backup_client.SystemName.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>list of system names
|
|||
|
|
The return value will contain identifiers for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.backup.system_name</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">loc_spec</span></code> doesn’t refer to an existing location on the backup
|
|||
|
|
server.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if any error occurs during the execution of the operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div class="section" id="module-com.vmware.appliance.recovery.reconciliation_client">
|
|||
|
|
<span id="com-vmware-appliance-recovery-reconciliation-client-module"></span><h2>com.vmware.appliance.recovery.reconciliation_client module<a class="headerlink" href="#module-com.vmware.appliance.recovery.reconciliation_client" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.reconciliation_client.Job">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.recovery.reconciliation_client.</code><code class="sig-name descname">Job</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.reconciliation_client.Job" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.reconciliation_client.Job.CreateSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">CreateSpec</code><span class="sig-paren">(</span><em class="sig-param">sso_admin_user_name=None</em>, <em class="sig-param">sso_admin_user_password=None</em>, <em class="sig-param">ignore_warnings=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.reconciliation_client.Job.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="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>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>sso_admin_user_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="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
|
|||
|
|
operation.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.reconciliation_client.Job.Info">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">description=None</em>, <em class="sig-param">service=None</em>, <em class="sig-param">operation=None</em>, <em class="sig-param">parent=None</em>, <em class="sig-param">target=None</em>, <em class="sig-param">status=None</em>, <em class="sig-param">cancelable=None</em>, <em class="sig-param">error=None</em>, <em class="sig-param">start_time=None</em>, <em class="sig-param">end_time=None</em>, <em class="sig-param">messages=None</em>, <em class="sig-param">progress=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.reconciliation_client.Job.Info" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="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>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>description</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.reconciliation.job</span></code>. When methods
|
|||
|
|
return a value of this class as a return value, the attribute will
|
|||
|
|
be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.reconciliation.job</span></code>.</p></li>
|
|||
|
|
<li><p><strong>operation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="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:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.reconciliation.job</span></code>. When methods
|
|||
|
|
return a value of this class as a return value, the attribute will
|
|||
|
|
be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.recovery.reconciliation.job</span></code>.
|
|||
|
|
This attribute will be None if the task has no parent.</p></li>
|
|||
|
|
<li><p><strong>target</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> or <code class="docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.appliance.recovery.reconciliation_client.Job.Status" title="com.vmware.appliance.recovery.reconciliation_client.Job.Status"><code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code> or <code class="docutils literal notranslate"><span class="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 null).</p></li>
|
|||
|
|
<li><p><strong>start_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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 <code class="docutils literal notranslate"><span class="pre">status</span></code> is one of <a class="reference internal" href="#com.vmware.appliance.recovery.reconciliation_client.Job.Status.RUNNING" title="com.vmware.appliance.recovery.reconciliation_client.Job.Status.RUNNING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Job.Status.RUNNING</span></code></a>,
|
|||
|
|
<a class="reference internal" href="#com.vmware.appliance.recovery.reconciliation_client.Job.Status.SUCCEEDED" title="com.vmware.appliance.recovery.reconciliation_client.Job.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Job.Status.SUCCEEDED</span></code></a>, or <a class="reference internal" href="#com.vmware.appliance.recovery.reconciliation_client.Job.Status.FAILED" title="com.vmware.appliance.recovery.reconciliation_client.Job.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Job.Status.FAILED</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>end_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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 <code class="docutils literal notranslate"><span class="pre">status</span></code> is one of <a class="reference internal" href="#com.vmware.appliance.recovery.reconciliation_client.Job.Status.SUCCEEDED" title="com.vmware.appliance.recovery.reconciliation_client.Job.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Job.Status.SUCCEEDED</span></code></a> or
|
|||
|
|
<a class="reference internal" href="#com.vmware.appliance.recovery.reconciliation_client.Job.Status.FAILED" title="com.vmware.appliance.recovery.reconciliation_client.Job.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Job.Status.FAILED</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The progress of the job as a percentage. This attribute was added
|
|||
|
|
in vSphere API 6.7.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.reconciliation_client.Job.Status">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Status</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.reconciliation_client.Job.Status" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="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>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="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 <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Status</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.reconciliation_client.Job.Status.FAILED">
|
|||
|
|
<code class="sig-name descname">FAILED</code><em class="property"> = Status(string='FAILED')</em><a class="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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.reconciliation_client.Job.Status.NONE">
|
|||
|
|
<code class="sig-name descname">NONE</code><em class="property"> = Status(string='NONE')</em><a class="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
|
|||
|
|
6.7.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.reconciliation_client.Job.Status.RUNNING">
|
|||
|
|
<code class="sig-name descname">RUNNING</code><em class="property"> = Status(string='RUNNING')</em><a class="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
|
|||
|
|
6.7.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.reconciliation_client.Job.Status.SUCCEEDED">
|
|||
|
|
<code class="sig-name descname">SUCCEEDED</code><em class="property"> = Status(string='SUCCEEDED')</em><a class="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
|
|||
|
|
vSphere API 6.7.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.reconciliation_client.Job.create">
|
|||
|
|
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param">spec</em><span class="sig-paren">)</span><a class="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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.appliance.recovery.reconciliation_client.Job.CreateSpec" title="com.vmware.appliance.recovery.reconciliation_client.Job.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Job.CreateSpec</span></code></a>) – CreateSpec Structure</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.appliance.recovery.reconciliation_client.Job.Info" title="com.vmware.appliance.recovery.reconciliation_client.Job.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Job.Info</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>Info Structure</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.FeatureInUse</span></code></a>
|
|||
|
|
A backup or restore is already in progress.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
Reconciliation is allowed only after restore has finished
|
|||
|
|
successfully.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if any error occurs during the execution of the operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.reconciliation_client.Job.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="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
|
|||
|
|
vSphere API 6.7.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.appliance.recovery.reconciliation_client.Job.Info" title="com.vmware.appliance.recovery.reconciliation_client.Job.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Job.Info</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Returns</dt>
|
|||
|
|
<dd class="field-even"><p>Info Structure</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if there is no running reconciliation job.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if any error occurs during the execution of the operation.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.reconciliation_client.StubFactory">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.recovery.reconciliation_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.reconciliation_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
|||
|
|
<p>Initialize StubFactoryBase</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div class="section" id="module-com.vmware.appliance.recovery.restore_client">
|
|||
|
|
<span id="com-vmware-appliance-recovery-restore-client-module"></span><h2>com.vmware.appliance.recovery.restore_client 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><code class="sig-prename descclassname">com.vmware.appliance.recovery.restore_client.</code><code class="sig-name descname">Job</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p><code class="docutils literal notranslate"><span class="pre">Job</span></code> class provides methods Performs restore operations</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.restore_client.Job.BackupRestoreProcessState">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">BackupRestoreProcessState</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.BackupRestoreProcessState" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p><code class="docutils literal notranslate"><span class="pre">Job.BackupRestoreProcessState</span></code> class Defines state of backup/restore
|
|||
|
|
process</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="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 <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">BackupRestoreProcessState</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.restore_client.Job.BackupRestoreProcessState.FAILED">
|
|||
|
|
<code class="sig-name descname">FAILED</code><em class="property"> = BackupRestoreProcessState(string='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">
|
|||
|
|
<code class="sig-name descname">INPROGRESS</code><em class="property"> = BackupRestoreProcessState(string='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">
|
|||
|
|
<code class="sig-name descname">NONE</code><em class="property"> = BackupRestoreProcessState(string='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">
|
|||
|
|
<code class="sig-name descname">SUCCEEDED</code><em class="property"> = BackupRestoreProcessState(string='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><code class="sig-name descname">LocalizableMessage</code><span class="sig-paren">(</span><em class="sig-param">id=None</em>, <em class="sig-param">default_message=None</em>, <em class="sig-param">args=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.LocalizableMessage" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p><code class="docutils literal notranslate"><span class="pre">Job.LocalizableMessage</span></code> class Structure representing message</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – id in message bundle</p></li>
|
|||
|
|
<li><p><strong>default_message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – text in english</p></li>
|
|||
|
|
<li><p><strong>args</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – nested data</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.restore_client.Job.LocationType">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">LocationType</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.LocationType" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p><code class="docutils literal notranslate"><span class="pre">Job.LocationType</span></code> class Defines type of all locations for backup/restore</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="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 <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">LocationType</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.restore_client.Job.LocationType.FTP">
|
|||
|
|
<code class="sig-name descname">FTP</code><em class="property"> = LocationType(string='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">
|
|||
|
|
<code class="sig-name descname">FTPS</code><em class="property"> = LocationType(string='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">
|
|||
|
|
<code class="sig-name descname">HTTP</code><em class="property"> = LocationType(string='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">
|
|||
|
|
<code class="sig-name descname">HTTPS</code><em class="property"> = LocationType(string='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.NFS">
|
|||
|
|
<code class="sig-name descname">NFS</code><em class="property"> = LocationType(string='NFS')</em><a class="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
|
|||
|
|
6.7.2.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.restore_client.Job.LocationType.SCP">
|
|||
|
|
<code class="sig-name descname">SCP</code><em class="property"> = LocationType(string='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>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.restore_client.Job.LocationType.SFTP">
|
|||
|
|
<code class="sig-name descname">SFTP</code><em class="property"> = LocationType(string='SFTP')</em><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.LocationType.SFTP" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Destination is SFTP server</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.restore_client.Job.LocationType.SMB">
|
|||
|
|
<code class="sig-name descname">SMB</code><em class="property"> = LocationType(string='SMB')</em><a class="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
|
|||
|
|
6.7.2.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.restore_client.Job.RestoreJobStatus">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">RestoreJobStatus</code><span class="sig-paren">(</span><em class="sig-param">state=None</em>, <em class="sig-param">messages=None</em>, <em class="sig-param">progress=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.RestoreJobStatus" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p><code class="docutils literal notranslate"><span class="pre">Job.RestoreJobStatus</span></code> class Structure representing backup restore status</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Job.BackupRestoreProcessState</span></code></a>) – process state</p></li>
|
|||
|
|
<li><p><strong>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.appliance.recovery.restore_client.Job.LocalizableMessage" title="com.vmware.appliance.recovery.restore_client.Job.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">Job.LocalizableMessage</span></code></a>) – list of messages</p></li>
|
|||
|
|
<li><p><strong>progress</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – percentage complete</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.restore_client.Job.RestoreRequest">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">RestoreRequest</code><span class="sig-paren">(</span><em class="sig-param">backup_password=None</em>, <em class="sig-param">location_type=None</em>, <em class="sig-param">location=None</em>, <em class="sig-param">location_user=None</em>, <em class="sig-param">location_password=None</em>, <em class="sig-param">sso_admin_user_name=None</em>, <em class="sig-param">sso_admin_user_password=None</em>, <em class="sig-param">ignore_warnings=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.RestoreRequest" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p><code class="docutils literal notranslate"><span class="pre">Job.RestoreRequest</span></code> class Structure representing requested restore piece</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>backup_password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="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> (<a class="reference internal" href="#com.vmware.appliance.recovery.restore_client.Job.LocationType" title="com.vmware.appliance.recovery.restore_client.Job.LocationType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Job.LocationType</span></code></a>) – a type of location</p></li>
|
|||
|
|
<li><p><strong>location</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – path or url</p></li>
|
|||
|
|
<li><p><strong>location_user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="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>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.restore_client.Job.ReturnResult">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">ReturnResult</code><span class="sig-paren">(</span><em class="sig-param">status=None</em>, <em class="sig-param">messages=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.ReturnResult" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p><code class="docutils literal notranslate"><span class="pre">Job.ReturnResult</span></code> class Structure representing precheck result</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Job.ReturnStatus</span></code></a>) – Check status</p></li>
|
|||
|
|
<li><p><strong>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.appliance.recovery.restore_client.Job.LocalizableMessage" title="com.vmware.appliance.recovery.restore_client.Job.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">Job.LocalizableMessage</span></code></a>) – List of messages</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.restore_client.Job.ReturnStatus">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">ReturnStatus</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.ReturnStatus" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p><code class="docutils literal notranslate"><span class="pre">Job.ReturnStatus</span></code> class Defines the state of precheck</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="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 <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">ReturnStatus</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.restore_client.Job.ReturnStatus.FAIL">
|
|||
|
|
<code class="sig-name descname">FAIL</code><em class="property"> = ReturnStatus(string='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">
|
|||
|
|
<code class="sig-name descname">OK</code><em class="property"> = ReturnStatus(string='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">
|
|||
|
|
<code class="sig-name descname">WARNING</code><em class="property"> = ReturnStatus(string='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">
|
|||
|
|
<code class="sig-name descname">cancel</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.cancel" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Cancel the restore job</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.appliance.recovery.restore_client.Job.ReturnResult" title="com.vmware.appliance.recovery.restore_client.Job.ReturnResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">Job.ReturnResult</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Returns</dt>
|
|||
|
|
<dd class="field-even"><p>RestoreJobStatus Structure</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
Generic error</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.restore_client.Job.create">
|
|||
|
|
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param">piece</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.Job.create" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Initiate restore.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Job.RestoreRequest</span></code></a>) – RestoreRequest Structure</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.appliance.recovery.restore_client.Job.RestoreJobStatus" title="com.vmware.appliance.recovery.restore_client.Job.RestoreJobStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">Job.RestoreJobStatus</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>RestoreJobStatus Structure</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.FeatureInUse</span></code></a>
|
|||
|
|
A backup or restore is already in progress</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
Restore is allowed only after deployment and before firstboot</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
Generic error</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.restore_client.Job.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><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>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.appliance.recovery.restore_client.Job.RestoreJobStatus" title="com.vmware.appliance.recovery.restore_client.Job.RestoreJobStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">Job.RestoreJobStatus</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Returns</dt>
|
|||
|
|
<dd class="field-even"><p>RestoreJobStatus Structure</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><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"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
Generic error</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.appliance.recovery.restore_client.StubFactory">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.appliance.recovery.restore_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.recovery.restore_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
|||
|
|
<p>Initialize StubFactoryBase</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<footer>
|
|||
|
|
|
|||
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|||
|
|
|
|||
|
|
<a href="com.vmware.appliance.recovery.backup.html" class="btn btn-neutral float-right" title="com.vmware.appliance.recovery.backup package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a href="com.vmware.appliance.networking.html" class="btn btn-neutral float-left" title="com.vmware.appliance.networking package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<hr/>
|
|||
|
|
|
|||
|
|
<div role="contentinfo">
|
|||
|
|
<p>
|
|||
|
|
© Copyright 2019, VMware, Inc.
|
|||
|
|
|
|||
|
|
</p>
|
|||
|
|
</div>
|
|||
|
|
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|||
|
|
|
|||
|
|
</footer>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
</section>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script type="text/javascript">
|
|||
|
|
jQuery(function () {
|
|||
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|||
|
|
});
|
|||
|
|
</script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</body>
|
|||
|
|
</html>
|