summaryrefslogtreecommitdiff
path: root/doc/source/command-objects/address-scope.rst
blob: 9155d09ed1f4034be7a39c9b78a85813aceb51f5 (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
=============
address scope
=============

An **address scope** is a scope of IPv4 or IPv6 addresses that belongs
to a given project and may be shared between projects.

Network v2

address scope create
--------------------

Create new address scope

.. program:: address scope create
.. code:: bash

    openstack address scope create
        [--project <project> [--project-domain <project-domain>]]
        [--ip-version <ip-version>]
        [--share | --no-share]
        <name>

.. option:: --project <project>

    Owner's project (name or ID)

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

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

.. option:: --ip-version <ip-version>

    IP version (4 or 6, default is 4)

.. option:: --share

    Share the address scope between projects

.. option:: --no-share

    Do not share the address scope between projects (default)

.. _address_scope_create-name:
.. describe:: <name>

    New address scope name

address scope delete
--------------------

Delete address scope(s)

.. program:: address scope delete
.. code:: bash

    openstack address scope delete
        <address-scope> [<address-scope> ...]

.. _address_scope_delete-address-scope:
.. describe:: <address-scope>

    Address scope(s) to delete (name or ID)

address scope list
------------------

List address scopes

.. program:: address scope list
.. code:: bash

    openstack address scope list
        [--name <name>]
        [--ip-version <ip-version>]
        [--project <project> [--project-domain <project-domain>]]
        [--share | --no-share]

.. option:: --name <name>

    List only address scopes of given name in output

.. option:: --ip-version <ip-version>

    List address scopes of given IP version networks (4 or 6)

.. option:: --project <project>

    List address scopes according to their project (name or ID)

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

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

.. option:: --share

    List address scopes shared between projects

.. option:: --no-share

    List address scopes not shared between projects

address scope set
-----------------

Set address scope properties

.. program:: address scope set
.. code:: bash

    openstack address scope set
        [--name <name>]
        [--share | --no-share]
        <address-scope>

.. option:: --name <name>

    Set address scope name

.. option:: --share

    Share the address scope between projects

.. option:: --no-share

    Do not share the address scope between projects

.. _address_scope_set-address-scope:
.. describe:: <address-scope>

    Address scope to modify (name or ID)

address scope show
------------------

Display address scope details

.. program:: address scope show
.. code:: bash

    openstack address scope show
        <address-scope>

.. _address_scope_show-address-scope:
.. describe:: <address-scope>

    Address scope to display (name or ID)