Queue

Queue

For help on a specific openstack messaging queue command, enter:

$ openstack messaging queue COMMAND -h/--help

The fourteen commands:

messaging queue create
messaging queue delete
messaging queue get metadata
messaging queue list
messaging queue set metadata
messaging queue signed url
messaging queue stats

openstack messaging queue create

usage: openstack messaging queue create [-h] [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>] [--noindent]
                                        [--prefix PREFIX]
                                        <queue_name>

Create a queue.

Positional arguments:

<queue_name>
Name of the queue.

openstack messaging queue delete

usage: openstack messaging queue delete [-h] <queue_name>

Delete a queue.

Positional arguments:

<queue_name>
Name of the queue.

openstack messaging queue get metadata

usage: openstack messaging queue get metadata [-h] [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN] [--max-width <integer>]
                                              [--noindent] [--prefix PREFIX]
                                              <queue_name>

Get queue metadata.

Positional arguments:

<queue_name>
Name of the queue.

openstack messaging queue list

usage: openstack messaging queue list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                                      [--max-width <integer>] [--noindent]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--marker <queue_id>] [--limit <limit>]
                                      [--detailed]

List available queues.

Optional arguments:

--marker <queue_id>
Queue’s paging marker.
--limit <limit>
Page size limit.
--detailed
If show detailed information of queue.

openstack messaging queue set metadata

usage: openstack messaging queue set metadata [-h] <queue_name> <queue_metadata>

Set queue metadata.All the metadata of the queue will be replaced by queue_metadata.

Positional arguments:

<queue_name>
Name of the queue.
<queue_metadata>
Queue metadata. It should be json like. For example: ‘{“age”: 18}’

openstack messaging queue signed url

usage: openstack messaging queue signed url [-h] [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN] [--max-width <integer>]
                                            [--noindent] [--prefix PREFIX]
                                            [--paths <paths>]
                                            [--ttl-seconds <ttl_seconds>]
                                            [--methods <methods>]
                                            <queue_name>

Create a pre-signed url for the queue.

Positional arguments:

<queue_name>
Name of the queue.

Optional arguments:

--paths <paths>
Allowed paths in a comma-separated list. Options: messages, subscriptions, claims.
--ttl-seconds <ttl_seconds>
Length of time (in seconds) until the signature expires.
--methods <methods>
HTTP methods to allow as a comma-separated list. Options: GET, HEAD, OPTIONS, POST, PUT, DELETE.

openstack messaging queue stats

usage: openstack messaging queue stats [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>] [--noindent]
                                       [--prefix PREFIX]
                                       <queue_name>

Get queue stats.

Positional arguments:

<queue_name>
Name of the queue.

openstack messaging queue purge

usage: openstack messaging queue purge [-h] [--resource_types <resource_types>]
                                       <queue_name>

Purge a queue. All the metadata of the queue will be kept. Use --resource_types to specify which resource should be pured. If --resource_types is not specified, all the messages and subscriptions in the queue will be purged by default.

Positional arguments:

<queue_name>
Name of the queue.

Optional arguments:

--resource_types <resource_types>
Resource types want to be purged. Support messages and subscriptions.
Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.