summaryrefslogtreecommitdiff
path: root/doc/source/command-objects/security-group-rule.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-rule.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-rule.rst')
-rw-r--r--doc/source/command-objects/security-group-rule.rst65
1 files changed, 65 insertions, 0 deletions
diff --git a/doc/source/command-objects/security-group-rule.rst b/doc/source/command-objects/security-group-rule.rst
new file mode 100644
index 00000000..8bd0d061
--- /dev/null
+++ b/doc/source/command-objects/security-group-rule.rst
@@ -0,0 +1,65 @@
+===================
+security group rule
+===================
+
+Compute v2
+
+security group rule create
+--------------------------
+
+Create a new security group rule
+
+.. program:: security group rule create
+.. code:: bash
+
+ os security group rule create
+ [--proto <proto>]
+ [--src-ip <ip-address>]
+ [--dst-port <port-range>]
+ <group>
+
+.. option:: --proto <proto>
+
+ IP protocol (icmp, tcp, udp; default: tcp)
+
+.. option:: --src-ip <ip-address>
+
+ Source IP (may use CIDR notation; default: 0.0.0.0/0)
+
+.. option:: --dst-port <port-range>
+
+ Destination port, may be a range: 137:139 (default: 0; only required for proto tcp and udp)
+
+.. describe:: <group>
+
+ Create rule in this security group (name or ID)
+
+security group rule delete
+--------------------------
+
+Delete a security group rule
+
+.. program:: security group rule delete
+.. code:: bash
+
+ os security group rule delete
+ <rule>
+
+.. describe:: <rule>
+
+ Security group rule to delete (ID only)
+
+security group rule list
+------------------------
+
+List security group rules
+
+.. program:: security group rule list
+.. code:: bash
+
+ os security group rule list
+ <group>
+
+.. describe:: <group>
+
+ List all rules in this security group (name or ID)