ropenstack 1.2.1 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/.gitignore +1 -0
- data/README.md +2 -1
- data/doc/Ropenstack.html +151 -0
- data/doc/Ropenstack/Cinder.html +197 -0
- data/doc/Ropenstack/Glance.html +292 -0
- data/doc/Ropenstack/Keystone.html +737 -0
- data/doc/Ropenstack/MalformedRequestError.html +142 -0
- data/doc/Ropenstack/NotFoundError.html +142 -0
- data/doc/Ropenstack/Nova.html +562 -0
- data/doc/Ropenstack/OpenstackService.html +199 -0
- data/doc/Ropenstack/Quantum.html +830 -0
- data/doc/Ropenstack/Rest.html +483 -0
- data/doc/Ropenstack/RopenstackError.html +143 -0
- data/doc/Ropenstack/TimeoutError.html +142 -0
- data/doc/Ropenstack/UnauthorisedError.html +142 -0
- data/doc/created.rid +10 -0
- data/doc/images/add.png +0 -0
- data/doc/images/brick.png +0 -0
- data/doc/images/brick_link.png +0 -0
- data/doc/images/bug.png +0 -0
- data/doc/images/bullet_black.png +0 -0
- data/doc/images/bullet_toggle_minus.png +0 -0
- data/doc/images/bullet_toggle_plus.png +0 -0
- data/doc/images/date.png +0 -0
- data/doc/images/delete.png +0 -0
- data/doc/images/find.png +0 -0
- data/doc/images/loadingAnimation.gif +0 -0
- data/doc/images/macFFBgHack.png +0 -0
- data/doc/images/package.png +0 -0
- data/doc/images/page_green.png +0 -0
- data/doc/images/page_white_text.png +0 -0
- data/doc/images/page_white_width.png +0 -0
- data/doc/images/plugin.png +0 -0
- data/doc/images/ruby.png +0 -0
- data/doc/images/tag_blue.png +0 -0
- data/doc/images/tag_green.png +0 -0
- data/doc/images/transparent.png +0 -0
- data/doc/images/wrench.png +0 -0
- data/doc/images/wrench_orange.png +0 -0
- data/doc/images/zoom.png +0 -0
- data/doc/index.html +93 -0
- data/doc/js/darkfish.js +153 -0
- data/doc/js/jquery.js +18 -0
- data/doc/js/navigation.js +142 -0
- data/doc/js/search.js +94 -0
- data/doc/js/search_index.js +1 -0
- data/doc/js/searcher.js +228 -0
- data/doc/rdoc.css +543 -0
- data/doc/table_of_contents.html +200 -0
- data/lib/ropenstack.rb +18 -0
- data/lib/ropenstack/blockStorage.rb +25 -0
- data/lib/ropenstack/blockStorage/v1.rb +67 -0
- data/lib/ropenstack/blockStorage/v2.rb +11 -0
- data/lib/ropenstack/common/error.rb +12 -0
- data/lib/ropenstack/common/openstackservice.rb +28 -0
- data/lib/ropenstack/common/rest.rb +138 -0
- data/lib/ropenstack/compute.rb +164 -0
- data/lib/ropenstack/compute/v2.rb +11 -0
- data/lib/ropenstack/compute/v2/extensions.rb +14 -0
- data/lib/ropenstack/compute/v2/extensions/admin.rb +0 -0
- data/lib/ropenstack/compute/v2/extensions/agents.rb +0 -0
- data/lib/ropenstack/compute/v2/extensions/aggregates.rb +0 -0
- data/lib/ropenstack/compute/v2/extensions/certificates.rb +0 -0
- data/lib/ropenstack/compute/v2/extensions/cloudpipe.rb +0 -0
- data/lib/ropenstack/compute/v2/extensions/console.rb +0 -0
- data/lib/ropenstack/compute/v2/extensions/coverage.rb +0 -0
- data/lib/ropenstack/compute/v2/extensions/defaultsecuritygroup.rb +0 -0
- data/lib/ropenstack/compute/v2/extensions/diagnostics.rb +0 -0
- data/lib/ropenstack/compute/v2/extensions/extraspecs.rb +0 -0
- data/lib/ropenstack/compute/v2/extensions/fixedips.rb +0 -0
- data/lib/ropenstack/compute/v2/extensions/flavors.rb +0 -0
- data/lib/ropenstack/compute/v2/extensions/hosts.rb +0 -0
- data/lib/ropenstack/compute/v2/extensions/hypervisors.rb +0 -0
- data/lib/ropenstack/compute/v2/extensions/images.rb +0 -0
- data/lib/ropenstack/compute/v2/extensions/instanceactions.rb +0 -0
- data/lib/ropenstack/compute/v2/extensions/interfaces.rb +0 -0
- data/lib/ropenstack/compute/v2/extensions/keypairs.rb +20 -0
- data/lib/ropenstack/compute/v2/extensions/limits.rb +0 -0
- data/lib/ropenstack/compute/v2/extensions/migrations.rb +0 -0
- data/lib/ropenstack/compute/v2/extensions/networks.rb +0 -0
- data/lib/ropenstack/compute/v2/extensions/quotasets.rb +0 -0
- data/lib/ropenstack/compute/v2/extensions/securitygroups.rb +40 -0
- data/lib/ropenstack/compute/v2/extensions/servergroups.rb +0 -0
- data/lib/ropenstack/compute/v2/extensions/serverpassword.rb +0 -0
- data/lib/ropenstack/compute/v2/extensions/services.rb +0 -0
- data/lib/ropenstack/compute/v2/extensions/shelvedservers.rb +0 -0
- data/lib/ropenstack/compute/v2/extensions/usage.rb +0 -0
- data/lib/ropenstack/compute/v2/extensions/virtualinterfaces.rb +0 -0
- data/lib/ropenstack/compute/v2/extensions/volumes.rb +20 -0
- data/lib/ropenstack/compute/v3.rb +5 -0
- data/lib/ropenstack/database.rb +24 -0
- data/lib/ropenstack/database/v1.rb +113 -0
- data/lib/ropenstack/identity.rb +28 -0
- data/lib/ropenstack/identity/v2.rb +178 -0
- data/lib/ropenstack/identity/v3.rb +13 -0
- data/lib/ropenstack/image.rb +25 -0
- data/lib/ropenstack/image/v1.rb +107 -0
- data/lib/ropenstack/image/v2.rb +134 -0
- data/lib/ropenstack/networking.rb +160 -0
- data/lib/ropenstack/networking/v2.rb +5 -0
- data/lib/ropenstack/networking/v2/extensions.rb +9 -0
- data/lib/ropenstack/networking/v2/extensions/l3.rb +111 -0
- data/lib/ropenstack/networking/v2/extensions/lbaas.rb +5 -0
- data/lib/ropenstack/networking/v2/extensions/metering.rb +5 -0
- data/lib/ropenstack/networking/v2/extensions/quotas.rb +5 -0
- data/lib/ropenstack/networking/v2/extensions/securitygroups.rb +5 -0
- data/lib/ropenstack/objectStorage.rb +60 -0
- data/lib/ropenstack/orchestration.rb +23 -0
- data/lib/ropenstack/orchestration/v1.rb +162 -0
- data/lib/ropenstack/telemetry.rb +23 -0
- data/lib/ropenstack/telemetry/v2.rb +68 -0
- data/ropenstack.gemspec +13 -0
- metadata +112 -1
|
@@ -0,0 +1,199 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
|
|
6
|
+
|
|
7
|
+
<title>class Ropenstack::OpenstackService - RDoc Documentation</title>
|
|
8
|
+
|
|
9
|
+
<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet">
|
|
10
|
+
|
|
11
|
+
<script type="text/javascript">
|
|
12
|
+
var rdoc_rel_prefix = "../";
|
|
13
|
+
</script>
|
|
14
|
+
|
|
15
|
+
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
|
16
|
+
<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script>
|
|
17
|
+
<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script>
|
|
18
|
+
<script type="text/javascript" charset="utf-8" src="../js/search.js"></script>
|
|
19
|
+
<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script>
|
|
20
|
+
<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<body id="top" class="class">
|
|
24
|
+
<nav id="metadata">
|
|
25
|
+
<nav id="home-section" class="section">
|
|
26
|
+
<h3 class="section-header">
|
|
27
|
+
<a href="../index.html">Home</a>
|
|
28
|
+
<a href="../table_of_contents.html#classes">Classes</a>
|
|
29
|
+
<a href="../table_of_contents.html#methods">Methods</a>
|
|
30
|
+
</h3>
|
|
31
|
+
</nav>
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
<nav id="search-section" class="section project-section" class="initially-hidden">
|
|
35
|
+
<form action="#" method="get" accept-charset="utf-8">
|
|
36
|
+
<h3 class="section-header">
|
|
37
|
+
<input type="text" name="search" placeholder="Search" id="search-field"
|
|
38
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
|
39
|
+
</h3>
|
|
40
|
+
</form>
|
|
41
|
+
|
|
42
|
+
<ul id="search-results" class="initially-hidden"></ul>
|
|
43
|
+
</nav>
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
<div id="file-metadata">
|
|
47
|
+
<nav id="file-list-section" class="section">
|
|
48
|
+
<h3 class="section-header">Defined In</h3>
|
|
49
|
+
<ul>
|
|
50
|
+
<li>lib/ropenstack/openstackservice.rb
|
|
51
|
+
</ul>
|
|
52
|
+
</nav>
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
</div>
|
|
56
|
+
|
|
57
|
+
<div id="class-metadata">
|
|
58
|
+
|
|
59
|
+
<nav id="parent-class-section" class="section">
|
|
60
|
+
<h3 class="section-header">Parent</h3>
|
|
61
|
+
|
|
62
|
+
<p class="link">Rest
|
|
63
|
+
|
|
64
|
+
</nav>
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
<!-- Method Quickref -->
|
|
68
|
+
<nav id="method-list-section" class="section">
|
|
69
|
+
<h3 class="section-header">Methods</h3>
|
|
70
|
+
|
|
71
|
+
<ul class="link-list">
|
|
72
|
+
|
|
73
|
+
<li><a href="#method-c-new">::new</a>
|
|
74
|
+
|
|
75
|
+
</ul>
|
|
76
|
+
</nav>
|
|
77
|
+
|
|
78
|
+
</div>
|
|
79
|
+
|
|
80
|
+
<div id="project-metadata">
|
|
81
|
+
|
|
82
|
+
<nav id="classindex-section" class="section project-section">
|
|
83
|
+
<h3 class="section-header">Class and Module Index</h3>
|
|
84
|
+
|
|
85
|
+
<ul class="link-list">
|
|
86
|
+
|
|
87
|
+
<li><a href="../Ropenstack.html">Ropenstack</a>
|
|
88
|
+
|
|
89
|
+
<li><a href="../Ropenstack/Cinder.html">Ropenstack::Cinder</a>
|
|
90
|
+
|
|
91
|
+
<li><a href="../Ropenstack/Glance.html">Ropenstack::Glance</a>
|
|
92
|
+
|
|
93
|
+
<li><a href="../Ropenstack/Keystone.html">Ropenstack::Keystone</a>
|
|
94
|
+
|
|
95
|
+
<li><a href="../Ropenstack/MalformedRequestError.html">Ropenstack::MalformedRequestError</a>
|
|
96
|
+
|
|
97
|
+
<li><a href="../Ropenstack/NotFoundError.html">Ropenstack::NotFoundError</a>
|
|
98
|
+
|
|
99
|
+
<li><a href="../Ropenstack/Nova.html">Ropenstack::Nova</a>
|
|
100
|
+
|
|
101
|
+
<li><a href="../Ropenstack/OpenstackService.html">Ropenstack::OpenstackService</a>
|
|
102
|
+
|
|
103
|
+
<li><a href="../Ropenstack/Quantum.html">Ropenstack::Quantum</a>
|
|
104
|
+
|
|
105
|
+
<li><a href="../Ropenstack/Rest.html">Ropenstack::Rest</a>
|
|
106
|
+
|
|
107
|
+
<li><a href="../Ropenstack/RopenstackError.html">Ropenstack::RopenstackError</a>
|
|
108
|
+
|
|
109
|
+
<li><a href="../Ropenstack/TimeoutError.html">Ropenstack::TimeoutError</a>
|
|
110
|
+
|
|
111
|
+
<li><a href="../Ropenstack/UnauthorisedError.html">Ropenstack::UnauthorisedError</a>
|
|
112
|
+
|
|
113
|
+
</ul>
|
|
114
|
+
</nav>
|
|
115
|
+
|
|
116
|
+
</div>
|
|
117
|
+
</nav>
|
|
118
|
+
|
|
119
|
+
<div id="documentation">
|
|
120
|
+
<h1 class="class">class Ropenstack::OpenstackService</h1>
|
|
121
|
+
|
|
122
|
+
<div id="description" class="description">
|
|
123
|
+
<ul><li>
|
|
124
|
+
<p>Name: <a href="OpenstackService.html">OpenstackService</a></p>
|
|
125
|
+
</li><li>
|
|
126
|
+
<p>Description: A parent class for all the openstack service classes, with
|
|
127
|
+
functions</p>
|
|
128
|
+
|
|
129
|
+
<pre>which are generic across all services.</pre>
|
|
130
|
+
</li><li>
|
|
131
|
+
<p>Author: Sam ‘Tehsmash’ Betts</p>
|
|
132
|
+
</li><li>
|
|
133
|
+
<p>Date: 01/15/2013</p>
|
|
134
|
+
</li></ul>
|
|
135
|
+
|
|
136
|
+
</div><!-- description -->
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
<!-- Methods -->
|
|
151
|
+
|
|
152
|
+
<section id="public-class-5Buntitled-5D-method-details" class="method-section section">
|
|
153
|
+
<h3 class="section-header">Public Class Methods</h3>
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
<div id="method-c-new" class="method-detail ">
|
|
157
|
+
|
|
158
|
+
<div class="method-heading">
|
|
159
|
+
<span class="method-name">new</span><span
|
|
160
|
+
class="method-args">(location, token)</span>
|
|
161
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
162
|
+
</div>
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
<div class="method-description">
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
<div class="method-source-code" id="new-source">
|
|
172
|
+
<pre><span class="ruby-comment"># File lib/ropenstack/openstackservice.rb, line 12</span>
|
|
173
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">location</span>, <span class="ruby-identifier">token</span>)
|
|
174
|
+
<span class="ruby-ivar">@location</span> = <span class="ruby-identifier">location</span>
|
|
175
|
+
<span class="ruby-ivar">@token</span> = <span class="ruby-identifier">token</span>
|
|
176
|
+
<span class="ruby-keyword">end</span></pre>
|
|
177
|
+
</div><!-- new-source -->
|
|
178
|
+
|
|
179
|
+
</div>
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
</div><!-- new-method -->
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
</section><!-- public-class-method-details -->
|
|
188
|
+
|
|
189
|
+
</section><!-- 5Buntitled-5D -->
|
|
190
|
+
|
|
191
|
+
</div><!-- documentation -->
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
<footer id="validator-badges">
|
|
195
|
+
<p><a href="http://validator.w3.org/check/referer">[Validate]</a>
|
|
196
|
+
<p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.
|
|
197
|
+
<p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
|
|
198
|
+
</footer>
|
|
199
|
+
|
|
@@ -0,0 +1,830 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
|
|
6
|
+
|
|
7
|
+
<title>class Ropenstack::Quantum - RDoc Documentation</title>
|
|
8
|
+
|
|
9
|
+
<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet">
|
|
10
|
+
|
|
11
|
+
<script type="text/javascript">
|
|
12
|
+
var rdoc_rel_prefix = "../";
|
|
13
|
+
</script>
|
|
14
|
+
|
|
15
|
+
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
|
16
|
+
<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script>
|
|
17
|
+
<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script>
|
|
18
|
+
<script type="text/javascript" charset="utf-8" src="../js/search.js"></script>
|
|
19
|
+
<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script>
|
|
20
|
+
<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<body id="top" class="class">
|
|
24
|
+
<nav id="metadata">
|
|
25
|
+
<nav id="home-section" class="section">
|
|
26
|
+
<h3 class="section-header">
|
|
27
|
+
<a href="../index.html">Home</a>
|
|
28
|
+
<a href="../table_of_contents.html#classes">Classes</a>
|
|
29
|
+
<a href="../table_of_contents.html#methods">Methods</a>
|
|
30
|
+
</h3>
|
|
31
|
+
</nav>
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
<nav id="search-section" class="section project-section" class="initially-hidden">
|
|
35
|
+
<form action="#" method="get" accept-charset="utf-8">
|
|
36
|
+
<h3 class="section-header">
|
|
37
|
+
<input type="text" name="search" placeholder="Search" id="search-field"
|
|
38
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
|
39
|
+
</h3>
|
|
40
|
+
</form>
|
|
41
|
+
|
|
42
|
+
<ul id="search-results" class="initially-hidden"></ul>
|
|
43
|
+
</nav>
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
<div id="file-metadata">
|
|
47
|
+
<nav id="file-list-section" class="section">
|
|
48
|
+
<h3 class="section-header">Defined In</h3>
|
|
49
|
+
<ul>
|
|
50
|
+
<li>lib/ropenstack/quantum.rb
|
|
51
|
+
</ul>
|
|
52
|
+
</nav>
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
</div>
|
|
56
|
+
|
|
57
|
+
<div id="class-metadata">
|
|
58
|
+
|
|
59
|
+
<nav id="parent-class-section" class="section">
|
|
60
|
+
<h3 class="section-header">Parent</h3>
|
|
61
|
+
|
|
62
|
+
<p class="link"><a href="OpenstackService.html">Ropenstack::OpenstackService</a>
|
|
63
|
+
|
|
64
|
+
</nav>
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
<!-- Method Quickref -->
|
|
68
|
+
<nav id="method-list-section" class="section">
|
|
69
|
+
<h3 class="section-header">Methods</h3>
|
|
70
|
+
|
|
71
|
+
<ul class="link-list">
|
|
72
|
+
|
|
73
|
+
<li><a href="#method-i-add_router_gateway">#add_router_gateway</a>
|
|
74
|
+
|
|
75
|
+
<li><a href="#method-i-add_router_interface">#add_router_interface</a>
|
|
76
|
+
|
|
77
|
+
<li><a href="#method-i-create_network">#create_network</a>
|
|
78
|
+
|
|
79
|
+
<li><a href="#method-i-create_port">#create_port</a>
|
|
80
|
+
|
|
81
|
+
<li><a href="#method-i-create_router">#create_router</a>
|
|
82
|
+
|
|
83
|
+
<li><a href="#method-i-create_subnet">#create_subnet</a>
|
|
84
|
+
|
|
85
|
+
<li><a href="#method-i-delete_network">#delete_network</a>
|
|
86
|
+
|
|
87
|
+
<li><a href="#method-i-delete_port">#delete_port</a>
|
|
88
|
+
|
|
89
|
+
<li><a href="#method-i-delete_router">#delete_router</a>
|
|
90
|
+
|
|
91
|
+
<li><a href="#method-i-delete_router_gateway">#delete_router_gateway</a>
|
|
92
|
+
|
|
93
|
+
<li><a href="#method-i-delete_router_interface">#delete_router_interface</a>
|
|
94
|
+
|
|
95
|
+
<li><a href="#method-i-delete_subnet">#delete_subnet</a>
|
|
96
|
+
|
|
97
|
+
<li><a href="#method-i-device_ports">#device_ports</a>
|
|
98
|
+
|
|
99
|
+
<li><a href="#method-i-move_port_to_subnets">#move_port_to_subnets</a>
|
|
100
|
+
|
|
101
|
+
<li><a href="#method-i-networks">#networks</a>
|
|
102
|
+
|
|
103
|
+
<li><a href="#method-i-ports">#ports</a>
|
|
104
|
+
|
|
105
|
+
<li><a href="#method-i-routers">#routers</a>
|
|
106
|
+
|
|
107
|
+
<li><a href="#method-i-subnets">#subnets</a>
|
|
108
|
+
|
|
109
|
+
<li><a href="#method-i-update_port">#update_port</a>
|
|
110
|
+
|
|
111
|
+
</ul>
|
|
112
|
+
</nav>
|
|
113
|
+
|
|
114
|
+
</div>
|
|
115
|
+
|
|
116
|
+
<div id="project-metadata">
|
|
117
|
+
|
|
118
|
+
<nav id="classindex-section" class="section project-section">
|
|
119
|
+
<h3 class="section-header">Class and Module Index</h3>
|
|
120
|
+
|
|
121
|
+
<ul class="link-list">
|
|
122
|
+
|
|
123
|
+
<li><a href="../Ropenstack.html">Ropenstack</a>
|
|
124
|
+
|
|
125
|
+
<li><a href="../Ropenstack/Cinder.html">Ropenstack::Cinder</a>
|
|
126
|
+
|
|
127
|
+
<li><a href="../Ropenstack/Glance.html">Ropenstack::Glance</a>
|
|
128
|
+
|
|
129
|
+
<li><a href="../Ropenstack/Keystone.html">Ropenstack::Keystone</a>
|
|
130
|
+
|
|
131
|
+
<li><a href="../Ropenstack/MalformedRequestError.html">Ropenstack::MalformedRequestError</a>
|
|
132
|
+
|
|
133
|
+
<li><a href="../Ropenstack/NotFoundError.html">Ropenstack::NotFoundError</a>
|
|
134
|
+
|
|
135
|
+
<li><a href="../Ropenstack/Nova.html">Ropenstack::Nova</a>
|
|
136
|
+
|
|
137
|
+
<li><a href="../Ropenstack/OpenstackService.html">Ropenstack::OpenstackService</a>
|
|
138
|
+
|
|
139
|
+
<li><a href="../Ropenstack/Quantum.html">Ropenstack::Quantum</a>
|
|
140
|
+
|
|
141
|
+
<li><a href="../Ropenstack/Rest.html">Ropenstack::Rest</a>
|
|
142
|
+
|
|
143
|
+
<li><a href="../Ropenstack/RopenstackError.html">Ropenstack::RopenstackError</a>
|
|
144
|
+
|
|
145
|
+
<li><a href="../Ropenstack/TimeoutError.html">Ropenstack::TimeoutError</a>
|
|
146
|
+
|
|
147
|
+
<li><a href="../Ropenstack/UnauthorisedError.html">Ropenstack::UnauthorisedError</a>
|
|
148
|
+
|
|
149
|
+
</ul>
|
|
150
|
+
</nav>
|
|
151
|
+
|
|
152
|
+
</div>
|
|
153
|
+
</nav>
|
|
154
|
+
|
|
155
|
+
<div id="documentation">
|
|
156
|
+
<h1 class="class">class Ropenstack::Quantum</h1>
|
|
157
|
+
|
|
158
|
+
<div id="description" class="description">
|
|
159
|
+
<ul><li>
|
|
160
|
+
<p>Name: <a href="Quantum.html">Quantum</a></p>
|
|
161
|
+
</li><li>
|
|
162
|
+
<p>Description: An implementation of the <a href="Quantum.html">Quantum</a>
|
|
163
|
+
V2.0 API Client in Ruby</p>
|
|
164
|
+
</li><li>
|
|
165
|
+
<p>Author: Sam ‘Tehsmash’ Betts</p>
|
|
166
|
+
</li><li>
|
|
167
|
+
<p>Date: 01/15/2013</p>
|
|
168
|
+
</li></ul>
|
|
169
|
+
|
|
170
|
+
</div><!-- description -->
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
<!-- Methods -->
|
|
185
|
+
|
|
186
|
+
<section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
|
|
187
|
+
<h3 class="section-header">Public Instance Methods</h3>
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
<div id="method-i-add_router_gateway" class="method-detail ">
|
|
191
|
+
|
|
192
|
+
<div class="method-heading">
|
|
193
|
+
<span class="method-name">add_router_gateway</span><span
|
|
194
|
+
class="method-args">(router, external_gateway_info)</span>
|
|
195
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
196
|
+
</div>
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
<div class="method-description">
|
|
200
|
+
|
|
201
|
+
<p>Enable external connectivity through this router by connecting it to an
|
|
202
|
+
“external network”</p>
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
<div class="method-source-code" id="add_router_gateway-source">
|
|
207
|
+
<pre><span class="ruby-comment"># File lib/ropenstack/quantum.rb, line 115</span>
|
|
208
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">add_router_gateway</span>(<span class="ruby-identifier">router</span>, <span class="ruby-identifier">external_gateway_info</span>)
|
|
209
|
+
<span class="ruby-identifier">data</span> = { <span class="ruby-string">'router'</span> =<span class="ruby-operator">></span> {<span class="ruby-string">'external_gateway_info'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">external_gateway_info</span>}}
|
|
210
|
+
<span class="ruby-keyword">return</span> <span class="ruby-identifier">put_request</span>(<span class="ruby-identifier">address</span>(<span class="ruby-string">"routers/"</span><span class="ruby-operator">+</span><span class="ruby-identifier">router</span>), <span class="ruby-identifier">data</span>, <span class="ruby-ivar">@token</span>)
|
|
211
|
+
<span class="ruby-keyword">end</span></pre>
|
|
212
|
+
</div><!-- add_router_gateway-source -->
|
|
213
|
+
|
|
214
|
+
</div>
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
</div><!-- add_router_gateway-method -->
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
<div id="method-i-add_router_interface" class="method-detail ">
|
|
223
|
+
|
|
224
|
+
<div class="method-heading">
|
|
225
|
+
<span class="method-name">add_router_interface</span><span
|
|
226
|
+
class="method-args">(router, subnet)</span>
|
|
227
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
228
|
+
</div>
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
<div class="method-description">
|
|
232
|
+
|
|
233
|
+
<p>Connect a router to a subnet, given router id and subnet id.</p>
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
<div class="method-source-code" id="add_router_interface-source">
|
|
238
|
+
<pre><span class="ruby-comment"># File lib/ropenstack/quantum.rb, line 106</span>
|
|
239
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">add_router_interface</span>(<span class="ruby-identifier">router</span>, <span class="ruby-identifier">subnet</span>)
|
|
240
|
+
<span class="ruby-identifier">data</span> = { <span class="ruby-string">'subnet_id'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">subnet</span> }
|
|
241
|
+
<span class="ruby-keyword">return</span> <span class="ruby-identifier">put_request</span>(<span class="ruby-identifier">address</span>(<span class="ruby-string">"routers/"</span><span class="ruby-operator">+</span><span class="ruby-identifier">router</span><span class="ruby-operator">+</span><span class="ruby-string">"/add_router_interface"</span>), <span class="ruby-identifier">data</span>, <span class="ruby-ivar">@token</span>)
|
|
242
|
+
<span class="ruby-keyword">end</span></pre>
|
|
243
|
+
</div><!-- add_router_interface-source -->
|
|
244
|
+
|
|
245
|
+
</div>
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
</div><!-- add_router_interface-method -->
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
<div id="method-i-create_network" class="method-detail ">
|
|
254
|
+
|
|
255
|
+
<div class="method-heading">
|
|
256
|
+
<span class="method-name">create_network</span><span
|
|
257
|
+
class="method-args">(name, tenant, admin_state_up = true)</span>
|
|
258
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
259
|
+
</div>
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
<div class="method-description">
|
|
263
|
+
|
|
264
|
+
<p>Create a new network on Openstack given a name and tenant id.</p>
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
<div class="method-source-code" id="create_network-source">
|
|
269
|
+
<pre><span class="ruby-comment"># File lib/ropenstack/quantum.rb, line 47</span>
|
|
270
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">create_network</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">tenant</span>, <span class="ruby-identifier">admin_state_up</span> = <span class="ruby-keyword">true</span>)
|
|
271
|
+
<span class="ruby-identifier">data</span> = {
|
|
272
|
+
<span class="ruby-string">'network'</span> =<span class="ruby-operator">></span> {
|
|
273
|
+
<span class="ruby-string">'name'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">name</span>,
|
|
274
|
+
<span class="ruby-string">'tenant_id'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">tenant</span>,
|
|
275
|
+
<span class="ruby-string">'admin_state_up'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">admin_state_up</span>
|
|
276
|
+
}
|
|
277
|
+
}
|
|
278
|
+
<span class="ruby-keyword">return</span> <span class="ruby-identifier">post_request</span>(<span class="ruby-identifier">address</span>(<span class="ruby-string">"networks"</span>), <span class="ruby-identifier">data</span>, <span class="ruby-ivar">@token</span>)
|
|
279
|
+
<span class="ruby-keyword">end</span></pre>
|
|
280
|
+
</div><!-- create_network-source -->
|
|
281
|
+
|
|
282
|
+
</div>
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
</div><!-- create_network-method -->
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
<div id="method-i-create_port" class="method-detail ">
|
|
291
|
+
|
|
292
|
+
<div class="method-heading">
|
|
293
|
+
<span class="method-name">create_port</span><span
|
|
294
|
+
class="method-args">(network, device, subnet = nil)</span>
|
|
295
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
296
|
+
</div>
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
<div class="method-description">
|
|
300
|
+
|
|
301
|
+
<p>Create a new port given network and device ids, optional parameter subnet
|
|
302
|
+
id allows for scoping the port to a single subnet.</p>
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
<div class="method-source-code" id="create_port-source">
|
|
307
|
+
<pre><span class="ruby-comment"># File lib/ropenstack/quantum.rb, line 77</span>
|
|
308
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">create_port</span>(<span class="ruby-identifier">network</span>, <span class="ruby-identifier">device</span>, <span class="ruby-identifier">subnet</span> = <span class="ruby-keyword">nil</span>)
|
|
309
|
+
<span class="ruby-identifier">data</span> = {
|
|
310
|
+
<span class="ruby-string">'port'</span> =<span class="ruby-operator">></span> {
|
|
311
|
+
<span class="ruby-string">'network_id'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">network</span>,
|
|
312
|
+
<span class="ruby-string">'device_id'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">device</span>,
|
|
313
|
+
}
|
|
314
|
+
}
|
|
315
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">subnet</span>
|
|
316
|
+
<span class="ruby-identifier">data</span>[<span class="ruby-string">'port'</span>][<span class="ruby-string">'fixed_ips'</span>] = [{<span class="ruby-string">'subnet_id'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">subnet</span>}]
|
|
317
|
+
<span class="ruby-keyword">end</span>
|
|
318
|
+
<span class="ruby-keyword">return</span> <span class="ruby-identifier">post_request</span>(<span class="ruby-identifier">address</span>(<span class="ruby-string">"ports"</span>), <span class="ruby-identifier">data</span>, <span class="ruby-ivar">@token</span>)
|
|
319
|
+
<span class="ruby-keyword">end</span></pre>
|
|
320
|
+
</div><!-- create_port-source -->
|
|
321
|
+
|
|
322
|
+
</div>
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
</div><!-- create_port-method -->
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
<div id="method-i-create_router" class="method-detail ">
|
|
331
|
+
|
|
332
|
+
<div class="method-heading">
|
|
333
|
+
<span class="method-name">create_router</span><span
|
|
334
|
+
class="method-args">(name, admin_state_up = true)</span>
|
|
335
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
336
|
+
</div>
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
<div class="method-description">
|
|
340
|
+
|
|
341
|
+
<p>Create a new router with a given name.</p>
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
<div class="method-source-code" id="create_router-source">
|
|
346
|
+
<pre><span class="ruby-comment"># File lib/ropenstack/quantum.rb, line 93</span>
|
|
347
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">create_router</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">admin_state_up</span> = <span class="ruby-keyword">true</span>)
|
|
348
|
+
<span class="ruby-identifier">data</span> = {
|
|
349
|
+
<span class="ruby-string">'router'</span> =<span class="ruby-operator">></span>{
|
|
350
|
+
<span class="ruby-string">'name'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">name</span>,
|
|
351
|
+
<span class="ruby-string">'admin_state_up'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">admin_state_up</span>,
|
|
352
|
+
}
|
|
353
|
+
}
|
|
354
|
+
<span class="ruby-keyword">return</span> <span class="ruby-identifier">post_request</span>(<span class="ruby-identifier">address</span>(<span class="ruby-string">"routers"</span>), <span class="ruby-identifier">data</span>, <span class="ruby-ivar">@token</span>)
|
|
355
|
+
<span class="ruby-keyword">end</span></pre>
|
|
356
|
+
</div><!-- create_router-source -->
|
|
357
|
+
|
|
358
|
+
</div>
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
</div><!-- create_router-method -->
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
<div id="method-i-create_subnet" class="method-detail ">
|
|
367
|
+
|
|
368
|
+
<div class="method-heading">
|
|
369
|
+
<span class="method-name">create_subnet</span><span
|
|
370
|
+
class="method-args">(network, cidr)</span>
|
|
371
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
372
|
+
</div>
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
<div class="method-description">
|
|
376
|
+
|
|
377
|
+
<p>Create a new ipv4 subnet in a network, given a network id, and a IP range
|
|
378
|
+
in CIDR format.</p>
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
<div class="method-source-code" id="create_subnet-source">
|
|
383
|
+
<pre><span class="ruby-comment"># File lib/ropenstack/quantum.rb, line 62</span>
|
|
384
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">create_subnet</span>(<span class="ruby-identifier">network</span>, <span class="ruby-identifier">cidr</span>)
|
|
385
|
+
<span class="ruby-identifier">data</span> = {
|
|
386
|
+
<span class="ruby-string">'subnet'</span> =<span class="ruby-operator">></span> {
|
|
387
|
+
<span class="ruby-string">'network_id'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">network</span>,
|
|
388
|
+
<span class="ruby-string">'ip_version'</span> =<span class="ruby-operator">></span> <span class="ruby-value">4</span>,
|
|
389
|
+
<span class="ruby-string">'cidr'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">cidr</span>
|
|
390
|
+
}
|
|
391
|
+
}
|
|
392
|
+
<span class="ruby-keyword">return</span> <span class="ruby-identifier">post_request</span>(<span class="ruby-identifier">address</span>(<span class="ruby-string">"subnets"</span>), <span class="ruby-identifier">data</span>, <span class="ruby-ivar">@token</span>)
|
|
393
|
+
<span class="ruby-keyword">end</span></pre>
|
|
394
|
+
</div><!-- create_subnet-source -->
|
|
395
|
+
|
|
396
|
+
</div>
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
|
|
400
|
+
|
|
401
|
+
</div><!-- create_subnet-method -->
|
|
402
|
+
|
|
403
|
+
|
|
404
|
+
<div id="method-i-delete_network" class="method-detail ">
|
|
405
|
+
|
|
406
|
+
<div class="method-heading">
|
|
407
|
+
<span class="method-name">delete_network</span><span
|
|
408
|
+
class="method-args">(network)</span>
|
|
409
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
410
|
+
</div>
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
<div class="method-description">
|
|
414
|
+
|
|
415
|
+
<p>Delete a network given a network id.</p>
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
|
|
419
|
+
<div class="method-source-code" id="delete_network-source">
|
|
420
|
+
<pre><span class="ruby-comment"># File lib/ropenstack/quantum.rb, line 149</span>
|
|
421
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">delete_network</span>(<span class="ruby-identifier">network</span>)
|
|
422
|
+
<span class="ruby-keyword">return</span> <span class="ruby-identifier">delete_request</span>(<span class="ruby-identifier">address</span>(<span class="ruby-string">"networks/"</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">network</span>), <span class="ruby-ivar">@token</span>)
|
|
423
|
+
<span class="ruby-keyword">end</span></pre>
|
|
424
|
+
</div><!-- delete_network-source -->
|
|
425
|
+
|
|
426
|
+
</div>
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
|
|
431
|
+
</div><!-- delete_network-method -->
|
|
432
|
+
|
|
433
|
+
|
|
434
|
+
<div id="method-i-delete_port" class="method-detail ">
|
|
435
|
+
|
|
436
|
+
<div class="method-heading">
|
|
437
|
+
<span class="method-name">delete_port</span><span
|
|
438
|
+
class="method-args">(port)</span>
|
|
439
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
440
|
+
</div>
|
|
441
|
+
|
|
442
|
+
|
|
443
|
+
<div class="method-description">
|
|
444
|
+
|
|
445
|
+
<p>Delete a port given a port id.</p>
|
|
446
|
+
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
<div class="method-source-code" id="delete_port-source">
|
|
450
|
+
<pre><span class="ruby-comment"># File lib/ropenstack/quantum.rb, line 142</span>
|
|
451
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">delete_port</span>(<span class="ruby-identifier">port</span>)
|
|
452
|
+
<span class="ruby-keyword">return</span> <span class="ruby-identifier">delete_request</span>(<span class="ruby-identifier">address</span>(<span class="ruby-string">"ports/"</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">port</span>), <span class="ruby-ivar">@token</span>)
|
|
453
|
+
<span class="ruby-keyword">end</span></pre>
|
|
454
|
+
</div><!-- delete_port-source -->
|
|
455
|
+
|
|
456
|
+
</div>
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
</div><!-- delete_port-method -->
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
<div id="method-i-delete_router" class="method-detail ">
|
|
465
|
+
|
|
466
|
+
<div class="method-heading">
|
|
467
|
+
<span class="method-name">delete_router</span><span
|
|
468
|
+
class="method-args">(router)</span>
|
|
469
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
470
|
+
</div>
|
|
471
|
+
|
|
472
|
+
|
|
473
|
+
<div class="method-description">
|
|
474
|
+
|
|
475
|
+
<p>Delete a router given a routers id.</p>
|
|
476
|
+
|
|
477
|
+
|
|
478
|
+
|
|
479
|
+
<div class="method-source-code" id="delete_router-source">
|
|
480
|
+
<pre><span class="ruby-comment"># File lib/ropenstack/quantum.rb, line 163</span>
|
|
481
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">delete_router</span>(<span class="ruby-identifier">router</span>)
|
|
482
|
+
<span class="ruby-keyword">return</span> <span class="ruby-identifier">delete_request</span>(<span class="ruby-identifier">address</span>(<span class="ruby-string">"routers/"</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">router</span>), <span class="ruby-ivar">@token</span>)
|
|
483
|
+
<span class="ruby-keyword">end</span></pre>
|
|
484
|
+
</div><!-- delete_router-source -->
|
|
485
|
+
|
|
486
|
+
</div>
|
|
487
|
+
|
|
488
|
+
|
|
489
|
+
|
|
490
|
+
|
|
491
|
+
</div><!-- delete_router-method -->
|
|
492
|
+
|
|
493
|
+
|
|
494
|
+
<div id="method-i-delete_router_gateway" class="method-detail ">
|
|
495
|
+
|
|
496
|
+
<div class="method-heading">
|
|
497
|
+
<span class="method-name">delete_router_gateway</span><span
|
|
498
|
+
class="method-args">(router)</span>
|
|
499
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
500
|
+
</div>
|
|
501
|
+
|
|
502
|
+
|
|
503
|
+
<div class="method-description">
|
|
504
|
+
|
|
505
|
+
<p>Clear a routers external gateway information given a router id.</p>
|
|
506
|
+
|
|
507
|
+
|
|
508
|
+
|
|
509
|
+
<div class="method-source-code" id="delete_router_gateway-source">
|
|
510
|
+
<pre><span class="ruby-comment"># File lib/ropenstack/quantum.rb, line 170</span>
|
|
511
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">delete_router_gateway</span>(<span class="ruby-identifier">router</span>)
|
|
512
|
+
<span class="ruby-identifier">data</span> = { <span class="ruby-string">'router'</span> =<span class="ruby-operator">></span> {<span class="ruby-string">'external_gateway_info'</span> =<span class="ruby-operator">></span> <span class="ruby-keyword">nil</span>}}
|
|
513
|
+
<span class="ruby-keyword">return</span> <span class="ruby-identifier">put_request</span>(<span class="ruby-identifier">address</span>(<span class="ruby-string">'routers/'</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">router</span>), <span class="ruby-identifier">data</span>, <span class="ruby-ivar">@token</span>)
|
|
514
|
+
<span class="ruby-keyword">end</span></pre>
|
|
515
|
+
</div><!-- delete_router_gateway-source -->
|
|
516
|
+
|
|
517
|
+
</div>
|
|
518
|
+
|
|
519
|
+
|
|
520
|
+
|
|
521
|
+
|
|
522
|
+
</div><!-- delete_router_gateway-method -->
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
<div id="method-i-delete_router_interface" class="method-detail ">
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
<div class="method-heading">
|
|
529
|
+
<span class="method-callseq">
|
|
530
|
+
delete_router_interface(router_id, subnet_id, "subnet")
|
|
531
|
+
</span>
|
|
532
|
+
|
|
533
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
534
|
+
|
|
535
|
+
</div>
|
|
536
|
+
|
|
537
|
+
<div class="method-heading">
|
|
538
|
+
<span class="method-callseq">
|
|
539
|
+
delete_router_interface(router_id, port_id, "port")
|
|
540
|
+
</span>
|
|
541
|
+
|
|
542
|
+
</div>
|
|
543
|
+
|
|
544
|
+
|
|
545
|
+
|
|
546
|
+
<div class="method-description">
|
|
547
|
+
|
|
548
|
+
<p>Delete a connection between a subnet and router given either port or subnet
|
|
549
|
+
ids.</p>
|
|
550
|
+
|
|
551
|
+
|
|
552
|
+
|
|
553
|
+
<div class="method-source-code" id="delete_router_interface-source">
|
|
554
|
+
<pre><span class="ruby-comment"># File lib/ropenstack/quantum.rb, line 183</span>
|
|
555
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">delete_router_interface</span>(<span class="ruby-identifier">router</span>, <span class="ruby-identifier">id</span>, <span class="ruby-identifier">type</span>)
|
|
556
|
+
<span class="ruby-identifier">data</span> = <span class="ruby-keyword">case</span> <span class="ruby-identifier">type</span>
|
|
557
|
+
<span class="ruby-keyword">when</span> <span class="ruby-string">'port'</span> <span class="ruby-keyword">then</span> { <span class="ruby-string">'port_id'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">id</span> }
|
|
558
|
+
<span class="ruby-keyword">when</span> <span class="ruby-string">'subnet'</span> <span class="ruby-keyword">then</span> { <span class="ruby-string">'subnet_id'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">id</span> }
|
|
559
|
+
<span class="ruby-keyword">else</span> <span class="ruby-identifier">raise</span> <span class="ruby-string">"Invalid Interface Type"</span>
|
|
560
|
+
<span class="ruby-keyword">end</span>
|
|
561
|
+
<span class="ruby-keyword">return</span> <span class="ruby-identifier">put_request</span>(<span class="ruby-identifier">address</span>(<span class="ruby-string">"routers/"</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">router</span> <span class="ruby-operator">+</span> <span class="ruby-string">"/remove_router_interface"</span>), <span class="ruby-identifier">data</span>, <span class="ruby-ivar">@token</span>)
|
|
562
|
+
<span class="ruby-keyword">end</span></pre>
|
|
563
|
+
</div><!-- delete_router_interface-source -->
|
|
564
|
+
|
|
565
|
+
</div>
|
|
566
|
+
|
|
567
|
+
|
|
568
|
+
|
|
569
|
+
|
|
570
|
+
</div><!-- delete_router_interface-method -->
|
|
571
|
+
|
|
572
|
+
|
|
573
|
+
<div id="method-i-delete_subnet" class="method-detail ">
|
|
574
|
+
|
|
575
|
+
<div class="method-heading">
|
|
576
|
+
<span class="method-name">delete_subnet</span><span
|
|
577
|
+
class="method-args">(subnet)</span>
|
|
578
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
579
|
+
</div>
|
|
580
|
+
|
|
581
|
+
|
|
582
|
+
<div class="method-description">
|
|
583
|
+
|
|
584
|
+
<p>Delete a subnet given a subnet id</p>
|
|
585
|
+
|
|
586
|
+
|
|
587
|
+
|
|
588
|
+
<div class="method-source-code" id="delete_subnet-source">
|
|
589
|
+
<pre><span class="ruby-comment"># File lib/ropenstack/quantum.rb, line 156</span>
|
|
590
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">delete_subnet</span>(<span class="ruby-identifier">subnet</span>)
|
|
591
|
+
<span class="ruby-keyword">return</span> <span class="ruby-identifier">delete_request</span>(<span class="ruby-identifier">address</span>(<span class="ruby-string">"subnets/"</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">subnet</span>), <span class="ruby-ivar">@token</span>)
|
|
592
|
+
<span class="ruby-keyword">end</span></pre>
|
|
593
|
+
</div><!-- delete_subnet-source -->
|
|
594
|
+
|
|
595
|
+
</div>
|
|
596
|
+
|
|
597
|
+
|
|
598
|
+
|
|
599
|
+
|
|
600
|
+
</div><!-- delete_subnet-method -->
|
|
601
|
+
|
|
602
|
+
|
|
603
|
+
<div id="method-i-device_ports" class="method-detail ">
|
|
604
|
+
|
|
605
|
+
<div class="method-heading">
|
|
606
|
+
<span class="method-name">device_ports</span><span
|
|
607
|
+
class="method-args">(device_id)</span>
|
|
608
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
609
|
+
</div>
|
|
610
|
+
|
|
611
|
+
|
|
612
|
+
<div class="method-description">
|
|
613
|
+
|
|
614
|
+
<p>Get a list of ports specific to a device_id</p>
|
|
615
|
+
|
|
616
|
+
|
|
617
|
+
|
|
618
|
+
<div class="method-source-code" id="device_ports-source">
|
|
619
|
+
<pre><span class="ruby-comment"># File lib/ropenstack/quantum.rb, line 33</span>
|
|
620
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">device_ports</span>(<span class="ruby-identifier">device_id</span>)
|
|
621
|
+
<span class="ruby-keyword">return</span> <span class="ruby-identifier">get_request</span>(<span class="ruby-identifier">address</span>(<span class="ruby-node">"ports?device_id=#{device_id}"</span>), <span class="ruby-ivar">@token</span>)
|
|
622
|
+
<span class="ruby-keyword">end</span></pre>
|
|
623
|
+
</div><!-- device_ports-source -->
|
|
624
|
+
|
|
625
|
+
</div>
|
|
626
|
+
|
|
627
|
+
|
|
628
|
+
|
|
629
|
+
|
|
630
|
+
</div><!-- device_ports-method -->
|
|
631
|
+
|
|
632
|
+
|
|
633
|
+
<div id="method-i-move_port_to_subnets" class="method-detail ">
|
|
634
|
+
|
|
635
|
+
<div class="method-heading">
|
|
636
|
+
<span class="method-name">move_port_to_subnets</span><span
|
|
637
|
+
class="method-args">(port_id, subnet_ids)</span>
|
|
638
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
639
|
+
</div>
|
|
640
|
+
|
|
641
|
+
|
|
642
|
+
<div class="method-description">
|
|
643
|
+
|
|
644
|
+
<p>Weird function for adding a port to multiple subnets if nessessary.</p>
|
|
645
|
+
|
|
646
|
+
|
|
647
|
+
|
|
648
|
+
<div class="method-source-code" id="move_port_to_subnets-source">
|
|
649
|
+
<pre><span class="ruby-comment"># File lib/ropenstack/quantum.rb, line 131</span>
|
|
650
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">move_port_to_subnets</span>(<span class="ruby-identifier">port_id</span>, <span class="ruby-identifier">subnet_ids</span>)
|
|
651
|
+
<span class="ruby-identifier">id_list</span> = <span class="ruby-constant">Array</span>.<span class="ruby-identifier">new</span>()
|
|
652
|
+
<span class="ruby-identifier">subnet_ids</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">id</span><span class="ruby-operator">|</span>
|
|
653
|
+
<span class="ruby-identifier">id_list</span> <span class="ruby-operator"><<</span> { <span class="ruby-string">"subnet_id"</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">id</span> }
|
|
654
|
+
<span class="ruby-keyword">end</span>
|
|
655
|
+
<span class="ruby-keyword">return</span> <span class="ruby-identifier">update_port</span>(<span class="ruby-identifier">port_id</span>, <span class="ruby-identifier">id_list</span>)
|
|
656
|
+
<span class="ruby-keyword">end</span></pre>
|
|
657
|
+
</div><!-- move_port_to_subnets-source -->
|
|
658
|
+
|
|
659
|
+
</div>
|
|
660
|
+
|
|
661
|
+
|
|
662
|
+
|
|
663
|
+
|
|
664
|
+
</div><!-- move_port_to_subnets-method -->
|
|
665
|
+
|
|
666
|
+
|
|
667
|
+
<div id="method-i-networks" class="method-detail ">
|
|
668
|
+
|
|
669
|
+
<div class="method-heading">
|
|
670
|
+
<span class="method-name">networks</span><span
|
|
671
|
+
class="method-args">()</span>
|
|
672
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
673
|
+
</div>
|
|
674
|
+
|
|
675
|
+
|
|
676
|
+
<div class="method-description">
|
|
677
|
+
|
|
678
|
+
<p>Get a list of a tenants networks</p>
|
|
679
|
+
|
|
680
|
+
|
|
681
|
+
|
|
682
|
+
<div class="method-source-code" id="networks-source">
|
|
683
|
+
<pre><span class="ruby-comment"># File lib/ropenstack/quantum.rb, line 12</span>
|
|
684
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">networks</span>
|
|
685
|
+
<span class="ruby-keyword">return</span> <span class="ruby-identifier">get_request</span>(<span class="ruby-identifier">address</span>(<span class="ruby-string">"networks"</span>), <span class="ruby-ivar">@token</span>)
|
|
686
|
+
<span class="ruby-keyword">end</span></pre>
|
|
687
|
+
</div><!-- networks-source -->
|
|
688
|
+
|
|
689
|
+
</div>
|
|
690
|
+
|
|
691
|
+
|
|
692
|
+
|
|
693
|
+
|
|
694
|
+
</div><!-- networks-method -->
|
|
695
|
+
|
|
696
|
+
|
|
697
|
+
<div id="method-i-ports" class="method-detail ">
|
|
698
|
+
|
|
699
|
+
<div class="method-heading">
|
|
700
|
+
<span class="method-name">ports</span><span
|
|
701
|
+
class="method-args">()</span>
|
|
702
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
703
|
+
</div>
|
|
704
|
+
|
|
705
|
+
|
|
706
|
+
<div class="method-description">
|
|
707
|
+
|
|
708
|
+
<p>Get a list of ports</p>
|
|
709
|
+
|
|
710
|
+
|
|
711
|
+
|
|
712
|
+
<div class="method-source-code" id="ports-source">
|
|
713
|
+
<pre><span class="ruby-comment"># File lib/ropenstack/quantum.rb, line 26</span>
|
|
714
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">ports</span>
|
|
715
|
+
<span class="ruby-keyword">return</span> <span class="ruby-identifier">get_request</span>(<span class="ruby-identifier">address</span>(<span class="ruby-string">"ports"</span>), <span class="ruby-ivar">@token</span>)
|
|
716
|
+
<span class="ruby-keyword">end</span></pre>
|
|
717
|
+
</div><!-- ports-source -->
|
|
718
|
+
|
|
719
|
+
</div>
|
|
720
|
+
|
|
721
|
+
|
|
722
|
+
|
|
723
|
+
|
|
724
|
+
</div><!-- ports-method -->
|
|
725
|
+
|
|
726
|
+
|
|
727
|
+
<div id="method-i-routers" class="method-detail ">
|
|
728
|
+
|
|
729
|
+
<div class="method-heading">
|
|
730
|
+
<span class="method-name">routers</span><span
|
|
731
|
+
class="method-args">()</span>
|
|
732
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
733
|
+
</div>
|
|
734
|
+
|
|
735
|
+
|
|
736
|
+
<div class="method-description">
|
|
737
|
+
|
|
738
|
+
<p>Retrieve routers owned by the tenant making the request</p>
|
|
739
|
+
|
|
740
|
+
|
|
741
|
+
|
|
742
|
+
<div class="method-source-code" id="routers-source">
|
|
743
|
+
<pre><span class="ruby-comment"># File lib/ropenstack/quantum.rb, line 40</span>
|
|
744
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">routers</span>
|
|
745
|
+
<span class="ruby-keyword">return</span> <span class="ruby-identifier">get_request</span>(<span class="ruby-identifier">address</span>(<span class="ruby-string">"routers"</span>), <span class="ruby-ivar">@token</span>)
|
|
746
|
+
<span class="ruby-keyword">end</span></pre>
|
|
747
|
+
</div><!-- routers-source -->
|
|
748
|
+
|
|
749
|
+
</div>
|
|
750
|
+
|
|
751
|
+
|
|
752
|
+
|
|
753
|
+
|
|
754
|
+
</div><!-- routers-method -->
|
|
755
|
+
|
|
756
|
+
|
|
757
|
+
<div id="method-i-subnets" class="method-detail ">
|
|
758
|
+
|
|
759
|
+
<div class="method-heading">
|
|
760
|
+
<span class="method-name">subnets</span><span
|
|
761
|
+
class="method-args">()</span>
|
|
762
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
763
|
+
</div>
|
|
764
|
+
|
|
765
|
+
|
|
766
|
+
<div class="method-description">
|
|
767
|
+
|
|
768
|
+
<p>Get a list of subnets</p>
|
|
769
|
+
|
|
770
|
+
|
|
771
|
+
|
|
772
|
+
<div class="method-source-code" id="subnets-source">
|
|
773
|
+
<pre><span class="ruby-comment"># File lib/ropenstack/quantum.rb, line 19</span>
|
|
774
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">subnets</span>
|
|
775
|
+
<span class="ruby-keyword">return</span> <span class="ruby-identifier">get_request</span>(<span class="ruby-identifier">address</span>(<span class="ruby-string">"subnets"</span>), <span class="ruby-ivar">@token</span>)
|
|
776
|
+
<span class="ruby-keyword">end</span></pre>
|
|
777
|
+
</div><!-- subnets-source -->
|
|
778
|
+
|
|
779
|
+
</div>
|
|
780
|
+
|
|
781
|
+
|
|
782
|
+
|
|
783
|
+
|
|
784
|
+
</div><!-- subnets-method -->
|
|
785
|
+
|
|
786
|
+
|
|
787
|
+
<div id="method-i-update_port" class="method-detail ">
|
|
788
|
+
|
|
789
|
+
<div class="method-heading">
|
|
790
|
+
<span class="method-name">update_port</span><span
|
|
791
|
+
class="method-args">(port, fixed_ips)</span>
|
|
792
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
793
|
+
</div>
|
|
794
|
+
|
|
795
|
+
|
|
796
|
+
<div class="method-description">
|
|
797
|
+
|
|
798
|
+
<p>Update a specific ports fixed_ips, including subnet and ip data.</p>
|
|
799
|
+
|
|
800
|
+
|
|
801
|
+
|
|
802
|
+
<div class="method-source-code" id="update_port-source">
|
|
803
|
+
<pre><span class="ruby-comment"># File lib/ropenstack/quantum.rb, line 123</span>
|
|
804
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">update_port</span>(<span class="ruby-identifier">port</span>, <span class="ruby-identifier">fixed_ips</span>)
|
|
805
|
+
<span class="ruby-identifier">data</span> = { <span class="ruby-string">'port'</span> =<span class="ruby-operator">></span> { <span class="ruby-string">'fixed_ips'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">fixed_ips</span> } }
|
|
806
|
+
<span class="ruby-keyword">return</span> <span class="ruby-identifier">put_request</span>(<span class="ruby-identifier">address</span>(<span class="ruby-string">"ports/"</span><span class="ruby-operator">+</span><span class="ruby-identifier">port</span>), <span class="ruby-identifier">data</span>, <span class="ruby-ivar">@token</span>)
|
|
807
|
+
<span class="ruby-keyword">end</span></pre>
|
|
808
|
+
</div><!-- update_port-source -->
|
|
809
|
+
|
|
810
|
+
</div>
|
|
811
|
+
|
|
812
|
+
|
|
813
|
+
|
|
814
|
+
|
|
815
|
+
</div><!-- update_port-method -->
|
|
816
|
+
|
|
817
|
+
|
|
818
|
+
</section><!-- public-instance-method-details -->
|
|
819
|
+
|
|
820
|
+
</section><!-- 5Buntitled-5D -->
|
|
821
|
+
|
|
822
|
+
</div><!-- documentation -->
|
|
823
|
+
|
|
824
|
+
|
|
825
|
+
<footer id="validator-badges">
|
|
826
|
+
<p><a href="http://validator.w3.org/check/referer">[Validate]</a>
|
|
827
|
+
<p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.
|
|
828
|
+
<p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
|
|
829
|
+
</footer>
|
|
830
|
+
|