summaryrefslogtreecommitdiff
path: root/doc/source/command-objects
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2015-01-02 17:54:30 +0000
committerGerrit Code Review <review@openstack.org>2015-01-02 17:54:30 +0000
commit81320726304d998ed52a8d7a55558a83716b58ff (patch)
tree0db36f64d8acf1ea230007f77302785773e55b9f /doc/source/command-objects
parent6c0d4b82e027cc0573be05d19c5ae779e7e7425c (diff)
parent480921d0e8009e20372037cba4fb6e381760a9c1 (diff)
downloadpython-openstackclient-81320726304d998ed52a8d7a55558a83716b58ff.tar.gz
Merge "Add docs for usage show/list"
Diffstat (limited to 'doc/source/command-objects')
-rw-r--r--doc/source/command-objects/usage.rst50
1 files changed, 50 insertions, 0 deletions
diff --git a/doc/source/command-objects/usage.rst b/doc/source/command-objects/usage.rst
new file mode 100644
index 00000000..551176c7
--- /dev/null
+++ b/doc/source/command-objects/usage.rst
@@ -0,0 +1,50 @@
+=====
+usage
+=====
+
+Compute v2
+
+usage list
+----------
+
+List resource usage per project
+
+.. program:: usage list
+.. code:: bash
+
+ os usage list
+ --start <start>
+ --end <end>
+
+.. option:: --start <start>
+
+ Usage range start date, ex 2012-01-20 (default: 4 weeks ago).
+
+.. option:: --end <end>
+
+ Usage range end date, ex 2012-01-20 (default: tomorrow)
+
+usage show
+----------
+
+Show resource usage for a single project.
+
+.. program:: usage show
+.. code:: bash
+
+ os usage show
+ --project <project>
+ --start <start>
+ --end <end>
+
+.. option:: --project <project>
+
+ Name or ID of project to show usage for.
+
+.. option:: --start <start>
+
+ Usage range start date, ex 2012-01-20 (default: 4 weeks ago).
+
+.. option:: --end <end>
+
+ Usage range end date, ex 2012-01-20 (default: tomorrow)