summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/source/command-objects/usage.rst50
-rw-r--r--doc/source/commands.rst1
2 files changed, 51 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)
diff --git a/doc/source/commands.rst b/doc/source/commands.rst
index 0040700e..eba0a22f 100644
--- a/doc/source/commands.rst
+++ b/doc/source/commands.rst
@@ -108,6 +108,7 @@ referring to both Compute and Volume quotas.
* ``service``: Identity - a cloud service
* ``snapshot``: Volume - a point-in-time copy of a volume
* ``token``: (**Identity**) a bearer token managed by Identity service
+* ``usage``: (**Compute**) display host resources being consumed
* ``user``: (**Identity**) individual cloud resources users
* ``user role``: (**Identity**) roles assigned to a user
* ``volume``: Volume - block volumes