summaryrefslogtreecommitdiff
path: root/doc/source/command-objects/security-group.rst
diff options
context:
space:
mode:
authorRichard Theis <rtheis@us.ibm.com>2015-11-24 07:52:43 -0600
committerRichard Theis <rtheis@us.ibm.com>2015-11-24 12:49:57 -0600
commit41133fb82ebbadd565b38886883f8bba44295f8c (patch)
tree88fd7b3b58553b668364292162ba95451deecd65 /doc/source/command-objects/security-group.rst
parent42a5909f6a6fa50726799e8220f8722f2b0a016f (diff)
downloadpython-openstackclient-41133fb82ebbadd565b38886883f8bba44295f8c.tar.gz
Doc: Add security group and security group rule
Add missing command list documentation for the 'security group' and 'security group rule' commands. In addition, update the command description and argument help to fix minor issues and use consistent terminology. Change-Id: I9f4a3fbac5637289f19511874e16391d3fe27132
Diffstat (limited to 'doc/source/command-objects/security-group.rst')
-rw-r--r--doc/source/command-objects/security-group.rst95
1 files changed, 95 insertions, 0 deletions
diff --git a/doc/source/command-objects/security-group.rst b/doc/source/command-objects/security-group.rst
new file mode 100644
index 00000000..60de41d8
--- /dev/null
+++ b/doc/source/command-objects/security-group.rst
@@ -0,0 +1,95 @@
+==============
+security group
+==============
+
+Compute v2
+
+security group create
+---------------------
+
+Create a new security group
+
+.. program:: security group create
+.. code:: bash
+
+ os security group create
+ [--description <description>]
+ <name>
+
+.. option:: --description <description>
+
+ Security group description
+
+.. describe:: <name>
+
+ New security group name
+
+security group delete
+---------------------
+
+Delete a security group
+
+.. program:: security group delete
+.. code:: bash
+
+ os security group delete
+ <group>
+
+.. describe:: <group>
+
+ Security group to delete (name or ID)
+
+security group list
+-------------------
+
+List security groups
+
+.. program:: security group list
+.. code:: bash
+
+ os security group list
+ [--all-projects]
+
+.. option:: --all-projects
+
+ Display information from all projects (admin only)
+
+security group set
+------------------
+
+Set security group properties
+
+.. program:: security group set
+.. code:: bash
+
+ os 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
+
+ os security group show
+ <group>
+
+.. describe:: <group>
+
+ Security group to display (name or ID)