Chapter 45. messaging


This chapter describes the commands under the messaging command.

45.1. messaging claim create

Usage:

openstack messaging claim create [-h] [-f {csv,json,table,value,yaml}]

                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--sort-column SORT_COLUMN]
                                      [--ttl <ttl>] [--grace <grace>]
                                      [--limit <limit>]
                                      <queue_name>
Copy to Clipboard Toggle word wrap

Create claim and return a list of claimed messages

Expand
Table 45.1. Positional Arguments
ValueSummary

<queue_name>

Name of the queue to be claim

Expand
Table 45.2. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--ttl <ttl>

Time to live in seconds for claim

--grace <grace>

The message grace period in seconds

--limit <limit>

Claims a set of messages, up to limit

Expand
Table 45.3. Output Formatters
ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Expand
Table 45.4. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 45.5. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 45.6. CSV Formatter
ValueSummary

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

This command is provided by the python-zaqarclient plugin.

45.2. messaging claim query

Usage:

openstack messaging claim query [-h] [-f {csv,json,table,value,yaml}]

                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--sort-column SORT_COLUMN]
                                     <queue_name> <claim_id>
Copy to Clipboard Toggle word wrap

Display claim details

Expand
Table 45.7. Positional Arguments
ValueSummary

<queue_name>

Name of the claimed queue

<claim_id>

Id of the claim

Expand
Table 45.8. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 45.9. Output Formatters
ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Expand
Table 45.10. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 45.11. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 45.12. CSV Formatter
ValueSummary

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

This command is provided by the python-zaqarclient plugin.

45.3. messaging claim release

Usage:

openstack messaging claim release [-h] <queue_name> <claim_id>
Copy to Clipboard Toggle word wrap

Delete a claim

Expand
Table 45.13. Positional Arguments
ValueSummary

<queue_name>

Name of the claimed queue

<claim_id>

Claim id to delete

Expand
Table 45.14. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-zaqarclient plugin.

45.4. messaging claim renew

Usage:

openstack messaging claim renew [-h] [-f {csv,json,table,value,yaml}]

                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--sort-column SORT_COLUMN]
                                     [--ttl <ttl>] [--grace <grace>]
                                     <queue_name> <claim_id>
Copy to Clipboard Toggle word wrap

Renew a claim

Expand
Table 45.15. Positional Arguments
ValueSummary

<queue_name>

Name of the claimed queue

<claim_id>

Claim id

Expand
Table 45.16. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--ttl <ttl>

Time to live in seconds for claim

--grace <grace>

The message grace period in seconds

Expand
Table 45.17. Output Formatters
ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Expand
Table 45.18. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 45.19. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 45.20. CSV Formatter
ValueSummary

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

This command is provided by the python-zaqarclient plugin.

45.5. messaging flavor create

Usage:

openstack messaging flavor create [-h]

                                       [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent] [--prefix PREFIX]
                                       [--capabilities <capabilities>]
                                       <flavor_name> <pool_group>
Copy to Clipboard Toggle word wrap

Create a pool flavor

Expand
Table 45.21. Positional Arguments
ValueSummary

<flavor_name>

Name of the flavor

<pool_group>

Pool group for flavor

Expand
Table 45.22. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--capabilities <capabilities>

Describes flavor-specific capabilities, This option is only available in client api version < 2 .

Expand
Table 45.23. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 45.24. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 45.25. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 45.26. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-zaqarclient plugin.

45.6. messaging flavor delete

Usage:

openstack messaging flavor delete [-h] <flavor_name>
Copy to Clipboard Toggle word wrap

Delete a pool flavor

Expand
Table 45.27. Positional Arguments
ValueSummary

<flavor_name>

Name of the flavor

Expand
Table 45.28. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-zaqarclient plugin.

45.7. messaging flavor list

Usage:

openstack messaging flavor list [-h] [-f {csv,json,table,value,yaml}]

                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--sort-column SORT_COLUMN]
                                     [--marker <flavor_name>]
                                     [--limit <limit>] [--detailed]
Copy to Clipboard Toggle word wrap

List available pool flavors

Expand
Table 45.29. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--marker <flavor_name>

Flavor’s paging marker

--limit <limit>

Page size limit

--detailed

If show detailed capabilities of flavor

Expand
Table 45.30. Output Formatters
ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Expand
Table 45.31. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 45.32. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 45.33. CSV Formatter
ValueSummary

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

This command is provided by the python-zaqarclient plugin.

45.8. messaging flavor show

Usage:

openstack messaging flavor show [-h] [-f {json,shell,table,value,yaml}]

                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent] [--prefix PREFIX]
                                     <flavor_name>
Copy to Clipboard Toggle word wrap

Display pool flavor details

Expand
Table 45.34. Positional Arguments
ValueSummary

<flavor_name>

Flavor to display (name)

Expand
Table 45.35. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 45.36. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 45.37. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 45.38. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 45.39. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-zaqarclient plugin.

45.9. messaging flavor update

Usage:

openstack messaging flavor update [-h]

                                       [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent] [--prefix PREFIX]
                                       [--pool_group <pool_group>]
                                       [--capabilities <capabilities>]
                                       <flavor_name>
Copy to Clipboard Toggle word wrap

Update a flavor’s attributes

Expand
Table 45.40. Positional Arguments
ValueSummary

<flavor_name>

Name of the flavor

Expand
Table 45.41. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--pool_group <pool_group>

Pool group the flavor sits on

--capabilities <capabilities>

Describes flavor-specific capabilities.

Expand
Table 45.42. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 45.43. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 45.44. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 45.45. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-zaqarclient plugin.

45.10. messaging health

Usage:

openstack messaging health [-h]
Copy to Clipboard Toggle word wrap

Display detailed health status of Zaqar server

Expand
Table 45.46. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-zaqarclient plugin.

45.11. messaging homedoc

Usage:

openstack messaging homedoc [-h]
Copy to Clipboard Toggle word wrap

Display detailed resource doc of Zaqar server

Expand
Table 45.47. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-zaqarclient plugin.

45.12. messaging message list

Usage:

openstack messaging message list [-h] [-f {csv,json,table,value,yaml}]

                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--sort-column SORT_COLUMN]
                                      [--message-ids <message_ids>]
                                      [--limit <limit>] [--echo]
                                      [--include-claimed]
                                      [--include-delayed]
                                      [--client-id <client_id>]
                                      <queue_name>
Copy to Clipboard Toggle word wrap

List all messages for a given queue

Expand
Table 45.48. Positional Arguments
ValueSummary

<queue_name>

Name of the queue

Expand
Table 45.49. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--message-ids <message_ids>

List of messages' ids to retrieve

--limit <limit>

Maximum number of messages to get

--echo

Whether to get this client’s own messages

--include-claimed

Whether to include claimed messages

--include-delayed

Whether to include delayed messages

--client-id <client_id>

A UUID for each client instance.

Expand
Table 45.50. Output Formatters
ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Expand
Table 45.51. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 45.52. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 45.53. CSV Formatter
ValueSummary

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

This command is provided by the python-zaqarclient plugin.

45.13. messaging message post

Usage:

openstack messaging message post [-h] [--client-id <client_id>]

                                      <queue_name> <messages>
Copy to Clipboard Toggle word wrap

Post messages for a given queue

Expand
Table 45.54. Positional Arguments
ValueSummary

<queue_name>

Name of the queue

<messages>

Messages to be posted.

Expand
Table 45.55. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--client-id <client_id>

A UUID for each client instance.

This command is provided by the python-zaqarclient plugin.

45.14. messaging ping

Usage:

openstack messaging ping [-h] [-f {json,shell,table,value,yaml}]

                              [-c COLUMN] [--max-width <integer>]
                              [--fit-width] [--print-empty] [--noindent]
                              [--prefix PREFIX]
Copy to Clipboard Toggle word wrap

Check if Zaqar server is alive or not

Expand
Table 45.56. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 45.57. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 45.58. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 45.59. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 45.60. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-zaqarclient plugin.

45.15. messaging pool create

Usage:

openstack messaging pool create [-h] [-f {json,shell,table,value,yaml}]

                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent] [--prefix PREFIX]
                                     [--pool_group <pool_group>]
                                     [--pool_options <pool_options>]
                                     <pool_name> <pool_uri> <pool_weight>
Copy to Clipboard Toggle word wrap

Create a pool

Expand
Table 45.61. Positional Arguments
ValueSummary

<pool_name>

Name of the pool

<pool_uri>

Storage engine uri

<pool_weight>

Weight of the pool

Expand
Table 45.62. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--pool_group <pool_group>

Group of the pool

--pool_options <pool_options>

An optional request component related to storage- specific options

Expand
Table 45.63. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 45.64. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 45.65. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 45.66. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-zaqarclient plugin.

45.16. messaging pool delete

Usage:

openstack messaging pool delete [-h] <pool_name>
Copy to Clipboard Toggle word wrap

Delete a pool

Expand
Table 45.67. Positional Arguments
ValueSummary

<pool_name>

Name of the pool

Expand
Table 45.68. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-zaqarclient plugin.

45.17. messaging pool list

Usage:

openstack messaging pool list [-h] [-f {csv,json,table,value,yaml}]

                                   [-c COLUMN] [--max-width <integer>]
                                   [--fit-width] [--print-empty]
                                   [--noindent]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--sort-column SORT_COLUMN]
                                   [--marker <pool_name>] [--limit <limit>]
                                   [--detailed]
Copy to Clipboard Toggle word wrap

List available Pools

Expand
Table 45.69. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--marker <pool_name>

Pool’s paging marker

--limit <limit>

Page size limit

--detailed

Detailed output

Expand
Table 45.70. Output Formatters
ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Expand
Table 45.71. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 45.72. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 45.73. CSV Formatter
ValueSummary

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

This command is provided by the python-zaqarclient plugin.

45.18. messaging pool show

Usage:

openstack messaging pool show [-h] [-f {json,shell,table,value,yaml}]

                                   [-c COLUMN] [--max-width <integer>]
                                   [--fit-width] [--print-empty]
                                   [--noindent] [--prefix PREFIX]
                                   <pool_name>
Copy to Clipboard Toggle word wrap

Display pool details

Expand
Table 45.74. Positional Arguments
ValueSummary

<pool_name>

Pool to display (name)

Expand
Table 45.75. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 45.76. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 45.77. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 45.78. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 45.79. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-zaqarclient plugin.

45.19. messaging pool update

Usage:

openstack messaging pool update [-h] [-f {json,shell,table,value,yaml}]

                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent] [--prefix PREFIX]
                                     [--pool_uri <pool_uri>]
                                     [--pool_weight <pool_weight>]
                                     [--pool_group <pool_group>]
                                     [--pool_options <pool_options>]
                                     <pool_name>
Copy to Clipboard Toggle word wrap

Update a pool attribute

Expand
Table 45.80. Positional Arguments
ValueSummary

<pool_name>

Name of the pool

Expand
Table 45.81. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--pool_uri <pool_uri>

Storage engine URI

--pool_weight <pool_weight>

Weight of the pool

--pool_group <pool_group>

Group of the pool

--pool_options <pool_options>

An optional request component related to storage- specific options

Expand
Table 45.82. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 45.83. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 45.84. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 45.85. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-zaqarclient plugin.

45.20. messaging queue create

Usage:

openstack messaging queue create [-h]

                                      [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent] [--prefix PREFIX]
                                      <queue_name>
Copy to Clipboard Toggle word wrap

Create a queue

Expand
Table 45.86. Positional Arguments
ValueSummary

<queue_name>

Name of the queue

Expand
Table 45.87. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 45.88. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 45.89. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 45.90. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 45.91. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-zaqarclient plugin.

45.21. messaging queue delete

Usage:

openstack messaging queue delete [-h] <queue_name>
Copy to Clipboard Toggle word wrap

Delete a queue

Expand
Table 45.92. Positional Arguments
ValueSummary

<queue_name>

Name of the queue

Expand
Table 45.93. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-zaqarclient plugin.

45.22. messaging queue get metadata

Usage:

openstack messaging queue get metadata [-h]

                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent] [--prefix PREFIX]
                                            <queue_name>
Copy to Clipboard Toggle word wrap

Get queue metadata

Expand
Table 45.94. Positional Arguments
ValueSummary

<queue_name>

Name of the queue

Expand
Table 45.95. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 45.96. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 45.97. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 45.98. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 45.99. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-zaqarclient plugin.

45.23. messaging queue list

Usage:

openstack messaging queue list [-h] [-f {csv,json,table,value,yaml}]

                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty]
                                    [--noindent]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [--sort-column SORT_COLUMN]
                                    [--marker <queue_id>] [--limit <limit>]
                                    [--detailed]
Copy to Clipboard Toggle word wrap

List available queues

Expand
Table 45.100. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--marker <queue_id>

Queue’s paging marker

--limit <limit>

Page size limit

--detailed

If show detailed information of queue

Expand
Table 45.101. Output Formatters
ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Expand
Table 45.102. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 45.103. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 45.104. CSV Formatter
ValueSummary

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

This command is provided by the python-zaqarclient plugin.

45.24. messaging queue purge

Usage:

openstack messaging queue purge [-h]

                                     [--resource_types <resource_types>]
                                     <queue_name>
Copy to Clipboard Toggle word wrap

Purge a queue

Expand
Table 45.105. Positional Arguments
ValueSummary

<queue_name>

Name of the queue

Expand
Table 45.106. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--resource_types <resource_types>

Resource types want to be purged.

This command is provided by the python-zaqarclient plugin.

45.25. messaging queue set metadata

Usage:

openstack messaging queue set metadata [-h]

                                            <queue_name> <queue_metadata>
Copy to Clipboard Toggle word wrap

Set queue metadata

Expand
Table 45.107. Positional Arguments
ValueSummary

<queue_name>

Name of the queue

<queue_metadata>

Queue metadata, all the metadata of the queue will be replaced by queue_metadata

Expand
Table 45.108. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-zaqarclient plugin.

45.26. messaging queue signed url

Usage:

openstack messaging queue signed url [-h]

                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent] [--prefix PREFIX]
                                          [--paths <paths>]
                                          [--ttl-seconds <ttl_seconds>]
                                          [--methods <methods>]
                                          <queue_name>
Copy to Clipboard Toggle word wrap

Create a pre-signed url

Expand
Table 45.109. Positional Arguments
ValueSummary

<queue_name>

Name of the queue

Expand
Table 45.110. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--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

Expand
Table 45.111. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 45.112. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 45.113. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 45.114. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-zaqarclient plugin.

45.27. messaging queue stats

Usage:

openstack messaging queue stats [-h] [-f {json,shell,table,value,yaml}]

                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent] [--prefix PREFIX]
                                     <queue_name>
Copy to Clipboard Toggle word wrap

Get queue stats

Expand
Table 45.115. Positional Arguments
ValueSummary

<queue_name>

Name of the queue

Expand
Table 45.116. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 45.117. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 45.118. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 45.119. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 45.120. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-zaqarclient plugin.

45.28. messaging subscription create

Usage:

openstack messaging subscription create [-h]

                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--noindent] [--prefix PREFIX]
                                             [--options <options>]
                                             <queue_name> <subscriber> <ttl>
Copy to Clipboard Toggle word wrap

Create a subscription for queue

Expand
Table 45.121. Positional Arguments
ValueSummary

<queue_name>

Name of the queue to subscribe to

<subscriber>

Subscriber which will be notified

<ttl>

Time to live of the subscription in seconds

Expand
Table 45.122. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--options <options>

Metadata of the subscription in json format

Expand
Table 45.123. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 45.124. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 45.125. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 45.126. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-zaqarclient plugin.

45.29. messaging subscription delete

Usage:

openstack messaging subscription delete [-h]

                                             <queue_name> <subscription_id>
Copy to Clipboard Toggle word wrap

Delete a subscription

Expand
Table 45.127. Positional Arguments
ValueSummary

<queue_name>

Name of the queue for the subscription

<subscription_id>

Id of the subscription

Expand
Table 45.128. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-zaqarclient plugin.

45.30. messaging subscription list

Usage:

openstack messaging subscription list [-h]

                                           [-f {csv,json,table,value,yaml}]
                                           [-c COLUMN]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent]
                                           [--quote {all,minimal,none,nonnumeric}]
                                           [--sort-column SORT_COLUMN]
                                           [--marker <subscription_id>]
                                           [--limit <limit>]
                                           <queue_name>
Copy to Clipboard Toggle word wrap

List available subscriptions

Expand
Table 45.129. Positional Arguments
ValueSummary

<queue_name>

Name of the queue to subscribe to

Expand
Table 45.130. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--marker <subscription_id>

Subscription’s paging marker, the ID of the last subscription of the previous page

--limit <limit>

Page size limit, default value is 20

Expand
Table 45.131. Output Formatters
ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Expand
Table 45.132. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 45.133. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 45.134. CSV Formatter
ValueSummary

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

This command is provided by the python-zaqarclient plugin.

45.31. messaging subscription show

Usage:

openstack messaging subscription show [-h]

                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent] [--prefix PREFIX]
                                           <queue_name> <subscription_id>
Copy to Clipboard Toggle word wrap

Display subscription details

Expand
Table 45.135. Positional Arguments
ValueSummary

<queue_name>

Name of the queue to subscribe to

<subscription_id>

Id of the subscription

Expand
Table 45.136. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 45.137. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 45.138. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 45.139. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 45.140. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-zaqarclient plugin.

45.32. messaging subscription update

Usage:

openstack messaging subscription update [-h]

                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--noindent] [--prefix PREFIX]
                                             [--subscriber <subscriber>]
                                             [--ttl <ttl>]
                                             [--options <options>]
                                             <queue_name> <subscription_id>
Copy to Clipboard Toggle word wrap

Update a subscription

Expand
Table 45.141. Positional Arguments
ValueSummary

<queue_name>

Name of the queue to subscribe to

<subscription_id>

Id of the subscription

Expand
Table 45.142. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--subscriber <subscriber>

Subscriber which will be notified

--ttl <ttl>

Time to live of the subscription in seconds

--options <options>

Metadata of the subscription in json format

Expand
Table 45.143. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 45.144. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 45.145. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 45.146. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-zaqarclient plugin.

Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat