summaryrefslogtreecommitdiff
path: root/doc/source/cli/command-objects/security-group.rst
diff options
context:
space:
mode:
authorDoug Hellmann <doug@doughellmann.com>2017-06-13 15:55:33 -0400
committerAndreas Jaeger <aj@suse.com>2017-06-23 11:54:32 +0200
commit9599ffe65d9dcd4b3aa780d346eccd1e760890bf (patch)
tree9281e521e50b8bed66eca087bc11fa03adf2aed3 /doc/source/cli/command-objects/security-group.rst
parent19c8cabeca1ea3c83da734ab5269318b27eb5634 (diff)
downloadpython-openstackclient-9599ffe65d9dcd4b3aa780d346eccd1e760890bf.tar.gz
reorganize existing documentation according to the new standard layout
Move existing content around based on the doc-migration specification. Replace :doc: markup with :ref: to have sphinx keep track of where the files move and generate valid hyperlinks. Add a few toctrees and index pages for the new directories. Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 Change-Id: I253ee8f89d3ec40e39310c18bb87ed1d3d5de330 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
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)