Chapter 51. messaging

This chapter describes the commands under the messaging command.

51.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]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--noindent] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--sort-column SORT_COLUMN]
                                        [--ttl <ttl>] [--grace <grace>]
                                        [--limit <limit>]
                                        <queue_name>

Table 51.1. Positional Arguments

ValueSummary

<queue_name>

Name of the queue to be claim

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

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

Table 51.4. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 51.5. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

51.2. messaging claim query

Display claim details

Usage:

openstack messaging claim query [-h] [-f {csv,json,table,value,yaml}]
                                       [-c COLUMN]
                                       [--quote {all,minimal,none,nonnumeric}]
                                       [--noindent] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--sort-column SORT_COLUMN]
                                       <queue_name> <claim_id>

Table 51.7. Positional Arguments

ValueSummary

<queue_name>

Name of the claimed queue

<claim_id>

Id of the claim

Table 51.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

Table 51.10. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 51.11. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

51.3. messaging claim release

Delete a claim

Usage:

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

Table 51.13. Positional Arguments

ValueSummary

<queue_name>

Name of the claimed queue

<claim_id>

Claim id to delete

Table 51.14. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

51.4. messaging claim renew

Renew a claim

Usage:

openstack messaging claim renew [-h] [-f {csv,json,table,value,yaml}]
                                       [-c COLUMN]
                                       [--quote {all,minimal,none,nonnumeric}]
                                       [--noindent] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--sort-column SORT_COLUMN]
                                       [--ttl <ttl>] [--grace <grace>]
                                       <queue_name> <claim_id>

Table 51.15. Positional Arguments

ValueSummary

<queue_name>

Name of the claimed queue

<claim_id>

Claim id

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

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

Table 51.18. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 51.19. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

51.5. messaging flavor create

Create a pool flavor

Usage:

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

Table 51.21. Positional Arguments

ValueSummary

<flavor_name>

Name of the flavor

Table 51.22. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--pool_list <pool_list>

Pool list for flavor

--capabilities <capabilities>

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

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

Table 51.24. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 51.25. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

51.6. messaging flavor delete

Delete a pool flavor

Usage:

openstack messaging flavor delete [-h] <flavor_name>

Table 51.27. Positional Arguments

ValueSummary

<flavor_name>

Name of the flavor

Table 51.28. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

51.7. messaging flavor list

List available pool flavors

Usage:

openstack messaging flavor list [-h] [-f {csv,json,table,value,yaml}]
                                       [-c COLUMN]
                                       [--quote {all,minimal,none,nonnumeric}]
                                       [--noindent] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--sort-column SORT_COLUMN]
                                       [--marker <flavor_name>]
                                       [--limit <limit>] [--detailed]

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

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

Table 51.31. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 51.32. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

51.8. messaging flavor show

Display pool flavor details

Usage:

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

Table 51.34. Positional Arguments

ValueSummary

<flavor_name>

Flavor to display (name)

Table 51.35. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

Table 51.37. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 51.38. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

51.9. messaging flavor update

Update a flavor’s attributes

Usage:

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

Table 51.40. Positional Arguments

ValueSummary

<flavor_name>

Name of the flavor

Table 51.41. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--pool_list <pool_list>

Pool list the flavor sits on

--capabilities <capabilities>

Describes flavor-specific capabilities.

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

Table 51.43. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 51.44. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

51.10. messaging health

Display detailed health status of Zaqar server

Usage:

openstack messaging health [-h]

Table 51.46. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

51.11. messaging homedoc

Display detailed resource doc of Zaqar server

Usage:

openstack messaging homedoc [-h]

Table 51.47. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

51.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]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--noindent] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--sort-column SORT_COLUMN]
                                        [--message-ids <message_ids>]
                                        [--limit <limit>] [--echo]
                                        [--include-claimed]
                                        [--include-delayed]
                                        [--client-id <client_id>]
                                        <queue_name>

Table 51.48. Positional Arguments

ValueSummary

<queue_name>

Name of the queue

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

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

Table 51.51. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 51.52. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

51.13. messaging message post

Post messages for a given queue

Usage:

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

Table 51.54. Positional Arguments

ValueSummary

<queue_name>

Name of the queue

<messages>

Messages to be posted.

Table 51.55. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--client-id <client_id>

A uuid for each client instance.

51.14. messaging ping

Check if Zaqar server is alive or not

Usage:

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

Table 51.56. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

Table 51.58. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 51.59. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

51.15. messaging pool create

Create a pool

Usage:

openstack messaging pool create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty] [--flavor <flavor>]
                                       [--pool_options <pool_options>]
                                       <pool_name> <pool_uri> <pool_weight>

Table 51.61. Positional Arguments

ValueSummary

<pool_name>

Name of the pool

<pool_uri>

Storage engine uri

<pool_weight>

Weight of the pool

Table 51.62. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--flavor <flavor>

Flavor of the pool

--pool_options <pool_options>

An optional request component related to storage- specific options

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

Table 51.64. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 51.65. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

51.16. messaging pool delete

Delete a pool

Usage:

openstack messaging pool delete [-h] <pool_name>

Table 51.67. Positional Arguments

ValueSummary

<pool_name>

Name of the pool

Table 51.68. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

51.17. messaging pool list

List available Pools

Usage:

openstack messaging pool list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--noindent] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--sort-column SORT_COLUMN]
                                     [--marker <pool_name>] [--limit <limit>]
                                     [--detailed]

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

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

Table 51.71. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 51.72. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

51.18. messaging pool show

Display pool details

Usage:

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

Table 51.74. Positional Arguments

ValueSummary

<pool_name>

Pool to display (name)

Table 51.75. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

Table 51.77. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 51.78. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

51.19. messaging pool update

Update a pool attribute

Usage:

openstack messaging pool update [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--noindent]
                                       [--prefix PREFIX]
                                       [--max-width <integer>] [--fit-width]
                                       [--print-empty] [--pool_uri <pool_uri>]
                                       [--pool_weight <pool_weight>]
                                       [--flavor <flavor>]
                                       [--pool_options <pool_options>]
                                       <pool_name>

Table 51.80. Positional Arguments

ValueSummary

<pool_name>

Name of the pool

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

--flavor <flavor>

Flavor of the pool

--pool_options <pool_options>

An optional request component related to storage- specific options

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

Table 51.83. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 51.84. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

51.20. messaging queue create

Create a queue

Usage:

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

Table 51.86. Positional Arguments

ValueSummary

<queue_name>

Name of the queue

Table 51.87. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

Table 51.89. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 51.90. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

51.21. messaging queue delete

Delete a queue

Usage:

openstack messaging queue delete [-h] <queue_name>

Table 51.92. Positional Arguments

ValueSummary

<queue_name>

Name of the queue

Table 51.93. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

51.22. messaging queue get metadata

Get queue metadata

Usage:

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

Table 51.94. Positional Arguments

ValueSummary

<queue_name>

Name of the queue

Table 51.95. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

Table 51.97. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 51.98. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

51.23. messaging queue list

List available queues

Usage:

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

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

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

Table 51.102. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 51.103. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

51.24. messaging queue purge

Purge a queue

Usage:

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

Table 51.105. Positional Arguments

ValueSummary

<queue_name>

Name of the queue

Table 51.106. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--resource_types <resource_types>

Resource types want to be purged.

51.25. messaging queue set metadata

Set queue metadata

Usage:

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

Table 51.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 51.108. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

51.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] [--noindent]
                                            [--prefix PREFIX]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--paths <paths>]
                                            [--ttl-seconds <ttl_seconds>]
                                            [--methods <methods>]
                                            <queue_name>

Table 51.109. Positional Arguments

ValueSummary

<queue_name>

Name of the queue

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

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

Table 51.112. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 51.113. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

51.27. messaging queue stats

Get queue stats

Usage:

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

Table 51.115. Positional Arguments

ValueSummary

<queue_name>

Name of the queue

Table 51.116. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

Table 51.118. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 51.119. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

51.28. messaging subscription create

Create a subscription for queue

Usage:

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

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

Table 51.122. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--options <options>

Metadata of the subscription in json format

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

Table 51.124. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 51.125. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

51.29. messaging subscription delete

Delete a subscription

Usage:

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

Table 51.127. Positional Arguments

ValueSummary

<queue_name>

Name of the queue for the subscription

<subscription_id>

Id of the subscription

Table 51.128. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

51.30. messaging subscription list

List available subscriptions

Usage:

openstack messaging subscription list [-h]
                                             [-f {csv,json,table,value,yaml}]
                                             [-c COLUMN]
                                             [--quote {all,minimal,none,nonnumeric}]
                                             [--noindent]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--sort-column SORT_COLUMN]
                                             [--marker <subscription_id>]
                                             [--limit <limit>]
                                             <queue_name>

Table 51.129. Positional Arguments

ValueSummary

<queue_name>

Name of the queue to subscribe to

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

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

Table 51.132. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 51.133. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

51.31. messaging subscription show

Display subscription details

Usage:

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

Table 51.135. Positional Arguments

ValueSummary

<queue_name>

Name of the queue to subscribe to

<subscription_id>

Id of the subscription

Table 51.136. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

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

Table 51.138. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 51.139. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

51.32. messaging subscription update

Update a subscription

Usage:

openstack messaging subscription update [-h]
                                               [-f {json,shell,table,value,yaml}]
                                               [-c COLUMN] [--noindent]
                                               [--prefix PREFIX]
                                               [--max-width <integer>]
                                               [--fit-width] [--print-empty]
                                               [--subscriber <subscriber>]
                                               [--ttl <ttl>]
                                               [--options <options>]
                                               <queue_name> <subscription_id>

Table 51.141. Positional Arguments

ValueSummary

<queue_name>

Name of the queue to subscribe to

<subscription_id>

Id of the subscription

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

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

Table 51.144. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 51.145. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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