mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-22 09:39:58 -05:00
490 lines
32 KiB
HTML
490 lines
32 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
|
|
||
|
|
|
||
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||
|
|
|
||
|
|
<title>com.vmware.appliance.recovery.backup package — vSphere Automation SDK for Python 6.5.0 documentation</title>
|
||
|
|
|
||
|
|
<link rel="stylesheet" href="_static/vapitheme.css" type="text/css" />
|
||
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||
|
|
|
||
|
|
<script type="text/javascript">
|
||
|
|
var DOCUMENTATION_OPTIONS = {
|
||
|
|
URL_ROOT: './',
|
||
|
|
VERSION: '6.5.0',
|
||
|
|
COLLAPSE_INDEX: false,
|
||
|
|
FILE_SUFFIX: '.html',
|
||
|
|
HAS_SOURCE: true
|
||
|
|
};
|
||
|
|
</script>
|
||
|
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
||
|
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
||
|
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
||
|
|
<link rel="top" title="vSphere Automation SDK for Python 6.5.0 documentation" href="index.html" />
|
||
|
|
<link rel="up" title="com.vmware.appliance.recovery package" href="com.vmware.appliance.recovery.html" />
|
||
|
|
<link rel="next" title="com.vmware.appliance.techpreview package" href="com.vmware.appliance.techpreview.html" />
|
||
|
|
<link rel="prev" title="com.vmware.appliance.recovery package" href="com.vmware.appliance.recovery.html" />
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<div class="related">
|
||
|
|
<h3>Navigation</h3>
|
||
|
|
<ul>
|
||
|
|
<li class="right" style="margin-right: 10px">
|
||
|
|
<a href="genindex.html" title="General Index"
|
||
|
|
accesskey="I">index</a></li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="py-modindex.html" title="Python Module Index"
|
||
|
|
>modules</a> |</li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="com.vmware.appliance.techpreview.html" title="com.vmware.appliance.techpreview package"
|
||
|
|
accesskey="N">next</a> |</li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="com.vmware.appliance.recovery.html" title="com.vmware.appliance.recovery package"
|
||
|
|
accesskey="P">previous</a> |</li>
|
||
|
|
<li><a href="index.html">vSphere Automation SDK for Python 6.5.0 documentation</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><a href="com.vmware.appliance.recovery.html" accesskey="U">com.vmware.appliance.recovery package</a> »</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="document">
|
||
|
|
<div class="documentwrapper">
|
||
|
|
<div class="bodywrapper">
|
||
|
|
<div class="body">
|
||
|
|
|
||
|
|
<div class="section" id="com-vmware-appliance-recovery-backup-package">
|
||
|
|
<h1>com.vmware.appliance.recovery.backup package<a class="headerlink" href="#com-vmware-appliance-recovery-backup-package" title="Permalink to this headline">¶</a></h1>
|
||
|
|
<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.job_client">
|
||
|
|
<span id="com-vmware-appliance-recovery-backup-job-client-module"></span><h2>com.vmware.appliance.recovery.backup.job_client module<a class="headerlink" href="#module-com.vmware.appliance.recovery.backup.job_client" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.recovery.backup.job_client.Details">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.appliance.recovery.backup.job_client.</tt><tt class="descname">Details</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.recovery.backup.job_client.Details" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Details</span></tt> class provides methods to get the details about backup
|
||
|
|
jobs.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.recovery.backup.job_client.Details.Info">
|
||
|
|
<em class="property">class </em><tt class="descname">Info</tt><big>(</big><em>state=None</em>, <em>location=None</em>, <em>start_time=None</em>, <em>end_time=None</em>, <em>duration=None</em>, <em>progress=None</em>, <em>size=None</em>, <em>user=None</em>, <em>messages=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.recovery.backup.job_client.Details.Info" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Details.Info</span></tt> class contains information about a backup job.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>state</strong> (<a class="reference internal" href="com.vmware.appliance.recovery.html#com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState" title="com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.appliance.recovery.backup_client.Job.BackupRestoreProcessState</span></tt></a>) – The state of the backup job.</li>
|
||
|
|
<li><strong>location</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – URL of the backup location.</li>
|
||
|
|
<li><strong>start_time</strong> (<tt class="xref py py-class docutils literal"><span class="pre">datetime.datetime</span></tt>) – Time when the backup job was started.</li>
|
||
|
|
<li><strong>end_time</strong> (<tt class="xref py py-class docutils literal"><span class="pre">datetime.datetime</span></tt>) – Time when the backup job was finished.
|
||
|
|
This attribute is optional and it is only relevant when the value
|
||
|
|
of <tt class="docutils literal"><span class="pre">state</span></tt> is one of null or null.</li>
|
||
|
|
<li><strong>duration</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – Time in seconds it took to complete the backup job.</li>
|
||
|
|
<li><strong>progress</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – Progress of the job in percentage.</li>
|
||
|
|
<li><strong>size</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – Size of the backup.
|
||
|
|
This attribute is optional and it is only relevant when the value
|
||
|
|
of <tt class="docutils literal"><span class="pre">state</span></tt> is null.</li>
|
||
|
|
<li><strong>user</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The username for the remote backup location.</li>
|
||
|
|
<li><strong>messages</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></tt></a>) – List of any info/warning/error messages returned by the backup job.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.appliance.recovery.backup.job_client.Details.list">
|
||
|
|
<tt class="descclassname">Details.</tt><tt class="descname">list</tt><big>(</big><big>)</big><a class="headerlink" href="#com.vmware.appliance.recovery.backup.job_client.Details.list" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns detailed information about the current and historical backup
|
||
|
|
jobs.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> and <a class="reference internal" href="#com.vmware.appliance.recovery.backup.job_client.Details.Info" title="com.vmware.appliance.recovery.backup.job_client.Details.Info"><tt class="xref py py-class docutils literal"><span class="pre">Details.Info</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Map of backup job id to Info Structure.
|
||
|
|
The key in the return value <tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt> will be an identifier for
|
||
|
|
the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.appliance.recovery.backup.job.details</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if any error occurs during the execution of the operation.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="section" id="module-com.vmware.appliance.recovery.backup.profile_client">
|
||
|
|
<span id="com-vmware-appliance-recovery-backup-profile-client-module"></span><h2>com.vmware.appliance.recovery.backup.profile_client module<a class="headerlink" href="#module-com.vmware.appliance.recovery.backup.profile_client" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.recovery.backup.profile_client.Retention">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.appliance.recovery.backup.profile_client.</tt><tt class="descname">Retention</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.recovery.backup.profile_client.Retention" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Retention</span></tt> class provides methods to create and update the retention
|
||
|
|
policy for a backup profile.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.recovery.backup.profile_client.Retention.Info">
|
||
|
|
<em class="property">class </em><tt class="descname">Info</tt><big>(</big><em>max_count=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.recovery.backup.profile_client.Retention.Info" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Retention.Info</span></tt> class contains retention information associated with
|
||
|
|
a profile.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>max_count</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – Number of backups which should be retained. If retention is mot
|
||
|
|
set, all the backups will be retained forever.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.appliance.recovery.backup.profile_client.Retention.get">
|
||
|
|
<tt class="descclassname">Retention.</tt><tt class="descname">get</tt><big>(</big><em>profile</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.recovery.backup.profile_client.Retention.get" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Gets the retention policy for a profile.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>profile</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the profile
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.appliance.recovery.backup.profile.retention</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.appliance.recovery.backup.profile_client.Retention.Info" title="com.vmware.appliance.recovery.backup.profile_client.Retention.Info"><tt class="xref py py-class docutils literal"><span class="pre">Retention.Info</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Info Structure</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if profile associated with id does not exist.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if any error occurs during the execution of the operation.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.appliance.recovery.backup.profile_client.Retention.set">
|
||
|
|
<tt class="descclassname">Retention.</tt><tt class="descname">set</tt><big>(</big><em>profile</em>, <em>info</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.recovery.backup.profile_client.Retention.set" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Updates a profile with the retention policy.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>profile</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the profile
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.appliance.recovery.backup.profile.retention</span></tt>.</li>
|
||
|
|
<li><strong>info</strong> (<a class="reference internal" href="#com.vmware.appliance.recovery.backup.profile_client.Retention.Info" title="com.vmware.appliance.recovery.backup.profile_client.Retention.Info"><tt class="xref py py-class docutils literal"><span class="pre">Retention.Info</span></tt></a>) – Info Structure</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if profile associated with id does not exist.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt>
|
||
|
|
if provided with invalid retention info.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if any error occurs during the execution of the operation.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.recovery.backup.profile_client.Schedule">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.appliance.recovery.backup.profile_client.</tt><tt class="descname">Schedule</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.recovery.backup.profile_client.Schedule" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Schedule</span></tt> class provides methods to create and update the schedule
|
||
|
|
policy for a backup profile.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) – Configuration to be used for creating the stub.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.recovery.backup.profile_client.Schedule.DayOfWeek">
|
||
|
|
<em class="property">class </em><tt class="descname">DayOfWeek</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.recovery.backup.profile_client.Schedule.DayOfWeek" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Schedule.DayOfWeek</span></tt> 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 schedule for a profile. See
|
||
|
|
<a class="reference internal" href="#com.vmware.appliance.recovery.backup.profile_client.Schedule.Info" title="com.vmware.appliance.recovery.backup.profile_client.Schedule.Info"><tt class="xref py py-class docutils literal"><span class="pre">Schedule.Info</span></tt></a>.</p>
|
||
|
|
<div class="admonition note">
|
||
|
|
<p class="first admonition-title">Note</p>
|
||
|
|
<p class="last">This class represents an enumerated type in the interface language
|
||
|
|
definition. The class contains class attributes which represent the
|
||
|
|
values in the current version of the enumerated type. Newer versions of
|
||
|
|
the enumerated type may contain new values. To use new values of the
|
||
|
|
enumerated type in communication with a server that supports the newer
|
||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
||
|
|
type description page</em></a>.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <tt class="xref py py-class docutils literal"><span class="pre">DayOfWeek</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.recovery.backup.profile_client.Schedule.DayOfWeek.FRIDAY">
|
||
|
|
<tt class="descname">FRIDAY</tt><em class="property"> = DayOfWeek(string=u'FRIDAY')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup.profile_client.Schedule.DayOfWeek.FRIDAY" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Friday</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.recovery.backup.profile_client.Schedule.DayOfWeek.MONDAY">
|
||
|
|
<tt class="descname">MONDAY</tt><em class="property"> = DayOfWeek(string=u'MONDAY')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup.profile_client.Schedule.DayOfWeek.MONDAY" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Monday</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.recovery.backup.profile_client.Schedule.DayOfWeek.SATURDAY">
|
||
|
|
<tt class="descname">SATURDAY</tt><em class="property"> = DayOfWeek(string=u'SATURDAY')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup.profile_client.Schedule.DayOfWeek.SATURDAY" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Saturday</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.recovery.backup.profile_client.Schedule.DayOfWeek.SUNDAY">
|
||
|
|
<tt class="descname">SUNDAY</tt><em class="property"> = DayOfWeek(string=u'SUNDAY')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup.profile_client.Schedule.DayOfWeek.SUNDAY" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Sunday</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.recovery.backup.profile_client.Schedule.DayOfWeek.THURSDAY">
|
||
|
|
<tt class="descname">THURSDAY</tt><em class="property"> = DayOfWeek(string=u'THURSDAY')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup.profile_client.Schedule.DayOfWeek.THURSDAY" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Thursday</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.recovery.backup.profile_client.Schedule.DayOfWeek.TUESDAY">
|
||
|
|
<tt class="descname">TUESDAY</tt><em class="property"> = DayOfWeek(string=u'TUESDAY')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup.profile_client.Schedule.DayOfWeek.TUESDAY" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Tuesday</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.appliance.recovery.backup.profile_client.Schedule.DayOfWeek.WEDNESDAY">
|
||
|
|
<tt class="descname">WEDNESDAY</tt><em class="property"> = DayOfWeek(string=u'WEDNESDAY')</em><a class="headerlink" href="#com.vmware.appliance.recovery.backup.profile_client.Schedule.DayOfWeek.WEDNESDAY" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Wednesday</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.appliance.recovery.backup.profile_client.Schedule.Info">
|
||
|
|
<em class="property">class </em><tt class="descclassname">Schedule.</tt><tt class="descname">Info</tt><big>(</big><em>minute=None</em>, <em>hour=None</em>, <em>days=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.recovery.backup.profile_client.Schedule.Info" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Schedule.Info</span></tt> class contains the schedule information associated
|
||
|
|
with a profile.</p>
|
||
|
|
<div class="admonition tip">
|
||
|
|
<p class="first admonition-title">Tip</p>
|
||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
||
|
|
names.</p>
|
||
|
|
</div>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>minute</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – Minute when backup should run.</li>
|
||
|
|
<li><strong>hour</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – Hour when backup should run. The hour should be specified in
|
||
|
|
24-hour clock format.</li>
|
||
|
|
<li><strong>days</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="#com.vmware.appliance.recovery.backup.profile_client.Schedule.DayOfWeek" title="com.vmware.appliance.recovery.backup.profile_client.Schedule.DayOfWeek"><tt class="xref py py-class docutils literal"><span class="pre">Schedule.DayOfWeek</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Day of week when the backup should be run. Days can be specified as
|
||
|
|
list of days.
|
||
|
|
If None the backup will be run everyday.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.appliance.recovery.backup.profile_client.Schedule.get">
|
||
|
|
<tt class="descclassname">Schedule.</tt><tt class="descname">get</tt><big>(</big><em>profile</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.recovery.backup.profile_client.Schedule.get" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Gets the scheduler policy for a profile.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>profile</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the profile
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.appliance.recovery.backup.profile.schedule</span></tt>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.appliance.recovery.backup.profile_client.Schedule.Info" title="com.vmware.appliance.recovery.backup.profile_client.Schedule.Info"><tt class="xref py py-class docutils literal"><span class="pre">Schedule.Info</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Info Structure</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if profile associated with id does not exist.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if any error occurs during the execution of the operation.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.appliance.recovery.backup.profile_client.Schedule.set">
|
||
|
|
<tt class="descclassname">Schedule.</tt><tt class="descname">set</tt><big>(</big><em>profile</em>, <em>info</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.recovery.backup.profile_client.Schedule.set" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Updates a profile with the schedule policy.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>profile</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the profile
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.appliance.recovery.backup.profile.schedule</span></tt>.</li>
|
||
|
|
<li><strong>info</strong> (<a class="reference internal" href="#com.vmware.appliance.recovery.backup.profile_client.Schedule.Info" title="com.vmware.appliance.recovery.backup.profile_client.Schedule.Info"><tt class="xref py py-class docutils literal"><span class="pre">Schedule.Info</span></tt></a>) – Info Structure</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt>
|
||
|
|
if profile associated with id does not exist.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt>
|
||
|
|
if provided with invalid schedule info.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
|
||
|
|
if any error occurs during the execution of the operation.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="section" id="module-com.vmware.appliance.recovery.backup">
|
||
|
|
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-com.vmware.appliance.recovery.backup" title="Permalink to this headline">¶</a></h2>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="sphinxsidebar">
|
||
|
|
<div class="sphinxsidebarwrapper">
|
||
|
|
<h3><a href="index.html">Table Of Contents</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li><a class="reference internal" href="#">com.vmware.appliance.recovery.backup package</a><ul>
|
||
|
|
<li><a class="reference internal" href="#submodules">Submodules</a></li>
|
||
|
|
<li><a class="reference internal" href="#module-com.vmware.appliance.recovery.backup.job_client">com.vmware.appliance.recovery.backup.job_client module</a></li>
|
||
|
|
<li><a class="reference internal" href="#module-com.vmware.appliance.recovery.backup.profile_client">com.vmware.appliance.recovery.backup.profile_client module</a></li>
|
||
|
|
<li><a class="reference internal" href="#module-com.vmware.appliance.recovery.backup">Module contents</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<h4>Previous topic</h4>
|
||
|
|
<p class="topless"><a href="com.vmware.appliance.recovery.html"
|
||
|
|
title="previous chapter">com.vmware.appliance.recovery package</a></p>
|
||
|
|
<h4>Next topic</h4>
|
||
|
|
<p class="topless"><a href="com.vmware.appliance.techpreview.html"
|
||
|
|
title="next chapter">com.vmware.appliance.techpreview package</a></p>
|
||
|
|
<h3>This Page</h3>
|
||
|
|
<ul class="this-page-menu">
|
||
|
|
<li><a href="_sources/com.vmware.appliance.recovery.backup.txt"
|
||
|
|
rel="nofollow">Show Source</a></li>
|
||
|
|
</ul>
|
||
|
|
<div id="searchbox" style="display: none">
|
||
|
|
<h3>Quick search</h3>
|
||
|
|
<form class="search" action="search.html" method="get">
|
||
|
|
<input type="text" name="q" />
|
||
|
|
<input type="submit" value="Go" />
|
||
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
||
|
|
<input type="hidden" name="area" value="default" />
|
||
|
|
</form>
|
||
|
|
<p class="searchtip" style="font-size: 90%">
|
||
|
|
Enter search terms or a module, class or function name.
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="clearer"></div>
|
||
|
|
</div>
|
||
|
|
<div class="related">
|
||
|
|
<h3>Navigation</h3>
|
||
|
|
<ul>
|
||
|
|
<li class="right" style="margin-right: 10px">
|
||
|
|
<a href="genindex.html" title="General Index"
|
||
|
|
>index</a></li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="py-modindex.html" title="Python Module Index"
|
||
|
|
>modules</a> |</li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="com.vmware.appliance.techpreview.html" title="com.vmware.appliance.techpreview package"
|
||
|
|
>next</a> |</li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="com.vmware.appliance.recovery.html" title="com.vmware.appliance.recovery package"
|
||
|
|
>previous</a> |</li>
|
||
|
|
<li><a href="index.html">vSphere Automation SDK for Python 6.5.0 documentation</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><a href="com.vmware.appliance.recovery.html" >com.vmware.appliance.recovery package</a> »</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div class="footer">
|
||
|
|
© Copyright 2014-2017, VMware, Inc. All rights reserved.
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|