python-openstackclient/doc/source/command-objects/security-group.rst
Richard Theis 842882f3cb Refactor security group list to use SDK
Refactored the 'os security group list' command to use the SDK
when neutron is enabled, but continue to use the nova client
when nova network is enabled.

This refactor also removes the logic for displaying project names
instead of project IDs when the --all-projects option is specified.
This logic was removed because it is inconsistent with the other
network commands.

Since neutron will always display security groups across all
projects for an admin, the --all-projects option is now hidden
when neutron is enabled and the Project column is always
displayed.

Change-Id: I934a1f5084ef3c5f929d0ffd38ebf5064d799941
Partial-Bug: #1519511
Related-to: blueprint neutron-client
2016-02-29 14:46:57 -06:00

99 lines
1.6 KiB
ReStructuredText

==============
security group
==============
Compute v2, Network 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)
*Network version 2 ignores this option and will always display information*
*for all projects.*
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)