summaryrefslogtreecommitdiff
path: root/doc/source/cli/command-objects/security-group-rule.rst
diff options
context:
space:
mode:
authorZuul <zuul@review.opendev.org>2019-11-05 00:41:31 +0000
committerGerrit Code Review <review@openstack.org>2019-11-05 00:41:31 +0000
commitd17a1c8039807cdac29e77eb5f0724d181bdd831 (patch)
tree99035b35ff29205fedb4115a2778e1b2152aad77 /doc/source/cli/command-objects/security-group-rule.rst
parentd2f44e645e4f0396991695a5fa90064702dd64fb (diff)
parentcd6c285cc6c2274e6b42cc452ba4a61a3487ca23 (diff)
downloadpython-openstackclient-d17a1c8039807cdac29e77eb5f0724d181bdd831.tar.gz
Merge "neutron: autogenerate docs"
Diffstat (limited to 'doc/source/cli/command-objects/security-group-rule.rst')
-rw-r--r--doc/source/cli/command-objects/security-group-rule.rst193
1 files changed, 2 insertions, 191 deletions
diff --git a/doc/source/cli/command-objects/security-group-rule.rst b/doc/source/cli/command-objects/security-group-rule.rst
index 5a2d8342..429bcf27 100644
--- a/doc/source/cli/command-objects/security-group-rule.rst
+++ b/doc/source/cli/command-objects/security-group-rule.rst
@@ -7,194 +7,5 @@ and other resources on the network.
Compute v2, Network v2
-security group rule create
---------------------------
-
-Create a new security group rule
-
-.. program:: security group rule create
-.. code:: bash
-
- openstack security group rule create
- [--remote-ip <ip-address> | --remote-group <group>]
- [--dst-port <port-range> | [--icmp-type <icmp-type> [--icmp-code <icmp-code>]]]
- [--protocol <protocol>]
- [--ingress | --egress]
- [--ethertype <ethertype>]
- [--project <project> [--project-domain <project-domain>]]
- [--description <description>]
- <group>
-
-.. option:: --remote-ip <ip-address>
-
- Remote IP address block (may use CIDR notation;
- default for IPv4 rule: 0.0.0.0/0,
- default for IPv6 rule: ::/0)
-
-.. option:: --remote-group <group>
-
- Remote security group (name or ID)
-
-.. option:: --dst-port <port-range>
-
- Destination port, may be a single port or a starting and
- ending port range: 137:139. Required for IP protocols TCP
- and UDP. Ignored for ICMP IP protocols.
-
-.. option:: --icmp-type <icmp-type>
-
- ICMP type for ICMP IP protocols
-
- *Network version 2 only*
-
-.. option:: --icmp-code <icmp-code>
-
- ICMP code for ICMP IP protocols
-
- *Network version 2 only*
-
-.. option:: --protocol <protocol>
-
- IP protocol (icmp, tcp, udp; default: tcp)
-
- *Compute version 2*
-
- IP protocol (ah, dccp, egp, esp, gre, icmp, igmp,
- ipv6-encap, ipv6-frag, ipv6-icmp, ipv6-nonxt,
- ipv6-opts, ipv6-route, ospf, pgm, rsvp, sctp, tcp,
- udp, udplite, vrrp and integer representations [0-255]
- or any; default: any (all protocols))
-
- *Network version 2*
-
-.. option:: --ingress
-
- Rule applies to incoming network traffic (default)
-
- *Network version 2 only*
-
-.. option:: --egress
-
- Rule applies to outgoing network traffic
-
- *Network version 2 only*
-
-.. option:: --ethertype <ethertype>
-
- Ethertype of network traffic
- (IPv4, IPv6; default: based on IP protocol)
-
- *Network version 2 only*
-
-.. 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*
-
-.. option:: --description <description>
-
- Set security group rule description
-
- *Network version 2 only*
-
-.. describe:: <group>
-
- Create rule in this security group (name or ID)
-
-security group rule delete
---------------------------
-
-Delete security group rule(s)
-
-.. program:: security group rule delete
-.. code:: bash
-
- openstack security group rule delete
- <rule> [<rule> ...]
-
-.. describe:: <rule>
-
- Security group rule(s) to delete (ID only)
-
-security group rule list
-------------------------
-
-List security group rules
-
-.. program:: security group rule list
-.. code:: bash
-
- openstack security group rule list
- [--all-projects]
- [--protocol <protocol>]
- [--ethertype <ethertype>]
- [--ingress | --egress]
- [--long]
- [<group>]
-
-.. 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:: --long
-
- List additional fields in output
-
- *Compute version 2 does not have additional fields to display.*
-
-.. option:: --protocol
-
- List rules by the IP protocol (ah, dhcp, egp, esp, gre, icmp, igmp,
- ipv6-encap, ipv6-frag, ipv6-icmp, ipv6-nonxt,ipv6-opts, ipv6-route,
- ospf, pgm, rsvp, sctp, tcp, udp, udplite, vrrp and integer
- representations [0-255] or any; default: any (all protocols))
-
- *Network version 2*
-
-.. option:: --ethertype
-
- List rules by the Ethertype (IPv4 or IPv6)
-
- *Network version 2*
-
-.. option:: --ingress
-
- List rules applied to incoming network traffic
-
- *Network version 2 only*
-
-.. option:: --egress
-
- List rules applied to outgoing network traffic
-
- *Network version 2 only*
-
-.. describe:: <group>
-
- List all rules in this security group (name or ID)
-
-security group rule show
-------------------------
-
-Display security group rule details
-
-.. program:: security group rule show
-.. code:: bash
-
- openstack security group rule show
- <rule>
-
-.. describe:: <rule>
-
- Security group rule to display (ID only)
+.. autoprogram-cliff:: openstack.network.v2
+ :command: security group rule *