summaryrefslogtreecommitdiff
path: root/doc/source/cli/command-objects/network-meter-rule.rst
diff options
context:
space:
mode:
authorDoug Hellmann <doug@doughellmann.com>2017-06-13 15:55:33 -0400
committerAndreas Jaeger <aj@suse.com>2017-06-23 11:54:32 +0200
commit9599ffe65d9dcd4b3aa780d346eccd1e760890bf (patch)
tree9281e521e50b8bed66eca087bc11fa03adf2aed3 /doc/source/cli/command-objects/network-meter-rule.rst
parent19c8cabeca1ea3c83da734ab5269318b27eb5634 (diff)
downloadpython-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-meter-rule.rst')
-rw-r--r--doc/source/cli/command-objects/network-meter-rule.rst101
1 files changed, 101 insertions, 0 deletions
diff --git a/doc/source/cli/command-objects/network-meter-rule.rst b/doc/source/cli/command-objects/network-meter-rule.rst
new file mode 100644
index 00000000..22d50aa9
--- /dev/null
+++ b/doc/source/cli/command-objects/network-meter-rule.rst
@@ -0,0 +1,101 @@
+==================
+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
+ --remote-ip-prefix <remote-ip-prefix>
+ [--ingress | --egress]
+ [--exclude | --include]
+ [--project <project> [--project-domain <project-domain>]]
+ <meter>
+
+.. option:: --project <project>
+
+ Owner's project (name or ID)
+
+.. 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)