-
Notifications
You must be signed in to change notification settings - Fork 10
Expand file tree
/
Copy pathJSTACK.Nova.Volume.html
More file actions
334 lines (268 loc) · 42.2 KB
/
Copy pathJSTACK.Nova.Volume.html
File metadata and controls
334 lines (268 loc) · 42.2 KB
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
<!DOCTYPE html> <html> <head> <title>JSTACK.Nova.Volume.js</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <link rel="stylesheet" media="all" href="docco.css" /> </head> <body> <div id="container"> <div id="background"></div> <div id="jump_to"> Jump To … <div id="jump_wrapper"> <div id="jump_page"> <a class="source" href="JSTACK.Comm.html"> JSTACK.Comm.js </a> <a class="source" href="JSTACK.Glance.html"> JSTACK.Glance.js </a> <a class="source" href="JSTACK.Keystone.html"> JSTACK.Keystone.js </a> <a class="source" href="JSTACK.Nova.Volume.html"> JSTACK.Nova.Volume.js </a> <a class="source" href="JSTACK.Nova.html"> JSTACK.Nova.js </a> <a class="source" href="JSTACK.Utils.html"> JSTACK.Utils.js </a> <a class="source" href="JSTACK.html"> JSTACK.js </a> </div> </div> </div> <table cellpadding="0" cellspacing="0"> <thead> <tr> <th class="docs"> <h1> JSTACK.Nova.Volume.js </h1> </th> <th class="code"> </th> </tr> </thead> <tbody> <tr id="section-1"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-1">¶</a> </div> </td> <td class="code"> <div class="highlight"><pre><span class="cm">/*</span>
<span class="cm">The MIT License</span>
<span class="cm">Copyright (c) 2012 Universidad Politecnica de Madrid</span>
<span class="cm">Permission is hereby granted, free of charge, to any person obtaining a copy</span>
<span class="cm">of this software and associated documentation files (the "Software"), to deal</span>
<span class="cm">in the Software without restriction, including without limitation the rights</span>
<span class="cm">to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span>
<span class="cm">copies of the Software, and to permit persons to whom the Software is</span>
<span class="cm">furnished to do so, subject to the following conditions:</span>
<span class="cm">The above copyright notice and this permission notice shall be included in</span>
<span class="cm">all copies or substantial portions of the Software.</span>
<span class="cm">THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span>
<span class="cm">IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span>
<span class="cm">FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span>
<span class="cm">AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span>
<span class="cm">LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span>
<span class="cm">OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN</span>
<span class="cm">THE SOFTWARE.</span>
<span class="cm">*/</span>
</pre></div> </td> </tr> <tr id="section-2"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-2">¶</a> </div> <h2>JStack Nova Volume Module</h2> </td> <td class="code"> <div class="highlight"><pre>
</pre></div> </td> </tr> <tr id="section-3"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-3">¶</a> </div> <p>Allows you to manage volumes and snapshots that can be used with the Compute API.</p> </td> <td class="code"> <div class="highlight"><pre>
<span class="nx">JSTACK</span><span class="p">.</span><span class="nx">Nova</span><span class="p">.</span><span class="nx">Volume</span> <span class="o">=</span> <span class="p">(</span><span class="kd">function</span> <span class="p">(</span><span class="nx">JS</span><span class="p">,</span> <span class="kc">undefined</span><span class="p">)</span> <span class="p">{</span>
<span class="s2">"use strict"</span><span class="p">;</span>
<span class="kd">var</span> <span class="nx">params</span><span class="p">,</span> <span class="nx">check</span><span class="p">,</span> <span class="nx">configure</span><span class="p">,</span> <span class="nx">getvolumelist</span><span class="p">,</span> <span class="nx">createvolume</span><span class="p">,</span> <span class="nx">deletevolume</span><span class="p">,</span> <span class="nx">getvolume</span><span class="p">,</span>
<span class="nx">getsnapshotlist</span><span class="p">,</span> <span class="nx">createsnapshot</span><span class="p">,</span> <span class="nx">deletesnapshot</span><span class="p">,</span> <span class="nx">getsnapshot</span><span class="p">;</span>
</pre></div> </td> </tr> <tr id="section-4"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-4">¶</a> </div> <p>This modules stores the <code>url</code> to which it will send every
request.</p> </td> <td class="code"> <div class="highlight"><pre>
<span class="nx">params</span> <span class="o">=</span> <span class="p">{</span>
<span class="nx">url</span> <span class="o">:</span> <span class="kc">undefined</span><span class="p">,</span>
<span class="nx">state</span> <span class="o">:</span> <span class="kc">undefined</span><span class="p">,</span>
<span class="nx">endpointType</span> <span class="o">:</span> <span class="s2">"publicURL"</span>
<span class="p">};</span>
</pre></div> </td> </tr> <tr id="section-5"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-5">¶</a> </div> <h2>Private functions</h2> </td> <td class="code"> <div class="highlight"><pre>
</pre></div> </td> </tr> <tr id="section-6"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-6">¶</a> </div> <p>Function <code>check</code> internally confirms that Keystone module is
authenticated and it has the URL of the Volume service.</p> </td> <td class="code"> <div class="highlight"><pre>
<span class="nx">check</span> <span class="o">=</span> <span class="kd">function</span> <span class="p">()</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">JS</span><span class="p">.</span><span class="nx">Keystone</span> <span class="o">!==</span> <span class="kc">undefined</span> <span class="o">&&</span> <span class="nx">JS</span><span class="p">.</span><span class="nx">Keystone</span><span class="p">.</span><span class="nx">params</span><span class="p">.</span><span class="nx">currentstate</span> <span class="o">===</span> <span class="nx">JS</span><span class="p">.</span><span class="nx">Keystone</span><span class="p">.</span><span class="nx">STATES</span><span class="p">.</span><span class="nx">AUTHENTICATED</span><span class="p">)</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">service</span> <span class="o">=</span> <span class="nx">JS</span><span class="p">.</span><span class="nx">Keystone</span><span class="p">.</span><span class="nx">getservice</span><span class="p">(</span><span class="s2">"volume"</span><span class="p">);</span>
<span class="nx">params</span><span class="p">.</span><span class="nx">url</span> <span class="o">=</span> <span class="nx">service</span><span class="p">.</span><span class="nx">endpoints</span><span class="p">[</span><span class="mi">0</span><span class="p">][</span><span class="nx">params</span><span class="p">.</span><span class="nx">endpointType</span><span class="p">];</span>
<span class="k">return</span> <span class="kc">true</span><span class="p">;</span>
<span class="p">}</span>
<span class="k">return</span> <span class="kc">false</span><span class="p">;</span>
<span class="p">};</span>
</pre></div> </td> </tr> <tr id="section-7"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-7">¶</a> </div> <h2>Public functions</h2> </td> <td class="code"> <div class="highlight"><pre>
</pre></div> </td> </tr> <tr id="section-8"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-8">¶</a> </div> <p>This function sets the endpoint type for making requests to Glance.
It could take one of the following values:
* "adminURL"
* "internalURL"
* "publicURL"
You can use this function to change the default endpointURL, which is publicURL.</p> </td> <td class="code"> <div class="highlight"><pre>
<span class="nx">configure</span> <span class="o">=</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">endpointType</span><span class="p">)</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">endpointType</span> <span class="o">===</span> <span class="s2">"adminURL"</span> <span class="o">||</span> <span class="nx">endpointType</span> <span class="o">===</span> <span class="s2">"internalURL"</span> <span class="o">||</span> <span class="nx">endpointType</span> <span class="o">===</span> <span class="s2">"publicURL"</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">params</span><span class="p">.</span><span class="nx">endpointType</span> <span class="o">=</span> <span class="nx">endpointType</span><span class="p">;</span>
<span class="p">}</span>
<span class="p">};</span>
</pre></div> </td> </tr> <tr id="section-9"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-9">¶</a> </div> <p><strong>Volume Operations</strong></p> </td> <td class="code"> <div class="highlight"><pre>
</pre></div> </td> </tr> <tr id="section-10"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-10">¶</a> </div> <p>View a list of simple Volume entities. In
<a href="http://api.openstack.org/">Requesting a List of Volumes</a>
there is more information about the JSON object that is returned.</p> </td> <td class="code"> <div class="highlight"><pre>
<span class="nx">getvolumelist</span> <span class="o">=</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">detailed</span><span class="p">,</span> <span class="nx">callback</span><span class="p">)</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">url</span><span class="p">,</span> <span class="nx">onOk</span><span class="p">,</span> <span class="nx">onError</span><span class="p">;</span>
<span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nx">check</span><span class="p">())</span> <span class="p">{</span>
<span class="k">return</span><span class="p">;</span>
<span class="p">}</span>
<span class="nx">url</span> <span class="o">=</span> <span class="nx">params</span><span class="p">.</span><span class="nx">url</span> <span class="o">+</span> <span class="s1">'/volumes'</span><span class="p">;</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">detailed</span> <span class="o">!==</span> <span class="kc">undefined</span> <span class="o">&&</span> <span class="nx">detailed</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">url</span> <span class="o">+=</span> <span class="s1">'/detail'</span><span class="p">;</span>
<span class="p">}</span>
<span class="nx">onOk</span> <span class="o">=</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">result</span><span class="p">)</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">callback</span> <span class="o">!==</span> <span class="kc">undefined</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">callback</span><span class="p">(</span><span class="nx">result</span><span class="p">);</span>
<span class="p">}</span>
<span class="p">};</span>
<span class="nx">onError</span> <span class="o">=</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">message</span><span class="p">)</span> <span class="p">{</span>
<span class="k">throw</span> <span class="k">new</span> <span class="nb">Error</span><span class="p">(</span><span class="nx">message</span><span class="p">);</span>
<span class="p">};</span>
<span class="nx">JS</span><span class="p">.</span><span class="nx">Comm</span><span class="p">.</span><span class="nx">get</span><span class="p">(</span><span class="nx">url</span><span class="p">,</span> <span class="nx">JS</span><span class="p">.</span><span class="nx">Keystone</span><span class="p">.</span><span class="nx">params</span><span class="p">.</span><span class="nx">token</span><span class="p">,</span> <span class="nx">onOk</span><span class="p">,</span> <span class="nx">onError</span><span class="p">);</span>
<span class="p">};</span>
</pre></div> </td> </tr> <tr id="section-11"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-11">¶</a> </div> <p>Create a Volume.
Arguments in this function are:</p>
<p>a. Mandatory</p>
<ul>
<li>The <code>size</code> of volume in GB</li>
</ul>
<p>b. Optional</p>
<ul>
<li><p>The <code>name</code> of the volume</p></li>
<li><p>The <code>description</code> of the volume</p></li>
</ul> </td> <td class="code"> <div class="highlight"><pre>
<span class="nx">createvolume</span> <span class="o">=</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">size</span><span class="p">,</span> <span class="nx">name</span><span class="p">,</span> <span class="nx">description</span><span class="p">,</span> <span class="nx">callback</span><span class="p">)</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">onOk</span><span class="p">,</span> <span class="nx">onError</span><span class="p">,</span> <span class="nx">data</span><span class="p">;</span>
<span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nx">check</span><span class="p">())</span> <span class="p">{</span>
<span class="k">return</span><span class="p">;</span>
<span class="p">}</span>
<span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
<span class="s2">"volume"</span> <span class="o">:</span> <span class="p">{</span>
<span class="s2">"size"</span> <span class="o">:</span> <span class="nx">size</span>
<span class="p">}</span>
<span class="p">};</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">name</span> <span class="o">!==</span> <span class="kc">undefined</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">data</span><span class="p">.</span><span class="nx">volume</span><span class="p">.</span><span class="nx">display_name</span> <span class="o">=</span> <span class="nx">name</span><span class="p">;</span>
<span class="p">}</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">description</span> <span class="o">!==</span> <span class="kc">undefined</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">data</span><span class="p">.</span><span class="nx">volume</span><span class="p">.</span><span class="nx">display_description</span> <span class="o">=</span> <span class="nx">description</span><span class="p">;</span>
<span class="p">}</span>
<span class="nx">onOk</span> <span class="o">=</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">result</span><span class="p">)</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">callback</span> <span class="o">!==</span> <span class="kc">undefined</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">callback</span><span class="p">(</span><span class="nx">result</span><span class="p">);</span>
<span class="p">}</span>
<span class="p">};</span>
<span class="nx">onError</span> <span class="o">=</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">message</span><span class="p">)</span> <span class="p">{</span>
<span class="k">throw</span> <span class="k">new</span> <span class="nb">Error</span><span class="p">(</span><span class="nx">message</span><span class="p">);</span>
<span class="p">};</span>
<span class="nx">JS</span><span class="p">.</span><span class="nx">Comm</span><span class="p">.</span><span class="nx">post</span><span class="p">(</span><span class="nx">params</span><span class="p">.</span><span class="nx">url</span> <span class="o">+</span> <span class="s1">'/volumes'</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">JS</span><span class="p">.</span><span class="nx">Keystone</span><span class="p">.</span><span class="nx">params</span><span class="p">.</span><span class="nx">token</span><span class="p">,</span> <span class="nx">onOk</span><span class="p">,</span> <span class="nx">onError</span><span class="p">);</span>
<span class="p">};</span>
</pre></div> </td> </tr> <tr id="section-12"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-12">¶</a> </div> <p>Delete a Volume entitiy. In
<a href="http://api.openstack.org/">Deleting a Volume</a>
there is more information about the JSON object that is returned.</p> </td> <td class="code"> <div class="highlight"><pre>
<span class="nx">deletevolume</span> <span class="o">=</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">id</span><span class="p">,</span> <span class="nx">callback</span><span class="p">)</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">url</span><span class="p">,</span> <span class="nx">onOk</span><span class="p">,</span> <span class="nx">onError</span><span class="p">;</span>
<span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nx">check</span><span class="p">())</span> <span class="p">{</span>
<span class="k">return</span><span class="p">;</span>
<span class="p">}</span>
<span class="nx">url</span> <span class="o">=</span> <span class="nx">params</span><span class="p">.</span><span class="nx">url</span> <span class="o">+</span> <span class="s1">'/volumes/'</span> <span class="o">+</span> <span class="nx">id</span><span class="p">;</span>
<span class="nx">onOk</span> <span class="o">=</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">result</span><span class="p">)</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">callback</span> <span class="o">!==</span> <span class="kc">undefined</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">callback</span><span class="p">(</span><span class="nx">result</span><span class="p">);</span>
<span class="p">}</span>
<span class="p">};</span>
<span class="nx">onError</span> <span class="o">=</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">message</span><span class="p">)</span> <span class="p">{</span>
<span class="k">throw</span> <span class="k">new</span> <span class="nb">Error</span><span class="p">(</span><span class="nx">message</span><span class="p">);</span>
<span class="p">};</span>
<span class="nx">JS</span><span class="p">.</span><span class="nx">Comm</span><span class="p">.</span><span class="nx">del</span><span class="p">(</span><span class="nx">url</span><span class="p">,</span> <span class="nx">JS</span><span class="p">.</span><span class="nx">Keystone</span><span class="p">.</span><span class="nx">params</span><span class="p">.</span><span class="nx">token</span><span class="p">,</span> <span class="nx">onOk</span><span class="p">,</span> <span class="nx">onError</span><span class="p">);</span>
<span class="p">};</span>
</pre></div> </td> </tr> <tr id="section-13"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-13">¶</a> </div> <p>Get a Volume entitiy. In
<a href="http://api.openstack.org/">Retrieving a Volume</a>
there is more information about the JSON object that is returned.</p> </td> <td class="code"> <div class="highlight"><pre>
<span class="nx">getvolume</span> <span class="o">=</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">id</span><span class="p">,</span> <span class="nx">callback</span><span class="p">)</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">url</span><span class="p">,</span> <span class="nx">onOk</span><span class="p">,</span> <span class="nx">onError</span><span class="p">;</span>
<span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nx">check</span><span class="p">())</span> <span class="p">{</span>
<span class="k">return</span><span class="p">;</span>
<span class="p">}</span>
<span class="nx">url</span> <span class="o">=</span> <span class="nx">params</span><span class="p">.</span><span class="nx">url</span> <span class="o">+</span> <span class="s1">'/volumes/'</span> <span class="o">+</span> <span class="nx">id</span><span class="p">;</span>
<span class="nx">onOk</span> <span class="o">=</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">result</span><span class="p">)</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">callback</span> <span class="o">!==</span> <span class="kc">undefined</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">callback</span><span class="p">(</span><span class="nx">result</span><span class="p">);</span>
<span class="p">}</span>
<span class="p">};</span>
<span class="nx">onError</span> <span class="o">=</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">message</span><span class="p">)</span> <span class="p">{</span>
<span class="k">throw</span> <span class="k">new</span> <span class="nb">Error</span><span class="p">(</span><span class="nx">message</span><span class="p">);</span>
<span class="p">};</span>
<span class="nx">JS</span><span class="p">.</span><span class="nx">Comm</span><span class="p">.</span><span class="nx">get</span><span class="p">(</span><span class="nx">url</span><span class="p">,</span> <span class="nx">JS</span><span class="p">.</span><span class="nx">Keystone</span><span class="p">.</span><span class="nx">params</span><span class="p">.</span><span class="nx">token</span><span class="p">,</span> <span class="nx">onOk</span><span class="p">,</span> <span class="nx">onError</span><span class="p">);</span>
<span class="p">};</span>
</pre></div> </td> </tr> <tr id="section-14"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-14">¶</a> </div> <p><strong>Snapshot Operations</strong></p> </td> <td class="code"> <div class="highlight"><pre>
</pre></div> </td> </tr> <tr id="section-15"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-15">¶</a> </div> <p>View a list of simple Snapshot entities. In
<a href="http://api.openstack.org/">Requesting a List of Snapshots</a>
there is more information about the JSON object that is returned.</p> </td> <td class="code"> <div class="highlight"><pre>
<span class="nx">getsnapshotlist</span> <span class="o">=</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">detailed</span><span class="p">,</span> <span class="nx">callback</span><span class="p">)</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">url</span><span class="p">,</span> <span class="nx">onOk</span><span class="p">,</span> <span class="nx">onError</span><span class="p">;</span>
<span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nx">check</span><span class="p">())</span> <span class="p">{</span>
<span class="k">return</span><span class="p">;</span>
<span class="p">}</span>
<span class="nx">url</span> <span class="o">=</span> <span class="nx">params</span><span class="p">.</span><span class="nx">url</span> <span class="o">+</span> <span class="s1">'/snapshots'</span><span class="p">;</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">detailed</span> <span class="o">!==</span> <span class="kc">undefined</span> <span class="o">&&</span> <span class="nx">detailed</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">url</span> <span class="o">+=</span> <span class="s1">'/detail'</span><span class="p">;</span>
<span class="p">}</span>
<span class="nx">onOk</span> <span class="o">=</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">result</span><span class="p">)</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">callback</span> <span class="o">!==</span> <span class="kc">undefined</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">callback</span><span class="p">(</span><span class="nx">result</span><span class="p">);</span>
<span class="p">}</span>
<span class="p">};</span>
<span class="nx">onError</span> <span class="o">=</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">message</span><span class="p">)</span> <span class="p">{</span>
<span class="k">throw</span> <span class="k">new</span> <span class="nb">Error</span><span class="p">(</span><span class="nx">message</span><span class="p">);</span>
<span class="p">};</span>
<span class="nx">JS</span><span class="p">.</span><span class="nx">Comm</span><span class="p">.</span><span class="nx">get</span><span class="p">(</span><span class="nx">url</span><span class="p">,</span> <span class="nx">JS</span><span class="p">.</span><span class="nx">Keystone</span><span class="p">.</span><span class="nx">params</span><span class="p">.</span><span class="nx">token</span><span class="p">,</span> <span class="nx">onOk</span><span class="p">,</span> <span class="nx">onError</span><span class="p">);</span>
<span class="p">};</span>
</pre></div> </td> </tr> <tr id="section-16"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-16">¶</a> </div> <p>Create a Volume Snapshot.
Arguments in this function are:</p>
<p>a. Mandatory</p>
<ul>
<li>The <code>volume_id</code> of the volume</li>
</ul>
<p>b. Optional</p>
<ul>
<li><p>The <code>name</code> of the snapshot</p></li>
<li><p>The <code>description</code> of the snapshot</p></li>
</ul> </td> <td class="code"> <div class="highlight"><pre>
<span class="nx">createsnapshot</span> <span class="o">=</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">volume_id</span><span class="p">,</span> <span class="nx">name</span><span class="p">,</span> <span class="nx">description</span><span class="p">,</span> <span class="nx">callback</span><span class="p">)</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">url</span><span class="p">,</span> <span class="nx">onOk</span><span class="p">,</span> <span class="nx">onError</span><span class="p">,</span> <span class="nx">data</span><span class="p">;</span>
<span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nx">check</span><span class="p">())</span> <span class="p">{</span>
<span class="k">return</span><span class="p">;</span>
<span class="p">}</span>
<span class="nx">data</span> <span class="o">=</span> <span class="p">{</span>
<span class="s2">"snapshot"</span> <span class="o">:</span> <span class="p">{</span>
<span class="s2">"volume_id"</span> <span class="o">:</span> <span class="nx">volume_id</span><span class="p">,</span>
<span class="s2">"force"</span> <span class="o">:</span> <span class="kc">true</span>
<span class="p">}</span>
<span class="p">};</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">name</span> <span class="o">!==</span> <span class="kc">undefined</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">data</span><span class="p">.</span><span class="nx">snapshot</span><span class="p">.</span><span class="nx">display_name</span> <span class="o">=</span> <span class="nx">name</span><span class="p">;</span>
<span class="p">}</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">description</span> <span class="o">!==</span> <span class="kc">undefined</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">data</span><span class="p">.</span><span class="nx">snapshot</span><span class="p">.</span><span class="nx">display_description</span> <span class="o">=</span> <span class="nx">description</span><span class="p">;</span>
<span class="p">}</span>
<span class="nx">onOk</span> <span class="o">=</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">result</span><span class="p">)</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">callback</span> <span class="o">!==</span> <span class="kc">undefined</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">callback</span><span class="p">(</span><span class="nx">result</span><span class="p">);</span>
<span class="p">}</span>
<span class="p">};</span>
<span class="nx">onError</span> <span class="o">=</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">message</span><span class="p">)</span> <span class="p">{</span>
<span class="k">throw</span> <span class="k">new</span> <span class="nb">Error</span><span class="p">(</span><span class="nx">message</span><span class="p">);</span>
<span class="p">};</span>
<span class="nx">JS</span><span class="p">.</span><span class="nx">Comm</span><span class="p">.</span><span class="nx">post</span><span class="p">(</span><span class="nx">params</span><span class="p">.</span><span class="nx">url</span> <span class="o">+</span> <span class="s1">'/snapshots'</span><span class="p">,</span> <span class="nx">data</span><span class="p">,</span> <span class="nx">JS</span><span class="p">.</span><span class="nx">Keystone</span><span class="p">.</span><span class="nx">params</span><span class="p">.</span><span class="nx">token</span><span class="p">,</span> <span class="nx">onOk</span><span class="p">,</span> <span class="nx">onError</span><span class="p">);</span>
<span class="p">};</span>
</pre></div> </td> </tr> <tr id="section-17"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-17">¶</a> </div> <p>Delete a Snapshot entitiy. In
<a href="http://api.openstack.org/">Retrieving a Snapshot</a>
there is more information about the JSON object that is returned.</p> </td> <td class="code"> <div class="highlight"><pre>
<span class="nx">deletesnapshot</span> <span class="o">=</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">id</span><span class="p">,</span> <span class="nx">callback</span><span class="p">)</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">url</span><span class="p">,</span> <span class="nx">onOk</span><span class="p">,</span> <span class="nx">onError</span><span class="p">;</span>
<span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nx">check</span><span class="p">())</span> <span class="p">{</span>
<span class="k">return</span><span class="p">;</span>
<span class="p">}</span>
<span class="nx">url</span> <span class="o">=</span> <span class="nx">params</span><span class="p">.</span><span class="nx">url</span> <span class="o">+</span> <span class="s1">'/snapshots/'</span> <span class="o">+</span> <span class="nx">id</span><span class="p">;</span>
<span class="nx">onOk</span> <span class="o">=</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">result</span><span class="p">)</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">callback</span> <span class="o">!==</span> <span class="kc">undefined</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">callback</span><span class="p">(</span><span class="nx">result</span><span class="p">);</span>
<span class="p">}</span>
<span class="p">};</span>
<span class="nx">onError</span> <span class="o">=</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">message</span><span class="p">)</span> <span class="p">{</span>
<span class="k">throw</span> <span class="k">new</span> <span class="nb">Error</span><span class="p">(</span><span class="nx">message</span><span class="p">);</span>
<span class="p">};</span>
<span class="nx">JS</span><span class="p">.</span><span class="nx">Comm</span><span class="p">.</span><span class="nx">del</span><span class="p">(</span><span class="nx">url</span><span class="p">,</span> <span class="nx">JS</span><span class="p">.</span><span class="nx">Keystone</span><span class="p">.</span><span class="nx">params</span><span class="p">.</span><span class="nx">token</span><span class="p">,</span> <span class="nx">onOk</span><span class="p">,</span> <span class="nx">onError</span><span class="p">);</span>
<span class="p">};</span>
</pre></div> </td> </tr> <tr id="section-18"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-18">¶</a> </div> <p>Get a Snapshot entitiy. In
<a href="http://api.openstack.org/">Retrieving a Snapshot</a>
there is more information about the JSON object that is returned.</p> </td> <td class="code"> <div class="highlight"><pre>
<span class="nx">getsnapshot</span> <span class="o">=</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">id</span><span class="p">,</span> <span class="nx">callback</span><span class="p">)</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">url</span><span class="p">,</span> <span class="nx">onOk</span><span class="p">,</span> <span class="nx">onError</span><span class="p">;</span>
<span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nx">check</span><span class="p">())</span> <span class="p">{</span>
<span class="k">return</span><span class="p">;</span>
<span class="p">}</span>
<span class="nx">url</span> <span class="o">=</span> <span class="nx">params</span><span class="p">.</span><span class="nx">url</span> <span class="o">+</span> <span class="s1">'/snapshots/'</span> <span class="o">+</span> <span class="nx">id</span><span class="p">;</span>
<span class="nx">onOk</span> <span class="o">=</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">result</span><span class="p">)</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">callback</span> <span class="o">!==</span> <span class="kc">undefined</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">callback</span><span class="p">(</span><span class="nx">result</span><span class="p">);</span>
<span class="p">}</span>
<span class="p">};</span>
<span class="nx">onError</span> <span class="o">=</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">message</span><span class="p">)</span> <span class="p">{</span>
<span class="k">throw</span> <span class="k">new</span> <span class="nb">Error</span><span class="p">(</span><span class="nx">message</span><span class="p">);</span>
<span class="p">};</span>
<span class="nx">JS</span><span class="p">.</span><span class="nx">Comm</span><span class="p">.</span><span class="nx">get</span><span class="p">(</span><span class="nx">url</span><span class="p">,</span> <span class="nx">JS</span><span class="p">.</span><span class="nx">Keystone</span><span class="p">.</span><span class="nx">params</span><span class="p">.</span><span class="nx">token</span><span class="p">,</span> <span class="nx">onOk</span><span class="p">,</span> <span class="nx">onError</span><span class="p">);</span>
<span class="p">};</span>
</pre></div> </td> </tr> <tr id="section-19"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-19">¶</a> </div> <h2>Public Functions and Variables</h2>
<p>This is the list of available public functions and variables</p> </td> <td class="code"> <div class="highlight"><pre>
<span class="k">return</span> <span class="p">{</span>
</pre></div> </td> </tr> <tr id="section-20"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-20">¶</a> </div> <p>Functions:</p> </td> <td class="code"> <div class="highlight"><pre>
<span class="nx">configure</span> <span class="o">:</span> <span class="nx">configure</span><span class="p">,</span>
<span class="nx">getvolumelist</span> <span class="o">:</span> <span class="nx">getvolumelist</span><span class="p">,</span>
<span class="nx">createvolume</span> <span class="o">:</span> <span class="nx">createvolume</span><span class="p">,</span>
<span class="nx">deletevolume</span> <span class="o">:</span> <span class="nx">deletevolume</span><span class="p">,</span>
<span class="nx">getvolume</span> <span class="o">:</span> <span class="nx">getvolume</span><span class="p">,</span>
<span class="nx">getsnapshotlist</span> <span class="o">:</span> <span class="nx">getsnapshotlist</span><span class="p">,</span>
<span class="nx">createsnapshot</span> <span class="o">:</span> <span class="nx">createsnapshot</span><span class="p">,</span>
<span class="nx">deletesnapshot</span> <span class="o">:</span> <span class="nx">deletesnapshot</span><span class="p">,</span>
<span class="nx">getsnapshot</span> <span class="o">:</span> <span class="nx">getsnapshot</span>
<span class="p">};</span>
<span class="p">}(</span><span class="nx">JSTACK</span><span class="p">));</span>
</pre></div> </td> </tr> </tbody> </table> </div> </body> </html>