From 9599ffe65d9dcd4b3aa780d346eccd1e760890bf Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Tue, 13 Jun 2017 15:55:33 -0400 Subject: reorganize existing documentation according to the new standard layout Move existing content around based on the doc-migration specification. Replace :doc: markup with :ref: to have sphinx keep track of where the files move and generate valid hyperlinks. Add a few toctrees and index pages for the new directories. Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 Change-Id: I253ee8f89d3ec40e39310c18bb87ed1d3d5de330 Signed-off-by: Doug Hellmann --- .../cli/command-objects/network-qos-policy.rst | 145 +++++++++++++++++++++ 1 file changed, 145 insertions(+) create mode 100644 doc/source/cli/command-objects/network-qos-policy.rst (limited to 'doc/source/cli/command-objects/network-qos-policy.rst') diff --git a/doc/source/cli/command-objects/network-qos-policy.rst b/doc/source/cli/command-objects/network-qos-policy.rst new file mode 100644 index 00000000..a75c32fe --- /dev/null +++ b/doc/source/cli/command-objects/network-qos-policy.rst @@ -0,0 +1,145 @@ +================== +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 + + openstack network qos policy create + [--description ] + [--share | --no-share] + [--project ] + [--project-domain ] + + +.. option:: --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 + + Owner's project (name or ID) + +.. option:: --project-domain + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + +.. _network_qos_policy_create-name: +.. describe:: + + New QoS policy specification name + +network qos policy delete +------------------------- + +Delete Network QoS policy + +.. program:: network qos policy delete +.. code:: bash + + openstack network qos policy delete + [ ...] + +.. _network_qos_policy_delete-qos-policy: +.. describe:: + + Network QoS policy(s) to delete (name or ID) + +network qos policy list +----------------------- + +List Network QoS policies + +.. program:: network qos policy list +.. code:: bash + + openstack network qos policy list + [--project [--project-domain ]] + [--share | --no-share] + +.. option:: --project + + List qos policies according to their project (name or ID) + +.. option:: --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 + +network qos policy set +---------------------- + +Set Network QoS policy properties + +.. program:: network qos policy set +.. code:: bash + + openstack network qos policy set + [--name ] + [--description ] + [--share | --no-share] + + +.. option:: --name + + Name of the QoS policy + +.. option:: --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 + +.. _network_qos_policy_set-qos-policy: +.. describe:: + + Network QoS policy to modify (name or ID) + +network qos policy show +----------------------- + +Display Network QoS policy details + +.. program:: network qos policy show +.. code:: bash + + openstack network qos policy show + + +.. _network_qos_policy_show-qos-policy: +.. describe:: + + Network QoS policy to display (name or ID) -- cgit v1.2.1