1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
|
<!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>Backup schedules — python-cloudservers v1.0 documentation</title>
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.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="python-cloudservers v1.0 documentation" href="../index.html" />
<link rel="up" title="API Reference" href="index.html" />
<link rel="next" title="Exceptions" href="exceptions.html" />
<link rel="prev" title="API Reference" href="index.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="exceptions.html" title="Exceptions"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="index.html" title="API Reference"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">python-cloudservers v1.0 documentation</a> »</li>
<li><a href="index.html" accesskey="U">API Reference</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="backup-schedules">
<h1>Backup schedules<a class="headerlink" href="#backup-schedules" title="Permalink to this headline">¶</a></h1>
<p>Rackspace allows scheduling of weekly and/or daily backups for virtual
servers. You can access these backup schedules either off the API object as
<a title="cloudservers.CloudServers.backup_schedules" class="reference external" href="../api.html#cloudservers.CloudServers.backup_schedules"><tt class="xref py py-attr docutils literal"><span class="pre">CloudServers.backup_schedules</span></tt></a>, or directly off a particular
<a title="cloudservers.Server" class="reference external" href="servers.html#cloudservers.Server"><tt class="xref py py-class docutils literal"><span class="pre">Server</span></tt></a> instance as <tt class="xref py py-attr docutils literal"><span class="pre">Server.backup_schedule</span></tt>.</p>
<div class="section" id="classes">
<h2>Classes<a class="headerlink" href="#classes" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="cloudservers.BackupScheduleManager">
<em class="property">class </em><tt class="descclassname">cloudservers.</tt><tt class="descname">BackupScheduleManager</tt><big>(</big><em>api</em><big>)</big><a class="headerlink" href="#cloudservers.BackupScheduleManager" title="Permalink to this definition">¶</a></dt>
<dd><p>Manage server backup schedules.</p>
<dl class="method">
<dt id="cloudservers.BackupScheduleManager.create">
<tt class="descname">create</tt><big>(</big><em>server</em>, <em>enabled=True</em>, <em>weekly='DISABLED'</em>, <em>daily='DISABLED'</em><big>)</big><a class="headerlink" href="#cloudservers.BackupScheduleManager.create" title="Permalink to this definition">¶</a></dt>
<dd><p>Create or update the backup schedule for the given server.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>server</strong> – The server (or its ID).</li>
<li><strong>enabled</strong> – boolean; should this schedule be enabled?</li>
<li><strong>weekly</strong> – Run a weekly backup on this day (one of the <cite>BACKUP_WEEKLY_*</cite> constants)</li>
<li><strong>daily</strong> – Run a daily backup at this time (one of the <cite>BACKUP_DAILY_*</cite> constants)</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="cloudservers.BackupScheduleManager.delete">
<tt class="descname">delete</tt><big>(</big><em>server</em><big>)</big><a class="headerlink" href="#cloudservers.BackupScheduleManager.delete" title="Permalink to this definition">¶</a></dt>
<dd><p>Remove the scheduled backup for <cite>server</cite>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>server</strong> – The server (or its ID).</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="cloudservers.BackupScheduleManager.update">
<tt class="descname">update</tt><big>(</big><em>server</em>, <em>enabled=True</em>, <em>weekly='DISABLED'</em>, <em>daily='DISABLED'</em><big>)</big><a class="headerlink" href="#cloudservers.BackupScheduleManager.update" title="Permalink to this definition">¶</a></dt>
<dd><p>Create or update the backup schedule for the given server.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>server</strong> – The server (or its ID).</li>
<li><strong>enabled</strong> – boolean; should this schedule be enabled?</li>
<li><strong>weekly</strong> – Run a weekly backup on this day (one of the <cite>BACKUP_WEEKLY_*</cite> constants)</li>
<li><strong>daily</strong> – Run a daily backup at this time (one of the <cite>BACKUP_DAILY_*</cite> constants)</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="cloudservers.BackupScheduleManager.get">
<tt class="descname">get</tt><big>(</big><em>server</em><big>)</big><a class="headerlink" href="#cloudservers.BackupScheduleManager.get" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the current backup schedule for a server.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>server</strong> – The server (or its ID).</li>
</ul>
</td>
</tr>
<tr class="field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><pending_xref py:class=”BackupScheduleManager” py:module=”cloudservers” refdoc=”ref/backup_schedules” refdomain=”py” refexplicit=”False” reftarget=”BackupSchedule” reftype=”class”><literal classes=”xref py py-class”>BackupSchedule</literal></pending_xref></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="cloudservers.BackupSchedule">
<em class="property">class </em><tt class="descclassname">cloudservers.</tt><tt class="descname">BackupSchedule</tt><big>(</big><em>manager</em>, <em>info</em><big>)</big><a class="headerlink" href="#cloudservers.BackupSchedule" title="Permalink to this definition">¶</a></dt>
<dd><p>Represents the daily or weekly backup schedule for some server.</p>
<dl class="attribute">
<dt id="cloudservers.BackupSchedule.enabled">
<tt class="descname">enabled</tt><a class="headerlink" href="#cloudservers.BackupSchedule.enabled" title="Permalink to this definition">¶</a></dt>
<dd>Is this backup enabled? (boolean)</dd></dl>
<dl class="attribute">
<dt id="cloudservers.BackupSchedule.weekly">
<tt class="descname">weekly</tt><a class="headerlink" href="#cloudservers.BackupSchedule.weekly" title="Permalink to this definition">¶</a></dt>
<dd>The day of week upon which to perform a weekly backup.</dd></dl>
<dl class="attribute">
<dt id="cloudservers.BackupSchedule.daily">
<tt class="descname">daily</tt><a class="headerlink" href="#cloudservers.BackupSchedule.daily" title="Permalink to this definition">¶</a></dt>
<dd>The daily time period during which to perform a daily backup.</dd></dl>
<dl class="method">
<dt id="cloudservers.BackupSchedule.update">
<tt class="descname">update</tt><big>(</big><em>enabled=True</em>, <em>weekly='DISABLED'</em>, <em>daily='DISABLED'</em><big>)</big><a class="headerlink" href="#cloudservers.BackupSchedule.update" title="Permalink to this definition">¶</a></dt>
<dd><p>Update this backup schedule.</p>
<p>See <a title="cloudservers.BackupScheduleManager.create" class="reference internal" href="#cloudservers.BackupScheduleManager.create"><tt class="xref py py-meth docutils literal"><span class="pre">BackupScheduleManager.create()</span></tt></a> for details.</p>
</dd></dl>
<dl class="method">
<dt id="cloudservers.BackupSchedule.delete">
<tt class="descname">delete</tt><big>(</big><big>)</big><a class="headerlink" href="#cloudservers.BackupSchedule.delete" title="Permalink to this definition">¶</a></dt>
<dd>Delete (i.e. disable and remove) this scheduled backup.</dd></dl>
</dd></dl>
</div>
<div class="section" id="constants">
<h2>Constants<a class="headerlink" href="#constants" title="Permalink to this headline">¶</a></h2>
<p>Constants for selecting weekly backup days:</p>
<blockquote>
<dl class="data">
<dt id="cloudservers.BACKUP_WEEKLY_DISABLED">
<tt class="descclassname">cloudservers.</tt><tt class="descname">BACKUP_WEEKLY_DISABLED</tt><a class="headerlink" href="#cloudservers.BACKUP_WEEKLY_DISABLED" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="cloudservers.BACKUP_WEEKLY_SUNDAY">
<tt class="descclassname">cloudservers.</tt><tt class="descname">BACKUP_WEEKLY_SUNDAY</tt><a class="headerlink" href="#cloudservers.BACKUP_WEEKLY_SUNDAY" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="cloudservers.BACKUP_WEEKLY_MONDAY">
<tt class="descclassname">cloudservers.</tt><tt class="descname">BACKUP_WEEKLY_MONDAY</tt><a class="headerlink" href="#cloudservers.BACKUP_WEEKLY_MONDAY" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="cloudservers.BACKUP_WEEKLY_TUESDAY">
<tt class="descclassname">cloudservers.</tt><tt class="descname">BACKUP_WEEKLY_TUESDAY</tt><a class="headerlink" href="#cloudservers.BACKUP_WEEKLY_TUESDAY" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="cloudservers.BACKUP_WEEKLY_WEDNESDA">
<tt class="descclassname">cloudservers.</tt><tt class="descname">BACKUP_WEEKLY_WEDNESDA</tt><a class="headerlink" href="#cloudservers.BACKUP_WEEKLY_WEDNESDA" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="cloudservers.BACKUP_WEEKLY_THURSDAY">
<tt class="descclassname">cloudservers.</tt><tt class="descname">BACKUP_WEEKLY_THURSDAY</tt><a class="headerlink" href="#cloudservers.BACKUP_WEEKLY_THURSDAY" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="cloudservers.BACKUP_WEEKLY_FRIDAY">
<tt class="descclassname">cloudservers.</tt><tt class="descname">BACKUP_WEEKLY_FRIDAY</tt><a class="headerlink" href="#cloudservers.BACKUP_WEEKLY_FRIDAY" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="cloudservers.BACKUP_WEEKLY_SATURDAY">
<tt class="descclassname">cloudservers.</tt><tt class="descname">BACKUP_WEEKLY_SATURDAY</tt><a class="headerlink" href="#cloudservers.BACKUP_WEEKLY_SATURDAY" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</blockquote>
<p>Constants for selecting hourly backup windows:</p>
<blockquote>
<dl class="data">
<dt id="cloudservers.BACKUP_DAILY_DISABLED">
<tt class="descclassname">cloudservers.</tt><tt class="descname">BACKUP_DAILY_DISABLED</tt><a class="headerlink" href="#cloudservers.BACKUP_DAILY_DISABLED" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="cloudservers.BACKUP_DAILY_H_0000_0200">
<tt class="descclassname">cloudservers.</tt><tt class="descname">BACKUP_DAILY_H_0000_0200</tt><a class="headerlink" href="#cloudservers.BACKUP_DAILY_H_0000_0200" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="cloudservers.BACKUP_DAILY_H_0200_0400">
<tt class="descclassname">cloudservers.</tt><tt class="descname">BACKUP_DAILY_H_0200_0400</tt><a class="headerlink" href="#cloudservers.BACKUP_DAILY_H_0200_0400" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="cloudservers.BACKUP_DAILY_H_0400_0600">
<tt class="descclassname">cloudservers.</tt><tt class="descname">BACKUP_DAILY_H_0400_0600</tt><a class="headerlink" href="#cloudservers.BACKUP_DAILY_H_0400_0600" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="cloudservers.BACKUP_DAILY_H_0600_0800">
<tt class="descclassname">cloudservers.</tt><tt class="descname">BACKUP_DAILY_H_0600_0800</tt><a class="headerlink" href="#cloudservers.BACKUP_DAILY_H_0600_0800" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="cloudservers.BACKUP_DAILY_H_0800_1000">
<tt class="descclassname">cloudservers.</tt><tt class="descname">BACKUP_DAILY_H_0800_1000</tt><a class="headerlink" href="#cloudservers.BACKUP_DAILY_H_0800_1000" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="cloudservers.BACKUP_DAILY_H_1000_1200">
<tt class="descclassname">cloudservers.</tt><tt class="descname">BACKUP_DAILY_H_1000_1200</tt><a class="headerlink" href="#cloudservers.BACKUP_DAILY_H_1000_1200" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="cloudservers.BACKUP_DAILY_H_1200_1400">
<tt class="descclassname">cloudservers.</tt><tt class="descname">BACKUP_DAILY_H_1200_1400</tt><a class="headerlink" href="#cloudservers.BACKUP_DAILY_H_1200_1400" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="cloudservers.BACKUP_DAILY_H_1400_1600">
<tt class="descclassname">cloudservers.</tt><tt class="descname">BACKUP_DAILY_H_1400_1600</tt><a class="headerlink" href="#cloudservers.BACKUP_DAILY_H_1400_1600" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="cloudservers.BACKUP_DAILY_H_1600_1800">
<tt class="descclassname">cloudservers.</tt><tt class="descname">BACKUP_DAILY_H_1600_1800</tt><a class="headerlink" href="#cloudservers.BACKUP_DAILY_H_1600_1800" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="cloudservers.BACKUP_DAILY_H_1800_2000">
<tt class="descclassname">cloudservers.</tt><tt class="descname">BACKUP_DAILY_H_1800_2000</tt><a class="headerlink" href="#cloudservers.BACKUP_DAILY_H_1800_2000" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="cloudservers.BACKUP_DAILY_H_2000_2200">
<tt class="descclassname">cloudservers.</tt><tt class="descname">BACKUP_DAILY_H_2000_2200</tt><a class="headerlink" href="#cloudservers.BACKUP_DAILY_H_2000_2200" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="cloudservers.BACKUP_DAILY_H_2200_0000">
<tt class="descclassname">cloudservers.</tt><tt class="descname">BACKUP_DAILY_H_2200_0000</tt><a class="headerlink" href="#cloudservers.BACKUP_DAILY_H_2200_0000" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</blockquote>
</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 external" href="#">Backup schedules</a><ul>
<li><a class="reference external" href="#classes">Classes</a></li>
<li><a class="reference external" href="#constants">Constants</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="index.html"
title="previous chapter">API Reference</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="exceptions.html"
title="next chapter">Exceptions</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/ref/backup_schedules.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" size="18" />
<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="exceptions.html" title="Exceptions"
>next</a> |</li>
<li class="right" >
<a href="index.html" title="API Reference"
>previous</a> |</li>
<li><a href="../index.html">python-cloudservers v1.0 documentation</a> »</li>
<li><a href="index.html" >API Reference</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2009, Jacob Kaplan-Moss.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0pre.
</div>
</body>
</html>
|
