Menu Close

Chapter 40. messaging

This chapter describes the commands under the messaging command.

40.1. messaging claim create

Create claim and return a list of claimed messages

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>

Table 40.1. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 40.2. Positional Arguments

ValueSummary

<queue_name>

Name of the queue to be claim

Table 40.3. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 40.4. Output Formatters

ValueSummary

output formatter options-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

Table 40.5. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 40.6. Optional Arguments

ValueSummary

--limit <limit>

Claims a set of messages, up to limit

-h, --help

Show this help message and exit

--grace <grace>

The message grace period in seconds

--ttl <ttl>

Time to live in seconds for claim

40.2. messaging claim query

Display claim details

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>

Table 40.7. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 40.8. Positional Arguments

ValueSummary

<claim_id>

Id of the claim

<queue_name>

Name of the claimed queue

Table 40.9. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 40.10. Output Formatters

ValueSummary

output formatter options-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

Table 40.11. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 40.12. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

40.3. messaging claim release

Delete a claim

Usage:

openstack messaging claim release [-h] <queue_name> <claim_id>

Table 40.13. Positional Arguments

ValueSummary

<claim_id>

Claim id to delete

<queue_name>

Name of the claimed queue

Table 40.14. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

40.4. messaging claim renew

Renew a claim

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>

Table 40.15. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 40.16. Positional Arguments

ValueSummary

<claim_id>

Claim id

<queue_name>

Name of the claimed queue

Table 40.17. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 40.18. Output Formatters

ValueSummary

output formatter options-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

Table 40.19. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 40.20. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--grace <grace>

The message grace period in seconds

--ttl <ttl>

Time to live in seconds for claim

40.5. messaging flavor create

Create a pool flavor

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>

Table 40.21. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 40.22. Positional Arguments

ValueSummary

<pool_group>

Pool group for flavor

<flavor_name>

Name of the flavor

Table 40.23. Output Formatters

ValueSummary

output formatter options-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

Table 40.24. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 40.25. Optional Arguments

ValueSummary

--capabilities <capabilities>

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

-h, --help

Show this help message and exit

Table 40.26. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

40.6. messaging flavor delete

Delete a pool flavor

Usage:

openstack messaging flavor delete [-h] <flavor_name>

Table 40.27. Positional Arguments

ValueSummary

<flavor_name>

Name of the flavor

Table 40.28. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

40.7. messaging flavor list

List available pool flavors

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]

Table 40.29. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 40.30. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 40.31. Output Formatters

ValueSummary

output formatter options-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

Table 40.32. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 40.33. Optional Arguments

ValueSummary

--detailed

If show detailed capabilities of flavor

--limit <limit>

Page size limit

-h, --help

Show this help message and exit

--marker <flavor_name>

Flavor’s paging marker

40.8. messaging flavor show

Display pool flavor details

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>

Table 40.34. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 40.35. Positional Arguments

ValueSummary

<flavor_name>

Flavor to display (name)

Table 40.36. Output Formatters

ValueSummary

output formatter options-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

Table 40.37. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 40.38. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 40.39. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

40.9. messaging flavor update

Update a flavor’s attributes

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>

Table 40.40. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 40.41. Positional Arguments

ValueSummary

<flavor_name>

Name of the flavor

Table 40.42. Output Formatters

ValueSummary

output formatter options-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

Table 40.43. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 40.44. Optional Arguments

ValueSummary

--pool_group <pool_group>

Pool group the flavor sits on

-h, --help

Show this help message and exit

--capabilities <capabilities>

Describes flavor-specific capabilities.

Table 40.45. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

40.10. messaging health

Display detailed health status of Zaqar server

Usage:

openstack messaging health [-h]

Table 40.46. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

40.11. messaging homedoc

Display detailed resource doc of Zaqar server

Usage:

openstack messaging homedoc [-h]

Table 40.47. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

40.12. messaging message list

List all messages for a given queue

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>

Table 40.48. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 40.49. Positional Arguments

ValueSummary

<queue_name>

Name of the queue

Table 40.50. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 40.51. Output Formatters

ValueSummary

output formatter options-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

Table 40.52. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 40.53. Optional Arguments

ValueSummary

--client-id <client_id>

A uuid for each client instance.

--limit <limit>

Maximum number of messages to get

--echo

Whether to get this client’s own messages

--message-ids <message_ids>

List of messages' ids to retrieve

-h, --help

Show this help message and exit

--include-delayed

Whether to include delayed messages

--include-claimed

Whether to include claimed messages

40.13. messaging message post

Post messages for a given queue

Usage:

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

Table 40.54. Positional Arguments

ValueSummary

<messages>

Messages to be posted.

<queue_name>

Name of the queue

Table 40.55. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--client-id <client_id>

A uuid for each client instance.

40.14. messaging ping

Check if Zaqar server is alive or not

Usage:

openstack messaging ping [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--fit-width] [--print-empty] [--noindent]
                                [--prefix PREFIX]

Table 40.56. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 40.57. Output Formatters

ValueSummary

output formatter options-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

Table 40.58. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 40.59. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 40.60. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

40.15. messaging pool create

Create a pool

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>

Table 40.61. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 40.62. Positional Arguments

ValueSummary

<pool_weight>

Weight of the pool

<pool_name>

Name of the pool

<pool_uri>

Storage engine uri

Table 40.63. Output Formatters

ValueSummary

output formatter options-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

Table 40.64. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 40.65. Optional Arguments

ValueSummary

--pool_group <pool_group>

Group of the pool

-h, --help

Show this help message and exit

--pool_options <pool_options>

An optional request component related to storage- specific options

Table 40.66. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

40.16. messaging pool delete

Delete a pool

Usage:

openstack messaging pool delete [-h] <pool_name>

Table 40.67. Positional Arguments

ValueSummary

<pool_name>

Name of the pool

Table 40.68. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

40.17. messaging pool list

List available Pools

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]

Table 40.69. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 40.70. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 40.71. Output Formatters

ValueSummary

output formatter options-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

Table 40.72. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 40.73. Optional Arguments

ValueSummary

--detailed

Detailed output

--limit <limit>

Page size limit

-h, --help

Show this help message and exit

--marker <pool_name>

Pool’s paging marker

40.18. messaging pool show

Display pool details

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>

Table 40.74. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 40.75. Positional Arguments

ValueSummary

<pool_name>

Pool to display (name)

Table 40.76. Output Formatters

ValueSummary

output formatter options-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

Table 40.77. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 40.78. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 40.79. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

40.19. messaging pool update

Update a pool attribute

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>

Table 40.80. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 40.81. Positional Arguments

ValueSummary

<pool_name>

Name of the pool

Table 40.82. Output Formatters

ValueSummary

output formatter options-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

Table 40.83. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 40.84. Optional Arguments

ValueSummary

--pool_group <pool_group>

Group of the pool

-h, --help

Show this help message and exit

--pool_options <pool_options>

An optional request component related to storage- specific options

--pool_uri <pool_uri>

Storage engine uri

--pool_weight <pool_weight>

Weight of the pool

Table 40.85. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

40.20. messaging queue create

Create a queue

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>

Table 40.86. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 40.87. Positional Arguments

ValueSummary

<queue_name>

Name of the queue

Table 40.88. Output Formatters

ValueSummary

output formatter options-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

Table 40.89. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 40.90. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 40.91. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

40.21. messaging queue delete

Delete a queue

Usage:

openstack messaging queue delete [-h] <queue_name>

Table 40.92. Positional Arguments

ValueSummary

<queue_name>

Name of the queue

Table 40.93. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

40.22. messaging queue get metadata

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

Table 40.94. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 40.95. Positional Arguments

ValueSummary

<queue_name>

Name of the queue

Table 40.96. Output Formatters

ValueSummary

output formatter options-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

Table 40.97. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 40.98. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 40.99. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

40.23. messaging queue list

List available queues

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]

Table 40.100. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 40.101. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 40.102. Output Formatters

ValueSummary

output formatter options-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

Table 40.103. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 40.104. Optional Arguments

ValueSummary

--marker <queue_id>

Queue’s paging marker

--limit <limit>

Page size limit

-h, --help

Show this help message and exit

--detailed

If show detailed information of queue

40.24. messaging queue purge

Purge a queue

Usage:

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

Table 40.105. Positional Arguments

ValueSummary

<queue_name>

Name of the queue

Table 40.106. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--resource_types <resource_types>

Resource types want to be purged.

40.25. messaging queue set metadata

Set queue metadata

Usage:

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

Table 40.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

Table 40.108. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

40.26. messaging queue signed url

Create a pre-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>

Table 40.109. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 40.110. Positional Arguments

ValueSummary

<queue_name>

Name of the queue

Table 40.111. Output Formatters

ValueSummary

output formatter options-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

Table 40.112. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 40.113. Optional Arguments

ValueSummary

--ttl-seconds <ttl_seconds>

Length of time (in seconds) until the signature expires

-h, --help

Show this help message and exit

--paths <paths>

Allowed paths in a comma-separated list. options: messages, subscriptions, claims

--methods <methods>

Http methods to allow as a comma-separated list. Options: GET, HEAD, OPTIONS, POST, PUT, DELETE

Table 40.114. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

40.27. messaging queue stats

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

Table 40.115. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 40.116. Positional Arguments

ValueSummary

<queue_name>

Name of the queue

Table 40.117. Output Formatters

ValueSummary

output formatter options-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

Table 40.118. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 40.119. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 40.120. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

40.28. messaging subscription create

Create a subscription for queue

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>

Table 40.121. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 40.122. Positional Arguments

ValueSummary

<subscriber>

Subscriber which will be notified

<ttl>

Time to live of the subscription in seconds

<queue_name>

Name of the queue to subscribe to

Table 40.123. Output Formatters

ValueSummary

output formatter options-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

Table 40.124. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 40.125. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--options <options>

Metadata of the subscription in json format

Table 40.126. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

40.29. messaging subscription delete

Delete a subscription

Usage:

openstack messaging subscription delete [-h]
                                               <queue_name> <subscription_id>

Table 40.127. Positional Arguments

ValueSummary

<subscription_id>

Id of the subscription

<queue_name>

Name of the queue for the subscription

Table 40.128. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

40.30. messaging subscription list

List available subscriptions

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>

Table 40.129. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 40.130. Positional Arguments

ValueSummary

<queue_name>

Name of the queue to subscribe to

Table 40.131. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 40.132. Output Formatters

ValueSummary

output formatter options-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

Table 40.133. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 40.134. Optional Arguments

ValueSummary

--limit <limit>

Page size limit, default value is 20

-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

40.31. messaging subscription show

Display subscription details

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>

Table 40.135. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 40.136. Positional Arguments

ValueSummary

<subscription_id>

Id of the subscription

<queue_name>

Name of the queue to subscribe to

Table 40.137. Output Formatters

ValueSummary

output formatter options-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

Table 40.138. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 40.139. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 40.140. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

40.32. messaging subscription update

Update a subscription

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>

Table 40.141. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 40.142. Positional Arguments

ValueSummary

<subscription_id>

Id of the subscription

<queue_name>

Name of the queue to subscribe to

Table 40.143. Output Formatters

ValueSummary

output formatter options-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

Table 40.144. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 40.145. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--options <options>

Metadata of the subscription in json format

--subscriber <subscriber>

Subscriber which will be notified

--ttl <ttl>

Time to live of the subscription in seconds

Table 40.146. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names