diff options
| author | Doug Hellmann <doug@doughellmann.com> | 2017-06-13 15:55:33 -0400 |
|---|---|---|
| committer | Andreas Jaeger <aj@suse.com> | 2017-06-23 11:54:32 +0200 |
| commit | 9599ffe65d9dcd4b3aa780d346eccd1e760890bf (patch) | |
| tree | 9281e521e50b8bed66eca087bc11fa03adf2aed3 /doc/source/cli/command-objects/network-qos-rule.rst | |
| parent | 19c8cabeca1ea3c83da734ab5269318b27eb5634 (diff) | |
| download | python-openstackclient-9599ffe65d9dcd4b3aa780d346eccd1e760890bf.tar.gz | |
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 <doug@doughellmann.com>
Diffstat (limited to 'doc/source/cli/command-objects/network-qos-rule.rst')
| -rw-r--r-- | doc/source/cli/command-objects/network-qos-rule.rst | 165 |
1 files changed, 165 insertions, 0 deletions
diff --git a/doc/source/cli/command-objects/network-qos-rule.rst b/doc/source/cli/command-objects/network-qos-rule.rst new file mode 100644 index 00000000..1baf5dbf --- /dev/null +++ b/doc/source/cli/command-objects/network-qos-rule.rst @@ -0,0 +1,165 @@ +================ +network qos rule +================ + +A **Network QoS rule** specifies a rule defined in a Network QoS policy; its +type is defined by the parameter 'type'. Can be assigned, within a Network QoS +policy, to a port or a network. Each Network QoS policy can contain several +rules, each of them + +Network v2 + +network qos rule create +----------------------- + +Create new Network QoS rule + +.. program:: network qos rule create +.. code:: bash + + openstack network qos rule create + --type <type> + [--max-kbps <max-kbps>] + [--max-burst-kbits <max-burst-kbits>] + [--dscp-marks <dscp-marks>] + [--min-kbps <min-kbps>] + [--ingress | --egress] + <qos-policy> + +.. option:: --type <type> + + QoS rule type (minimum-bandwidth, dscp-marking, bandwidth-limit) + +.. option:: --max-kbps <min-kbps> + + Maximum bandwidth in kbps + +.. option:: --max-burst-kbits <max-burst-kbits> + + Maximum burst in kilobits, 0 means automatic + +.. option:: --dscp-mark <dscp-mark> + + DSCP mark: value can be 0, even numbers from 8-56, excluding 42, 44, 50, + 52, and 54 + +.. option:: --min-kbps <min-kbps> + + Minimum guaranteed bandwidth in kbps + +.. option:: --ingress + + Ingress traffic direction from the project point of view + +.. option:: --egress + + Egress traffic direction from the project point of view + +.. describe:: <qos-policy> + + QoS policy that contains the rule (name or ID) + +network qos rule delete +----------------------- + +Delete Network QoS rule + +.. program:: network qos rule delete +.. code:: bash + + openstack network qos rule delete + <qos-policy> + <rule-id> + +.. describe:: <qos-policy> + + QoS policy that contains the rule (name or ID) + +.. describe:: <rule-id> + + Network QoS rule to delete (ID) + +network qos rule list +--------------------- + +List Network QoS rules + +.. program:: network qos rule list +.. code:: bash + + openstack network qos rule list + <qos-policy> + +.. describe:: <qos-policy> + + QoS policy that contains the rule (name or ID) + +network qos rule set +-------------------- + +Set Network QoS rule properties + +.. program:: network qos rule set +.. code:: bash + + openstack network qos rule set + [--max-kbps <max-kbps>] + [--max-burst-kbits <max-burst-kbits>] + [--dscp-marks <dscp-marks>] + [--min-kbps <min-kbps>] + [--ingress | --egress] + <qos-policy> + <rule-id> + +.. option:: --max-kbps <min-kbps> + + Maximum bandwidth in kbps + +.. option:: --max-burst-kbits <max-burst-kbits> + + Maximum burst in kilobits, 0 means automatic + +.. option:: --dscp-mark <dscp-mark> + + DSCP mark: value can be 0, even numbers from 8-56, excluding 42, 44, 50, + 52, and 54 + +.. option:: --min-kbps <min-kbps> + + Minimum guaranteed bandwidth in kbps + +.. option:: --ingress + + Ingress traffic direction from the project point of view + +.. option:: --egress + + Egress traffic direction from the project point of view + +.. describe:: <qos-policy> + + QoS policy that contains the rule (name or ID) + +.. describe:: <rule-id> + + Network QoS rule to delete (ID) + +network qos rule show +--------------------- + +Display Network QoS rule details + +.. program:: network qos rule show +.. code:: bash + + openstack network qos rule show + <qos-policy> + <rule-id> + +.. describe:: <qos-policy> + + QoS policy that contains the rule (name or ID) + +.. describe:: <rule-id> + + Network QoS rule to delete (ID) |
