summaryrefslogtreecommitdiff
path: root/doc/source/cli/command-objects/security-group.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source/cli/command-objects/security-group.rst')
-rw-r--r--doc/source/cli/command-objects/security-group.rst130
1 files changed, 130 insertions, 0 deletions
diff --git a/doc/source/cli/command-objects/security-group.rst b/doc/source/cli/command-objects/security-group.rst
new file mode 100644
index 00000000..a95a96f4
--- /dev/null
+++ b/doc/source/cli/command-objects/security-group.rst
@@ -0,0 +1,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)