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

Compute v2, Network v2

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

Create floating IP

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

    os floating ip create
        [--subnet <subnet>]
        [--port <port>]
        [--floating-ip-address <floating-ip-address>]
        [--fixed-ip-address <fixed-ip-address>]
        [--description <description>]
        [--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 <floating-ip-address>

    Floating IP address
    *Network version 2 only*

.. option:: --fixed-ip-address <fixed-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:: --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

    os 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

    os floating ip list
        [--network <network>]
        [--port <port>]
        [--fixed-ip-address <fixed-ip-address>]

.. 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 <fixed-ip-address>

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

    *Network version 2 only*

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

Display floating IP details

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

    os floating ip show <floating-ip>

.. describe:: <floating-ip>

    Floating IP to display (IP address or ID)