From 8eee9c3b76c2c7c4a2be08deb4f636438823c310 Mon Sep 17 00:00:00 2001 From: ZhaoBo Date: Tue, 20 Dec 2016 17:44:48 +0800 Subject: [PATCH] Add command guide for openstack claim CLI Change-Id: Ib7bebb90daa7c047d0d78d2856b77277552e44a7 Co-Authored-By: wangxiyuan --- doc/source/command-line.rst | 1 + doc/source/command/claim.rst | 122 +++++++++++++++++++++++++++++++++++ 2 files changed, 123 insertions(+) create mode 100644 doc/source/command/claim.rst diff --git a/doc/source/command-line.rst b/doc/source/command-line.rst index 6996806d..728cb100 100644 --- a/doc/source/command-line.rst +++ b/doc/source/command-line.rst @@ -13,3 +13,4 @@ Click the Link below for the details. :maxdepth: 1 command/queue + command/claim diff --git a/doc/source/command/claim.rst b/doc/source/command/claim.rst new file mode 100644 index 00000000..8717b610 --- /dev/null +++ b/doc/source/command/claim.rst @@ -0,0 +1,122 @@ +Claim +===== + +For help on a specific :command:`openstack claim` command, enter: + +.. code-block:: console + + $ openstack claim COMMAND -h/--help + +The four commands: + +.. code-block:: console + + claim create + claim query + claim release + claim renew + +.. _openstack_claim_create: + +openstack claim create +---------------------- + +.. code-block:: console + + usage: openstack claim create [-h] [-f {csv,json,table,value,yaml}] + [-c COLUMN] [--max-width ] [--noindent] + [--quote {all,minimal,none,nonnumeric}] + [--ttl ] [--grace ] + [--limit ] + + +Create claim and return a list of claimed messages. + +**Positional arguments:** + +```` + Name of the queue to be claim. + +**Optional arguments:** + +``--ttl `` + Time to live in seconds for claim. + +``--grace `` + The message grace period in seconds. + +``--limit `` + Claims a set of messages, up to limit. + + +.. _openstack_claim_query: + +openstack claim query +--------------------- + +.. code-block:: console + + usage: openstack claim query [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] + [--max-width ] [--noindent] + [--quote {all,minimal,none,nonnumeric}] + + +Display claim details. + +**Positional arguments:** + +```` + Name of the claimed queue. + +```` + ID of the claim. + +.. _openstack_claim_release: + +openstack claim release +----------------------- + +.. code-block:: console + + usage: openstack claim release [-h] + +Delete a claim. + +**Positional arguments:** + +```` + Name of the claimed queue. + +```` + Claim ID to delete. + +.. _openstack_claim_renew: + +openstack claim renew +--------------------- + +.. code-block:: console + + usage: openstack claim renew [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] + [--max-width ] [--noindent] + [--quote {all,minimal,none,nonnumeric}] + [--ttl ] [--grace ] + + +Renew a claim. + +**Positional arguments:** + +`` `` + Name of the claimed queue. + +```` + Claim ID. + +**Optional arguments:** + +``--ttl `` + Time to live in seconds for claim. + +``--grace `` + The message grace period in seconds.