openstack/python-openstackclient
Code Issues Proposed changes
5310cfb8b7
python-openstackclient/doc/source/command-objects/security-group.rst

96 lines
1.5 KiB
ReStructuredText
Raw Normal View History

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
2015-11-24 07:52:43 -06:00
==============
security group
==============
Refactor security group delete to use SDK Refactored the 'os security group delete' command to use the SDK when neutron is enabled, but continue to use the nova client when nova network is enabled. This patch set introduces a new NetworkAndComputeCommand class to be used for commands that must support neutron and nova network. The new class allows both the parser and actions to be unique. The current DeleteSecurityGroup class is now a subclass of this new class and has moved under the network v2 commands. This patch set also introduces a new FakeSecurityGroup class for testing security groups. And finally, this patch set updates the command documentation for security group and security group rule to indicate that Network v2 is also used. Change-Id: Ic21376b86b40cc6d97f360f3760ba5beed154537 Partial-Bug: #1519511 Related-to: blueprint neutron-client
2015-12-14 13:29:43 -06:00
Compute v2, Network v2
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
2015-11-24 07:52:43 -06:00
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)
Copy Permalink