summaryrefslogtreecommitdiff
path: root/doc/source/command-objects/security-group.rst
blob: a95a96f49fa3ad405d95f5c031a27ebbff8f229b (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
==============
security group
==============

A **security group** acts as a virtual firewall for servers and other
resources on a network. It is a container for security group rules
which specify the network access rules.

Compute v2, Network v2

security group create
---------------------

Create a new security group

.. program:: security group create
.. code:: bash

    openstack security group create
        [--description <description>]
        [--project <project> [--project-domain <project-domain>]]
        <name>

.. option:: --description <description>

    Security group description

.. 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:: <name>

    New security group name

security group delete
---------------------

Delete security group(s)

.. program:: security group delete
.. code:: bash

    openstack security group delete
        <group> [<group> ...]

.. describe:: <group>

    Security group(s) to delete (name or ID)

security group list
-------------------

List security groups

.. program:: security group list
.. code:: bash

    openstack security group list
        [--all-projects]
        [--project <project> [--project-domain <project-domain>]]

.. option:: --all-projects

    Display information from all projects (admin only)

    *Network version 2 ignores this option and will always display information*
    *for all projects (admin only).*

.. option:: --project <project>

    List security groups according to the 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*

security group set
------------------

Set security group properties

.. program:: security group set
.. code:: bash

    openstack security group set
        [--name <new-name>]
        [--description <description>]
        <group>

.. option:: --name <new-name>

    New security group name

.. option:: --description <description>

    New security group description

.. describe:: <group>

    Security group to modify (name or ID)

security group show
-------------------

Display security group details

.. program:: security group show
.. code:: bash

    openstack security group show
        <group>

.. describe:: <group>

    Security group to display (name or ID)