diff options
| author | Ankur Gupta <ankur.gupta@intel.com> | 2016-09-27 17:00:43 -0500 |
|---|---|---|
| committer | Ankur <ankur.gupta@intel.com> | 2017-01-23 00:24:35 +0000 |
| commit | 5caac0e5634fd65e2f635b724f00461eaebd58bf (patch) | |
| tree | ec745f56039d6f8111f2857864e705c897ca5423 /doc/source | |
| parent | 607f31d3db924517c18fd192239e5ef5963e17f3 (diff) | |
| download | python-openstackclient-5caac0e5634fd65e2f635b724f00461eaebd58bf.tar.gz | |
Add meter rule to OSC
Implement network feature meter label rules into
OpenStack Client.
Allows for creation of rules to meter
network traffic.
Partially Implements: blueprint neutron-client-metering
Change-Id: If18c078d7e80c122583417669f820f02c84d6237
Diffstat (limited to 'doc/source')
| -rw-r--r-- | doc/source/command-objects/network-meter-rule.rst | 103 | ||||
| -rw-r--r-- | doc/source/commands.rst | 1 |
2 files changed, 104 insertions, 0 deletions
diff --git a/doc/source/command-objects/network-meter-rule.rst b/doc/source/command-objects/network-meter-rule.rst new file mode 100644 index 00000000..83f8fd4f --- /dev/null +++ b/doc/source/command-objects/network-meter-rule.rst @@ -0,0 +1,103 @@ +================== +network meter rule +================== + +A **meter rule** sets the rule for +a meter to measure traffic for a specific IP range. +The following uses **meter** and requires the L3 +metering extension. + +Network v2 + +network meter rule create +------------------------- + +Create meter rule + +.. program:: network meter rule create +.. code:: bash + + openstack network meter rule create + [--project <project> [--project-domain <project-domain>]] + [--ingress | --egress] + [--exclude | --include] + --remote-ip-prefix <remote-ip-prefix> + <meter> + +.. option:: --project <project> + + Owner's project (name or ID) + + *Network version 2 only* + +.. option:: --project-domain <project-domain> + + Domain the project belongs to (name of ID). + This can be used in case collisions between project names exist. + +.. option:: --ingress + + Rule is applied to incoming traffic (default) + +.. option:: --egress + + Rule is applied to outgoing traffic + +.. option:: --exclude + + Exclude remote_ip_prefix from count of the traffic of IP addresses + +.. option:: --include + + Include remote_ip_prefix into count of the traffic of IP addresses + (default) + +.. option:: --remote-ip-prefix <remote-ip-prefix> + + The remote IP prefix to associate with this metering rule packet + +.. _network_meter_rule_create: +.. describe:: <meter> + + Meter to associate with this meter rule (name or ID) + + +network meter rule delete +------------------------- + +Delete meter rule(s) + +.. program:: network meter rule delete +.. code:: bash + + openstack network meter rule delete <id> [<id> ...] + +.. _network_meter_rule_delete: +.. describe:: <meter-rule-id> + + ID of meter rule(s) to delete + +network meter rule list +----------------------- + +List meter rules + +.. program:: network meter rule list +.. code:: bash + + openstack network meter rule list + +network meter rule show +----------------------- + +Show meter rule + +.. program:: network meter rule show +.. code:: bash + + openstack network meter rule show <meter-rule-id> + +.. _network_meter_show: +.. describe:: <meter-rule-id> + + Meter rule to display (ID only) diff --git a/doc/source/commands.rst b/doc/source/commands.rst index 1f1ece4f..ece0b6e2 100644 --- a/doc/source/commands.rst +++ b/doc/source/commands.rst @@ -112,6 +112,7 @@ referring to both Compute and Volume quotas. * ``network``: (**Compute**, **Network**) - a virtual network for connecting servers and other resources * ``network agent``: (**Network**) - A network agent is an agent that handles various tasks used to implement virtual networks * ``network meter``: (**Network**) - allow traffic metering in a network +* ``network meter rule``: (**Network**) - rules for network traffic metering * ``network rbac``: (**Network**) - an RBAC policy for network resources * ``network qos rule``: (**Network**) - a QoS rule for network resources * ``network qos policy``: (**Network**) - a QoS policy for network resources |
