Search

Chapter 49. messaging

download PDF

This chapter describes the commands under the messaging command.

49.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 49.1. Positional arguments
ValueSummary

<queue_name>

Name of the queue to be claim

Table 49.2. Command 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 49.3. Output formatter options
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 49.4. CSV formatter options
ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 49.5. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 49.6. Table formatter options
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.

49.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 49.7. Positional arguments
ValueSummary

<queue_name>

Name of the claimed queue

<claim_id>

Id of the claim

Table 49.8. Command arguments
ValueSummary

-h, --help

Show this help message and exit

Table 49.9. Output formatter options
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 49.10. CSV formatter options
ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 49.11. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 49.12. Table formatter options
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.

49.3. messaging claim release

Delete a claim

Usage:

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

Table 49.13. Positional arguments
ValueSummary

<queue_name>

Name of the claimed queue

<claim_id>

Claim id to delete

Table 49.14. Command arguments
ValueSummary

-h, --help

Show this help message and exit

49.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 49.15. Positional arguments
ValueSummary

<queue_name>

Name of the claimed queue

<claim_id>

Claim id

Table 49.16. Command 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 49.17. Output formatter options
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 49.18. CSV formatter options
ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 49.19. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 49.20. Table formatter options
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.

49.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 49.21. Positional arguments
ValueSummary

<flavor_name>

Name of the flavor

Table 49.22. Command 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 49.23. Output formatter options
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 49.24. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 49.25. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 49.26. Table formatter options
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.

49.6. messaging flavor delete

Delete a pool flavor

Usage:

openstack messaging flavor delete [-h] <flavor_name>

Table 49.27. Positional arguments
ValueSummary

<flavor_name>

Name of the flavor

Table 49.28. Command arguments
ValueSummary

-h, --help

Show this help message and exit

49.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 49.29. Command 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 49.30. Output formatter options
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 49.31. CSV formatter options
ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 49.32. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 49.33. Table formatter options
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.

49.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 49.34. Positional arguments
ValueSummary

<flavor_name>

Flavor to display (name)

Table 49.35. Command arguments
ValueSummary

-h, --help

Show this help message and exit

Table 49.36. Output formatter options
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 49.37. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 49.38. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 49.39. Table formatter options
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.

49.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 49.40. Positional arguments
ValueSummary

<flavor_name>

Name of the flavor

Table 49.41. Command 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 49.42. Output formatter options
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 49.43. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 49.44. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 49.45. Table formatter options
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.

49.10. messaging health

Display detailed health status of Zaqar server

Usage:

openstack messaging health [-h]

Table 49.46. Command arguments
ValueSummary

-h, --help

Show this help message and exit

49.11. messaging homedoc

Display detailed resource doc of Zaqar server

Usage:

openstack messaging homedoc [-h]

Table 49.47. Command arguments
ValueSummary

-h, --help

Show this help message and exit

49.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 49.48. Positional arguments
ValueSummary

<queue_name>

Name of the queue

Table 49.49. Command 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 49.50. Output formatter options
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 49.51. CSV formatter options
ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 49.52. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 49.53. Table formatter options
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.

49.13. messaging message post

Post messages for a given queue

Usage:

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

Table 49.54. Positional arguments
ValueSummary

<queue_name>

Name of the queue

<messages>

Messages to be posted.

Table 49.55. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--client-id <client_id>

A uuid for each client instance.

49.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 49.56. Command arguments
ValueSummary

-h, --help

Show this help message and exit

Table 49.57. Output formatter options
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 49.58. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 49.59. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 49.60. Table formatter options
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.

49.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 49.61. Positional arguments
ValueSummary

<pool_name>

Name of the pool

<pool_uri>

Storage engine uri

<pool_weight>

Weight of the pool

Table 49.62. Command 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 49.63. Output formatter options
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 49.64. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 49.65. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 49.66. Table formatter options
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.

49.16. messaging pool delete

Delete a pool

Usage:

openstack messaging pool delete [-h] <pool_name>

Table 49.67. Positional arguments
ValueSummary

<pool_name>

Name of the pool

Table 49.68. Command arguments
ValueSummary

-h, --help

Show this help message and exit

49.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 49.69. Command 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 49.70. Output formatter options
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 49.71. CSV formatter options
ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 49.72. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 49.73. Table formatter options
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.

49.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 49.74. Positional arguments
ValueSummary

<pool_name>

Pool to display (name)

Table 49.75. Command arguments
ValueSummary

-h, --help

Show this help message and exit

Table 49.76. Output formatter options
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 49.77. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 49.78. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 49.79. Table formatter options
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.

49.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 49.80. Positional arguments
ValueSummary

<pool_name>

Name of the pool

Table 49.81. Command 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 49.82. Output formatter options
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 49.83. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 49.84. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 49.85. Table formatter options
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.

49.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 49.86. Positional arguments
ValueSummary

<queue_name>

Name of the queue

Table 49.87. Command arguments
ValueSummary

-h, --help

Show this help message and exit

Table 49.88. Output formatter options
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 49.89. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 49.90. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 49.91. Table formatter options
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.

49.21. messaging queue delete

Delete a queue

Usage:

openstack messaging queue delete [-h] <queue_name>

Table 49.92. Positional arguments
ValueSummary

<queue_name>

Name of the queue

Table 49.93. Command arguments
ValueSummary

-h, --help

Show this help message and exit

49.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 49.94. Positional arguments
ValueSummary

<queue_name>

Name of the queue

Table 49.95. Command arguments
ValueSummary

-h, --help

Show this help message and exit

Table 49.96. Output formatter options
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 49.97. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 49.98. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 49.99. Table formatter options
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.

49.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 49.100. Command 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 49.101. Output formatter options
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 49.102. CSV formatter options
ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 49.103. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 49.104. Table formatter options
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.

49.24. messaging queue purge

Purge a queue

Usage:

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

Table 49.105. Positional arguments
ValueSummary

<queue_name>

Name of the queue

Table 49.106. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--resource_types <resource_types>

Resource types want to be purged.

49.25. messaging queue set metadata

Set queue metadata

Usage:

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

Table 49.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 49.108. Command arguments
ValueSummary

-h, --help

Show this help message and exit

49.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 49.109. Positional arguments
ValueSummary

<queue_name>

Name of the queue

Table 49.110. Command 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 49.111. Output formatter options
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 49.112. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 49.113. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 49.114. Table formatter options
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.

49.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 49.115. Positional arguments
ValueSummary

<queue_name>

Name of the queue

Table 49.116. Command arguments
ValueSummary

-h, --help

Show this help message and exit

Table 49.117. Output formatter options
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 49.118. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 49.119. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 49.120. Table formatter options
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.

49.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 49.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 49.122. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--options <options>

Metadata of the subscription in json format

Table 49.123. Output formatter options
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 49.124. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 49.125. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 49.126. Table formatter options
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.

49.29. messaging subscription delete

Delete a subscription

Usage:

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

Table 49.127. Positional arguments
ValueSummary

<queue_name>

Name of the queue for the subscription

<subscription_id>

Id of the subscription

Table 49.128. Command arguments
ValueSummary

-h, --help

Show this help message and exit

49.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 49.129. Positional arguments
ValueSummary

<queue_name>

Name of the queue to subscribe to

Table 49.130. Command 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 49.131. Output formatter options
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 49.132. CSV formatter options
ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 49.133. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 49.134. Table formatter options
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.

49.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 49.135. Positional arguments
ValueSummary

<queue_name>

Name of the queue to subscribe to

<subscription_id>

Id of the subscription

Table 49.136. Command arguments
ValueSummary

-h, --help

Show this help message and exit

Table 49.137. Output formatter options
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 49.138. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 49.139. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 49.140. Table formatter options
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.

49.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 49.141. Positional arguments
ValueSummary

<queue_name>

Name of the queue to subscribe to

<subscription_id>

Id of the subscription

Table 49.142. Command 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 49.143. Output formatter options
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 49.144. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 49.145. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 49.146. Table formatter options
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.

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.

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.

© 2024 Red Hat, Inc.