openstack/python-openstackclient
Code Issues Proposed changes
61025bf102
python-openstackclient/doc/source/cli/command-objects/network-qos-policy.rst

164 lines
3.4 KiB
ReStructuredText
Raw Normal View History

Add network support for Network QoS policies Added following commands: - network qos policy create - network qos policy delete - network qos policy set - network qos policy show - network qos policy list Closes-Bug: 1609037 Depends-On: I33bafeca979410d329ae10a82772ccdb48c10daa Change-Id: I63a8f63702514ff5814481bb021e2aa9d5f3d4b1
2016-08-02 09:42:21 +01:00
==================
network qos policy
==================
A **Network QoS policy** groups a number of Network QoS rules, applied to a
network or a port.
Network v2
network qos policy create
-------------------------
Create new Network QoS policy
.. program:: network qos policy create
.. code:: bash
change os in command example to openstack(2) In the current doc, the command examples are like "os server create" but the acutal command should be started with "openstack" instead of "os", it is misleading to first time users. Change-Id: I80c96f0938cec382f2f714a500138bd5a2c81aa0
2016-12-20 09:18:55 +08:00
openstack network qos policy create
Add network support for Network QoS policies Added following commands: - network qos policy create - network qos policy delete - network qos policy set - network qos policy show - network qos policy list Closes-Bug: 1609037 Depends-On: I33bafeca979410d329ae10a82772ccdb48c10daa Change-Id: I63a8f63702514ff5814481bb021e2aa9d5f3d4b1
2016-08-02 09:42:21 +01:00
[--description <description>]
[--share | --no-share]
[--project <project>]
[--project-domain <project-domain>]
Add new parameter "is_default" to Network QoS policy. Add a set of exclusive parameters to the Network QoS policy: --default: makes this policy the default policy for the project to which the qos policy belongs. --no-default: unset the property. Closes-Bug: #1639220 Depends-On: If5ff2b00fa828f93aa089e275ddbd1ff542b79d4 Depends-On: Ibe7b7881cb190bfd5582f35b6de51a8bc21135de Change-Id: I0269b837dc29bbd8ee2089d847cadb72d800fa30
2017-02-16 18:55:02 +00:00
[--default | --no-default]
Add network support for Network QoS policies Added following commands: - network qos policy create - network qos policy delete - network qos policy set - network qos policy show - network qos policy list Closes-Bug: 1609037 Depends-On: I33bafeca979410d329ae10a82772ccdb48c10daa Change-Id: I63a8f63702514ff5814481bb021e2aa9d5f3d4b1
2016-08-02 09:42:21 +01:00
<name>
.. option:: --description <description>
Description of the QoS policy
.. option:: --share
Make the QoS policy accessible by other projects
.. option:: --no-share
Make the QoS policy not accessible by other projects (default)
.. option:: --project <project>
Owner's project (name or ID)
DevRef fix for network qos policy Several help messages are not proper. This patch will do the following work: * Remove redundant square bracket ']' * Modify the wrong message Change-Id: I2f05d1dc86838dbe77169074f93e467a959d0122
2016-11-26 22:18:57 +08:00
.. option:: --project-domain <project-domain>
Add network support for Network QoS policies Added following commands: - network qos policy create - network qos policy delete - network qos policy set - network qos policy show - network qos policy list Closes-Bug: 1609037 Depends-On: I33bafeca979410d329ae10a82772ccdb48c10daa Change-Id: I63a8f63702514ff5814481bb021e2aa9d5f3d4b1
2016-08-02 09:42:21 +01:00
Domain the project belongs to (name or ID).
This can be used in case collisions between project names exist.
Add new parameter "is_default" to Network QoS policy. Add a set of exclusive parameters to the Network QoS policy: --default: makes this policy the default policy for the project to which the qos policy belongs. --no-default: unset the property. Closes-Bug: #1639220 Depends-On: If5ff2b00fa828f93aa089e275ddbd1ff542b79d4 Depends-On: Ibe7b7881cb190bfd5582f35b6de51a8bc21135de Change-Id: I0269b837dc29bbd8ee2089d847cadb72d800fa30
2017-02-16 18:55:02 +00:00
.. option:: --default
Set this as a default network QoS policy
.. option:: --no-default
Set this as a non-default network QoS policy
DevRef fix for network qos policy Several help messages are not proper. This patch will do the following work: * Remove redundant square bracket ']' * Modify the wrong message Change-Id: I2f05d1dc86838dbe77169074f93e467a959d0122
2016-11-26 22:18:57 +08:00
.. _network_qos_policy_create-name:
Add network support for Network QoS policies Added following commands: - network qos policy create - network qos policy delete - network qos policy set - network qos policy show - network qos policy list Closes-Bug: 1609037 Depends-On: I33bafeca979410d329ae10a82772ccdb48c10daa Change-Id: I63a8f63702514ff5814481bb021e2aa9d5f3d4b1
2016-08-02 09:42:21 +01:00
.. describe:: <name>
New QoS policy specification name
network qos policy delete
-------------------------
Delete Network QoS policy
.. program:: network qos policy delete
.. code:: bash
change os in command example to openstack(2) In the current doc, the command examples are like "os server create" but the acutal command should be started with "openstack" instead of "os", it is misleading to first time users. Change-Id: I80c96f0938cec382f2f714a500138bd5a2c81aa0
2016-12-20 09:18:55 +08:00
openstack network qos policy delete
Add network support for Network QoS policies Added following commands: - network qos policy create - network qos policy delete - network qos policy set - network qos policy show - network qos policy list Closes-Bug: 1609037 Depends-On: I33bafeca979410d329ae10a82772ccdb48c10daa Change-Id: I63a8f63702514ff5814481bb021e2aa9d5f3d4b1
2016-08-02 09:42:21 +01:00
<qos-policy> [<qos-policy> ...]
DevRef fix for network qos policy Several help messages are not proper. This patch will do the following work: * Remove redundant square bracket ']' * Modify the wrong message Change-Id: I2f05d1dc86838dbe77169074f93e467a959d0122
2016-11-26 22:18:57 +08:00
.. _network_qos_policy_delete-qos-policy:
Add network support for Network QoS policies Added following commands: - network qos policy create - network qos policy delete - network qos policy set - network qos policy show - network qos policy list Closes-Bug: 1609037 Depends-On: I33bafeca979410d329ae10a82772ccdb48c10daa Change-Id: I63a8f63702514ff5814481bb021e2aa9d5f3d4b1
2016-08-02 09:42:21 +01:00
.. describe:: <qos-policy>
Network QoS policy(s) to delete (name or ID)
network qos policy list
-----------------------
List Network QoS policies
.. program:: network qos policy list
.. code:: bash
change os in command example to openstack(2) In the current doc, the command examples are like "os server create" but the acutal command should be started with "openstack" instead of "os", it is misleading to first time users. Change-Id: I80c96f0938cec382f2f714a500138bd5a2c81aa0
2016-12-20 09:18:55 +08:00
openstack network qos policy list
Add extra filtering options to qos policy list The patch adds filtering "--project", "--project-domain", "--share", "--no-share" options to qos policy list. Change-Id: I5c012fb27fb952f736ddc9fbc54ef6da4d0af5e0 Partially-Implements: blueprint network-commands-options
2016-11-23 09:26:14 -05:00
[--project <project> [--project-domain <project-domain>]]
[--share | --no-share]
.. option:: --project <project>
List qos policies according to their project (name or ID)
.. option:: --project-domain <project-domain>
Domain the project belongs to (name or ID).
This can be used in case collisions between project names exist.
.. option:: --share
List qos policies shared between projects
.. option:: --no-share
List qos policies not shared between projects
Add network support for Network QoS policies Added following commands: - network qos policy create - network qos policy delete - network qos policy set - network qos policy show - network qos policy list Closes-Bug: 1609037 Depends-On: I33bafeca979410d329ae10a82772ccdb48c10daa Change-Id: I63a8f63702514ff5814481bb021e2aa9d5f3d4b1
2016-08-02 09:42:21 +01:00
network qos policy set
----------------------
Set Network QoS policy properties
.. program:: network qos policy set
.. code:: bash
change os in command example to openstack(2) In the current doc, the command examples are like "os server create" but the acutal command should be started with "openstack" instead of "os", it is misleading to first time users. Change-Id: I80c96f0938cec382f2f714a500138bd5a2c81aa0
2016-12-20 09:18:55 +08:00
openstack network qos policy set
Add network support for Network QoS policies Added following commands: - network qos policy create - network qos policy delete - network qos policy set - network qos policy show - network qos policy list Closes-Bug: 1609037 Depends-On: I33bafeca979410d329ae10a82772ccdb48c10daa Change-Id: I63a8f63702514ff5814481bb021e2aa9d5f3d4b1
2016-08-02 09:42:21 +01:00
[--name <name>]
[--description <description>]
[--share | --no-share]
Add new parameter "is_default" to Network QoS policy. Add a set of exclusive parameters to the Network QoS policy: --default: makes this policy the default policy for the project to which the qos policy belongs. --no-default: unset the property. Closes-Bug: #1639220 Depends-On: If5ff2b00fa828f93aa089e275ddbd1ff542b79d4 Depends-On: Ibe7b7881cb190bfd5582f35b6de51a8bc21135de Change-Id: I0269b837dc29bbd8ee2089d847cadb72d800fa30
2017-02-16 18:55:02 +00:00
[--default | --no-default]
Add network support for Network QoS policies Added following commands: - network qos policy create - network qos policy delete - network qos policy set - network qos policy show - network qos policy list Closes-Bug: 1609037 Depends-On: I33bafeca979410d329ae10a82772ccdb48c10daa Change-Id: I63a8f63702514ff5814481bb021e2aa9d5f3d4b1
2016-08-02 09:42:21 +01:00
<qos-policy>
.. option:: --name <name>
Name of the QoS policy
.. option:: --description <description>
Description of the QoS policy
.. option:: --share
Make the QoS policy accessible by other projects
.. option:: --no-share
Make the QoS policy not accessible by other projects
Add new parameter "is_default" to Network QoS policy. Add a set of exclusive parameters to the Network QoS policy: --default: makes this policy the default policy for the project to which the qos policy belongs. --no-default: unset the property. Closes-Bug: #1639220 Depends-On: If5ff2b00fa828f93aa089e275ddbd1ff542b79d4 Depends-On: Ibe7b7881cb190bfd5582f35b6de51a8bc21135de Change-Id: I0269b837dc29bbd8ee2089d847cadb72d800fa30
2017-02-16 18:55:02 +00:00
.. option:: --default
Set this as a default network QoS policy
.. option:: --no-default
Set this as a non-default network QoS policy
DevRef fix for network qos policy Several help messages are not proper. This patch will do the following work: * Remove redundant square bracket ']' * Modify the wrong message Change-Id: I2f05d1dc86838dbe77169074f93e467a959d0122
2016-11-26 22:18:57 +08:00
.. _network_qos_policy_set-qos-policy:
Add network support for Network QoS policies Added following commands: - network qos policy create - network qos policy delete - network qos policy set - network qos policy show - network qos policy list Closes-Bug: 1609037 Depends-On: I33bafeca979410d329ae10a82772ccdb48c10daa Change-Id: I63a8f63702514ff5814481bb021e2aa9d5f3d4b1
2016-08-02 09:42:21 +01:00
.. describe:: <qos-policy>
DevRef fix for network qos policy Several help messages are not proper. This patch will do the following work: * Remove redundant square bracket ']' * Modify the wrong message Change-Id: I2f05d1dc86838dbe77169074f93e467a959d0122
2016-11-26 22:18:57 +08:00
Network QoS policy to modify (name or ID)
Add network support for Network QoS policies Added following commands: - network qos policy create - network qos policy delete - network qos policy set - network qos policy show - network qos policy list Closes-Bug: 1609037 Depends-On: I33bafeca979410d329ae10a82772ccdb48c10daa Change-Id: I63a8f63702514ff5814481bb021e2aa9d5f3d4b1
2016-08-02 09:42:21 +01:00
network qos policy show
-----------------------
Display Network QoS policy details
.. program:: network qos policy show
.. code:: bash
change os in command example to openstack(2) In the current doc, the command examples are like "os server create" but the acutal command should be started with "openstack" instead of "os", it is misleading to first time users. Change-Id: I80c96f0938cec382f2f714a500138bd5a2c81aa0
2016-12-20 09:18:55 +08:00
openstack network qos policy show
Add network support for Network QoS policies Added following commands: - network qos policy create - network qos policy delete - network qos policy set - network qos policy show - network qos policy list Closes-Bug: 1609037 Depends-On: I33bafeca979410d329ae10a82772ccdb48c10daa Change-Id: I63a8f63702514ff5814481bb021e2aa9d5f3d4b1
2016-08-02 09:42:21 +01:00
<qos-policy>
DevRef fix for network qos policy Several help messages are not proper. This patch will do the following work: * Remove redundant square bracket ']' * Modify the wrong message Change-Id: I2f05d1dc86838dbe77169074f93e467a959d0122
2016-11-26 22:18:57 +08:00
.. _network_qos_policy_show-qos-policy:
Add network support for Network QoS policies Added following commands: - network qos policy create - network qos policy delete - network qos policy set - network qos policy show - network qos policy list Closes-Bug: 1609037 Depends-On: I33bafeca979410d329ae10a82772ccdb48c10daa Change-Id: I63a8f63702514ff5814481bb021e2aa9d5f3d4b1
2016-08-02 09:42:21 +01:00
.. describe:: <qos-policy>
DevRef fix for network qos policy Several help messages are not proper. This patch will do the following work: * Remove redundant square bracket ']' * Modify the wrong message Change-Id: I2f05d1dc86838dbe77169074f93e467a959d0122
2016-11-26 22:18:57 +08:00
Network QoS policy to display (name or ID)
Copy Permalink