Chapter 46. messaging This chapter describes the commands under the messaging command. 46.1. messaging claim create Create claim and return a list of claimed messages Usage: Table 46.1. Positional arguments Value Summary <queue_name> Name of the queue to be claim Table 46.2. Command arguments Value Summary -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 46.3. Output formatter options Value Summary -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 to show multiple columns --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 --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 46.4. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 46.5. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 46.6. Table formatter options Value Summary --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. 46.2. messaging claim query Display claim details Usage: Table 46.7. Positional arguments Value Summary <queue_name> Name of the claimed queue <claim_id> Id of the claim Table 46.8. Command arguments Value Summary -h, --help Show this help message and exit Table 46.9. Output formatter options Value Summary -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 to show multiple columns --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 --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 46.10. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 46.11. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 46.12. Table formatter options Value Summary --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. 46.3. messaging claim release Delete a claim Usage: Table 46.13. Positional arguments Value Summary <queue_name> Name of the claimed queue <claim_id> Claim id to delete Table 46.14. Command arguments Value Summary -h, --help Show this help message and exit 46.4. messaging claim renew Renew a claim Usage: Table 46.15. Positional arguments Value Summary <queue_name> Name of the claimed queue <claim_id> Claim id Table 46.16. Command arguments Value Summary -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 46.17. Output formatter options Value Summary -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 to show multiple columns --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 --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 46.18. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 46.19. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 46.20. Table formatter options Value Summary --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. 46.5. messaging flavor create Create a pool flavor Usage: Table 46.21. Positional arguments Value Summary <flavor_name> Name of the flavor Table 46.22. Command arguments Value Summary -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 46.23. Output formatter options Value Summary -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 to show multiple columns Table 46.24. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 46.25. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 46.26. Table formatter options Value Summary --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. 46.6. messaging flavor delete Delete a pool flavor Usage: Table 46.27. Positional arguments Value Summary <flavor_name> Name of the flavor Table 46.28. Command arguments Value Summary -h, --help Show this help message and exit 46.7. messaging flavor list List available pool flavors Usage: Table 46.29. Command arguments Value Summary -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 46.30. Output formatter options Value Summary -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 to show multiple columns --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 --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 46.31. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 46.32. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 46.33. Table formatter options Value Summary --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. 46.8. messaging flavor show Display pool flavor details Usage: Table 46.34. Positional arguments Value Summary <flavor_name> Flavor to display (name) Table 46.35. Command arguments Value Summary -h, --help Show this help message and exit Table 46.36. Output formatter options Value Summary -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 to show multiple columns Table 46.37. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 46.38. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 46.39. Table formatter options Value Summary --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. 46.9. messaging flavor update Update a flavor's attributes Usage: Table 46.40. Positional arguments Value Summary <flavor_name> Name of the flavor Table 46.41. Command arguments Value Summary -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 46.42. Output formatter options Value Summary -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 to show multiple columns Table 46.43. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 46.44. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 46.45. Table formatter options Value Summary --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. 46.10. messaging health Display detailed health status of Zaqar server Usage: Table 46.46. Command arguments Value Summary -h, --help Show this help message and exit 46.11. messaging homedoc Display detailed resource doc of Zaqar server Usage: Table 46.47. Command arguments Value Summary -h, --help Show this help message and exit 46.12. messaging message list List all messages for a given queue Usage: Table 46.48. Positional arguments Value Summary <queue_name> Name of the queue Table 46.49. Command arguments Value Summary -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 46.50. Output formatter options Value Summary -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 to show multiple columns --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 --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 46.51. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 46.52. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 46.53. Table formatter options Value Summary --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. 46.13. messaging message post Post messages for a given queue Usage: Table 46.54. Positional arguments Value Summary <queue_name> Name of the queue <messages> Messages to be posted. Table 46.55. Command arguments Value Summary -h, --help Show this help message and exit --client-id <client_id> A uuid for each client instance. 46.14. messaging ping Check if Zaqar server is alive or not Usage: Table 46.56. Command arguments Value Summary -h, --help Show this help message and exit Table 46.57. Output formatter options Value Summary -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 to show multiple columns Table 46.58. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 46.59. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 46.60. Table formatter options Value Summary --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. 46.15. messaging pool create Create a pool Usage: Table 46.61. Positional arguments Value Summary <pool_name> Name of the pool <pool_uri> Storage engine uri <pool_weight> Weight of the pool Table 46.62. Command arguments Value Summary -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 46.63. Output formatter options Value Summary -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 to show multiple columns Table 46.64. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 46.65. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 46.66. Table formatter options Value Summary --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. 46.16. messaging pool delete Delete a pool Usage: Table 46.67. Positional arguments Value Summary <pool_name> Name of the pool Table 46.68. Command arguments Value Summary -h, --help Show this help message and exit 46.17. messaging pool list List available Pools Usage: Table 46.69. Command arguments Value Summary -h, --help Show this help message and exit --marker <pool_name> Pool's paging marker --limit <limit> Page size limit --detailed Detailed output Table 46.70. Output formatter options Value Summary -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 to show multiple columns --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 --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 46.71. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 46.72. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 46.73. Table formatter options Value Summary --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. 46.18. messaging pool show Display pool details Usage: Table 46.74. Positional arguments Value Summary <pool_name> Pool to display (name) Table 46.75. Command arguments Value Summary -h, --help Show this help message and exit Table 46.76. Output formatter options Value Summary -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 to show multiple columns Table 46.77. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 46.78. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 46.79. Table formatter options Value Summary --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. 46.19. messaging pool update Update a pool attribute Usage: Table 46.80. Positional arguments Value Summary <pool_name> Name of the pool Table 46.81. Command arguments Value Summary -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 46.82. Output formatter options Value Summary -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 to show multiple columns Table 46.83. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 46.84. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 46.85. Table formatter options Value Summary --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. 46.20. messaging queue create Create a queue Usage: Table 46.86. Positional arguments Value Summary <queue_name> Name of the queue Table 46.87. Command arguments Value Summary -h, --help Show this help message and exit Table 46.88. Output formatter options Value Summary -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 to show multiple columns Table 46.89. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 46.90. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 46.91. Table formatter options Value Summary --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. 46.21. messaging queue delete Delete a queue Usage: Table 46.92. Positional arguments Value Summary <queue_name> Name of the queue Table 46.93. Command arguments Value Summary -h, --help Show this help message and exit 46.22. messaging queue get metadata Get queue metadata Usage: Table 46.94. Positional arguments Value Summary <queue_name> Name of the queue Table 46.95. Command arguments Value Summary -h, --help Show this help message and exit Table 46.96. Output formatter options Value Summary -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 to show multiple columns Table 46.97. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 46.98. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 46.99. Table formatter options Value Summary --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. 46.23. messaging queue list List available queues Usage: Table 46.100. Command arguments Value Summary -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 --with_count If show amount information of queue Table 46.101. Output formatter options Value Summary -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 to show multiple columns --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 --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 46.102. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 46.103. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 46.104. Table formatter options Value Summary --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. 46.24. messaging queue purge Purge a queue Usage: Table 46.105. Positional arguments Value Summary <queue_name> Name of the queue Table 46.106. Command arguments Value Summary -h, --help Show this help message and exit --resource_types <resource_types> Resource types want to be purged. 46.25. messaging queue set metadata Set queue metadata Usage: Table 46.107. Positional arguments Value Summary <queue_name> Name of the queue <queue_metadata> Queue metadata, all the metadata of the queue will be replaced by queue_metadata Table 46.108. Command arguments Value Summary -h, --help Show this help message and exit 46.26. messaging queue signed url Create a pre-signed url Usage: Table 46.109. Positional arguments Value Summary <queue_name> Name of the queue Table 46.110. Command arguments Value Summary -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 46.111. Output formatter options Value Summary -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 to show multiple columns Table 46.112. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 46.113. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 46.114. Table formatter options Value Summary --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. 46.27. messaging queue stats Get queue stats Usage: Table 46.115. Positional arguments Value Summary <queue_name> Name of the queue Table 46.116. Command arguments Value Summary -h, --help Show this help message and exit Table 46.117. Output formatter options Value Summary -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 to show multiple columns Table 46.118. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 46.119. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 46.120. Table formatter options Value Summary --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. 46.28. messaging subscription create Create a subscription for queue Usage: Table 46.121. Positional arguments Value Summary <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 46.122. Command arguments Value Summary -h, --help Show this help message and exit --options <options> Metadata of the subscription in json format Table 46.123. Output formatter options Value Summary -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 to show multiple columns Table 46.124. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 46.125. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 46.126. Table formatter options Value Summary --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. 46.29. messaging subscription delete Delete a subscription Usage: Table 46.127. Positional arguments Value Summary <queue_name> Name of the queue for the subscription <subscription_id> Id of the subscription Table 46.128. Command arguments Value Summary -h, --help Show this help message and exit 46.30. messaging subscription list List available subscriptions Usage: Table 46.129. Positional arguments Value Summary <queue_name> Name of the queue to subscribe to Table 46.130. Command arguments Value Summary -h, --help Show this help message and exit --marker <subscription_id> Subscription's paging marker, the id of the last subscription of the page --limit <limit> Page size limit, default value is 20 Table 46.131. Output formatter options Value Summary -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 to show multiple columns --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 --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 46.132. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 46.133. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 46.134. Table formatter options Value Summary --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. 46.31. messaging subscription show Display subscription details Usage: Table 46.135. Positional arguments Value Summary <queue_name> Name of the queue to subscribe to <subscription_id> Id of the subscription Table 46.136. Command arguments Value Summary -h, --help Show this help message and exit Table 46.137. Output formatter options Value Summary -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 to show multiple columns Table 46.138. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 46.139. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 46.140. Table formatter options Value Summary --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. 46.32. messaging subscription update Update a subscription Usage: Table 46.141. Positional arguments Value Summary <queue_name> Name of the queue to subscribe to <subscription_id> Id of the subscription Table 46.142. Command arguments Value Summary -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 46.143. Output formatter options Value Summary -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 to show multiple columns Table 46.144. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 46.145. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 46.146. Table formatter options Value Summary --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.

Commands:
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] [--sort-ascending | --sort-descending] [--ttl <ttl>] [--grace <grace>] [--limit <limit>] <queue_name>
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] [--sort-ascending | --sort-descending] <queue_name> <claim_id>
openstack messaging claim release [-h] <queue_name> <claim_id>
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] [--sort-ascending | --sort-descending] [--ttl <ttl>] [--grace <grace>] <queue_name> <claim_id>
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>
openstack messaging flavor delete [-h] <flavor_name>
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] [--sort-ascending | --sort-descending] [--marker <flavor_name>] [--limit <limit>] [--detailed]
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>
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>
openstack messaging health [-h]
openstack messaging homedoc [-h]
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] [--sort-ascending | --sort-descending] [--message-ids <message_ids>] [--limit <limit>] [--echo] [--include-claimed] [--include-delayed] [--client-id <client_id>] <queue_name>
openstack messaging message post [-h] [--client-id <client_id>] <queue_name> <messages>
openstack messaging ping [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty]
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>
openstack messaging pool delete [-h] <pool_name>
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] [--sort-ascending | --sort-descending] [--marker <pool_name>] [--limit <limit>] [--detailed]
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>
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>
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>
openstack messaging queue delete [-h] <queue_name>
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>
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] [--sort-ascending | --sort-descending] [--marker <queue_id>] [--limit <limit>] [--detailed] [--with_count]
openstack messaging queue purge [-h] [--resource_types <resource_types>] <queue_name>
openstack messaging queue set metadata [-h] <queue_name> <queue_metadata>
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>
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>
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>
openstack messaging subscription delete [-h] <queue_name> <subscription_id>
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] [--sort-ascending | --sort-descending] [--marker <subscription_id>] [--limit <limit>] <queue_name>
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>
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>