summaryrefslogtreecommitdiff
path: root/doc/source/cli/command-objects/floating-ip.rst
blob: d9ed2307c32cfa378385a63a642c6417d93b7aca (plain)
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
===========
floating ip
===========

Compute v2, Network v2

floating ip create
------------------

Create floating IP

.. program:: floating ip create
.. code:: bash

    openstack floating ip create
        [--subnet <subnet>]
        [--port <port>]
        [--floating-ip-address <ip-address>]
        [--fixed-ip-address <ip-address>]
        [--description <description>]
        [--qos-policy <qos-policy>]
        [--project <project> [--project-domain <project-domain>]]
        <network>

.. option:: --subnet <subnet>

    Subnet on which you want to create the floating IP (name or ID)
    *Network version 2 only*

.. option:: --port <port>

    Port to be associated with the floating IP (name or ID)
    *Network version 2 only*

.. option:: --floating-ip-address <ip-address>

    Floating IP address
    *Network version 2 only*

.. option:: --fixed-ip-address <ip-address>

    Fixed IP address mapped to the floating IP
    *Network version 2 only*

.. option:: --description <description>

    Set floating IP description
    *Network version 2 only*

.. option:: --qos-policy <qos-policy>

    QoS policy to attach to the floating IP (name or ID)

    *Network version 2 only*

.. option:: --project <project>

    Owner's project (name or ID)

    *Network version 2 only*

.. option:: --project-domain <project-domain>

    Domain the project belongs to (name or ID).
    This can be used in case collisions between project names exist.

    *Network version 2 only*

.. describe:: <network>

    Network to allocate floating IP from (name or ID)

floating ip delete
------------------

Delete floating IP(s)

.. program:: floating ip delete
.. code:: bash

    openstack floating ip delete <floating-ip> [<floating-ip> ...]

.. describe:: <floating-ip>

    Floating IP(s) to delete (IP address or ID)

floating ip list
----------------

List floating IP(s)

.. program:: floating ip list
.. code:: bash

    openstack floating ip list
        [--network <network>]
        [--port <port>]
        [--fixed-ip-address <ip-address>]
        [--long]
        [--status <status>]
        [--project <project> [--project-domain <project-domain>]]
        [--router <router>]

.. option:: --network <network>

    List floating IP(s) according to given network (name or ID)

    *Network version 2 only*

.. option:: --port <port>

    List floating IP(s) according to given port (name or ID)

    *Network version 2 only*

.. option:: --fixed-ip-address <ip-address>

    List floating IP(s) according to given fixed IP address

    *Network version 2 only*

.. option:: --long

    List additional fields in output

    *Network version 2 only*

.. option:: --status <status>

    List floating IP(s) according to given status ('ACTIVE', 'DOWN')

    *Network version 2 only*

.. option:: --project <project>

    List floating IP(s) according to given project (name or ID)

    *Network version 2 only*

.. option:: --project-domain <project-domain>

    Domain the project belongs to (name or ID). This can
    be used in case collisions between project names exist.

    *Network version 2 only*

.. option:: --router <router>

    List floating IP(s) according to given router (name or ID)

    *Network version 2 only*

floating ip set
---------------

Set floating IP properties

.. program:: floating ip set
.. code:: bash

    openstack floating ip set
        --port <port>
        [--fixed-ip-address <ip-address>]
        [--qos-policy <qos-policy> | --no-qos-policy]
        <floating-ip>

.. option:: --port <port>

    Assocaite the floating IP with port (name or ID)

.. option:: --fixed-ip-address <ip-address>

    Fixed IP of the port (required only if port has multiple IPs)

.. option:: --qos-policy <qos-policy>

    Attach QoS policy to the floating IP (name or ID)

.. option:: --no-qos-policy

    Remove the QoS policy attached to the floating IP

.. _floating_ip_set-floating-ip:
.. describe:: <floating-ip>

    Floating IP to associate (IP address or ID)

floating ip show
----------------

Display floating IP details

.. program:: floating ip show
.. code:: bash

    openstack floating ip show <floating-ip>

.. describe:: <floating-ip>

    Floating IP to display (IP address or ID)

floating ip unset
-----------------

Unset floating IP Properties

.. program:: floating ip unset
.. code:: bash

    openstack floating ip unset
        --port
        --qos-policy
        <floating-ip>

.. option:: --port

    Disassociate any port associated with the floating IP

.. option:: --qos-policy

    Remove the QoS policy attached to the floating IP

.. _floating_ip_unset-floating-ip:
.. describe:: <floating-ip>

    Floating IP to disassociate (IP address or ID)