このコンテンツは選択した言語では利用できません。

Chapter 25. database


This chapter describes the commands under the database command.

25.1. database backup create

Usage:

openstack database backup create [-h]

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

Creates a backup of an instance.

Expand
Table 25.1. Positional Arguments
ValueSummary

<instance>

Id or name of the instance.

<name>

Name of the backup.

Expand
Table 25.2. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--description <description>

An optional description for the backup.

--parent <parent>

Optional id of the parent backup to perform an incremental backup from.

--incremental

Create an incremental backup based on the last full or incremental backup. It will create a full backup if no existing backup found.

Expand
Table 25.3. Output Formatters
ValueSummary

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

the output format, defaults to table

-c COLUMN, --column COLUMN

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

Expand
Table 25.4. Table Formatter
ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

Expand
Table 25.5. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 25.6. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-troveclient plugin.

25.2. database backup delete

Usage:

openstack database backup delete [-h] <backup>
Copy to Clipboard Toggle word wrap

Deletes a backup.

Expand
Table 25.7. Positional Arguments
ValueSummary

<backup>

Id or name of the backup.

Expand
Table 25.8. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-troveclient plugin.

25.3. database backup execution delete

Usage:

openstack database backup execution delete [-h] <execution>
Copy to Clipboard Toggle word wrap

Deletes an execution.

Expand
Table 25.9. Positional Arguments
ValueSummary

<execution>

Id of the execution to delete.

Expand
Table 25.10. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-troveclient plugin.

25.4. database backup list

Usage:

openstack database backup list [-h] [-f {csv,json,table,value,yaml}]

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

List database backups

Expand
Table 25.11. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--limit <limit>

Return up to n number of the most recent bcakups.

--marker <ID>

Begin displaying the results for ids greater than thespecified marker. When used with :option:`--limit,` setthis to the last ID displayed in the previous run.

--datastore <datastore>

ID or name of the datastore (to filter backups by).

Expand
Table 25.12. Output Formatters
ValueSummary

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

the output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
Table 25.13. Table Formatter
ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

Expand
Table 25.14. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 25.15. CSV Formatter
ValueSummary

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

when to include quotes, defaults to nonnumeric

This command is provided by the python-troveclient plugin.

25.5. database backup list instance

Usage:

openstack database backup list instance [-h]

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

Lists available backups for an instance.

Expand
Table 25.16. Positional Arguments
ValueSummary

<instance>

Id or name of the instance.

Expand
Table 25.17. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--limit <limit>

Return up to n number of the most recent bcakups.

--marker <ID>

Begin displaying the results for ids greater than thespecified marker. When used with :option:`--limit,` setthis to the last ID displayed in the previous run.

Expand
Table 25.18. Output Formatters
ValueSummary

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

the output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
Table 25.19. Table Formatter
ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

Expand
Table 25.20. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 25.21. CSV Formatter
ValueSummary

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

when to include quotes, defaults to nonnumeric

This command is provided by the python-troveclient plugin.

25.6. database backup show

Usage:

openstack database backup show [-h] [-f {json,shell,table,value,yaml}]

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

Shows details of a database backup

Expand
Table 25.22. Positional Arguments
ValueSummary

<backup>

Id or name of the backup

Expand
Table 25.23. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 25.24. Output Formatters
ValueSummary

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

the output format, defaults to table

-c COLUMN, --column COLUMN

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

Expand
Table 25.25. Table Formatter
ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

Expand
Table 25.26. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 25.27. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-troveclient plugin.

25.7. database cluster create

Usage:

openstack database cluster create [-h]

                                       [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent] [--prefix PREFIX]
                                       [--instance "opt=<value>[,opt=<value> ...]
                                       "] [--locality <policy>]
                                       <name> <datastore>
                                       <datastore_version>
Copy to Clipboard Toggle word wrap

Creates a new database cluster.

Expand
Table 25.28. Positional Arguments
ValueSummary

<name>

Name of the cluster.

<datastore>

A datastore name or id.

<datastore_version>

A datastore version name or id.

Expand
Table 25.29. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--instance "opt=<value>[,opt=<value> …​] "

Add an instance to the cluster. Specify multiple times to create multiple instances. Valid options are: flavor=<flavor_name_or_id>, volume=<disk_size_in_GB>, volume_type=<type>, nic='<net-id=<net-uuid>, v4-fixed- ip=<ip-addr>, port-id=<port-uuid>>' (where net- id=network_id, v4-fixed-ip=IPv4r_fixed_address, port- id=port_id), availability_zone=<AZ_hint_for_Nova>, module=<module_name_or_id>, type=<type_of_cluster_node>, related_to=<related_attribute>.

--locality <policy>

Locality policy to use when creating cluster. choose one of affinity, anti-affinity.

Expand
Table 25.30. Output Formatters
ValueSummary

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

the output format, defaults to table

-c COLUMN, --column COLUMN

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

Expand
Table 25.31. Table Formatter
ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

Expand
Table 25.32. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 25.33. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-troveclient plugin.

25.8. database cluster delete

Usage:

openstack database cluster delete [-h] <cluster>
Copy to Clipboard Toggle word wrap

Deletes a cluster.

Expand
Table 25.34. Positional Arguments
ValueSummary

<cluster>

Id or name of the cluster.

Expand
Table 25.35. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-troveclient plugin.

25.9. database cluster force delete

Usage:

openstack database cluster force delete [-h] <cluster>
Copy to Clipboard Toggle word wrap

Force delete a cluster.

Expand
Table 25.36. Positional Arguments
ValueSummary

<cluster>

Id or name of the cluster.

Expand
Table 25.37. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-troveclient plugin.

25.10. database cluster grow

Usage:

openstack database cluster grow [-h]

                                     [--instance "opt=<value>[,opt=<value> ...]
                                     "]
                                     <cluster>
Copy to Clipboard Toggle word wrap

Adds more instances to a cluster.

Expand
Table 25.38. Positional Arguments
ValueSummary

<cluster>

Id or name of the cluster.

Expand
Table 25.39. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--instance "opt=<value>[,opt=<value> …​] "

Add an instance to the cluster. Specify multiple times to create multiple instances. Valid options are: flavor=<flavor_name_or_id>, volume=<disk_size_in_GB>, volume_type=<type>, nic='<net-id=<net-uuid>, v4-fixed- ip=<ip-addr>, port-id=<port-uuid>>' (where net- id=network_id, v4-fixed-ip=IPv4r_fixed_address, port- id=port_id), availability_zone=<AZ_hint_for_Nova>, module=<module_name_or_id>, type=<type_of_cluster_node>, related_to=<related_attribute>.

This command is provided by the python-troveclient plugin.

25.11. database cluster list

Usage:

openstack database cluster list [-h] [-f {csv,json,table,value,yaml}]

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

List database clusters

Expand
Table 25.40. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--limit <limit>

Limit the number of results displayed.

--marker <ID>

Begin displaying the results for ids greater than the specified marker. When used with :option:`--limit,` set this to the last ID displayed in the previous run.

Expand
Table 25.41. Output Formatters
ValueSummary

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

the output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
Table 25.42. Table Formatter
ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

Expand
Table 25.43. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 25.44. CSV Formatter
ValueSummary

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

when to include quotes, defaults to nonnumeric

This command is provided by the python-troveclient plugin.

25.12. database cluster list instances

Usage:

openstack database cluster list instances [-h]

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

Lists all instances of a cluster.

Expand
Table 25.45. Positional Arguments
ValueSummary

<cluster>

Id or name of the cluster.

Expand
Table 25.46. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 25.47. Output Formatters
ValueSummary

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

the output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
Table 25.48. Table Formatter
ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

Expand
Table 25.49. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 25.50. CSV Formatter
ValueSummary

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

when to include quotes, defaults to nonnumeric

This command is provided by the python-troveclient plugin.

25.13. database cluster modules

Usage:

openstack database cluster modules [-h]

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

Lists all modules for each instance of a cluster.

Expand
Table 25.51. Positional Arguments
ValueSummary

<cluster>

Id or name of the cluster.

Expand
Table 25.52. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 25.53. Output Formatters
ValueSummary

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

the output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
Table 25.54. Table Formatter
ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

Expand
Table 25.55. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 25.56. CSV Formatter
ValueSummary

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

when to include quotes, defaults to nonnumeric

This command is provided by the python-troveclient plugin.

25.14. database cluster reset status

Usage:

openstack database cluster reset status [-h] <cluster>
Copy to Clipboard Toggle word wrap

Set the cluster task to NONE.

Expand
Table 25.57. Positional Arguments
ValueSummary

<cluster>

Id or name of the cluster.

Expand
Table 25.58. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-troveclient plugin.

25.15. database cluster show

Usage:

openstack database cluster show [-h] [-f {json,shell,table,value,yaml}]

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

Shows details of a database cluster

Expand
Table 25.59. Positional Arguments
ValueSummary

<cluster>

Id or name of the cluster

Expand
Table 25.60. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 25.61. Output Formatters
ValueSummary

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

the output format, defaults to table

-c COLUMN, --column COLUMN

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

Expand
Table 25.62. Table Formatter
ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

Expand
Table 25.63. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 25.64. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-troveclient plugin.

25.16. database cluster shrink

Usage:

openstack database cluster shrink [-h]

                                       <cluster> <instance> [<instance> ...]
Copy to Clipboard Toggle word wrap

Drops instances from a cluster.

Expand
Table 25.65. Positional Arguments
ValueSummary

<cluster>

Id or name of the cluster.

<instance>

Drop instance(s) from the cluster. specify multiple ids to drop multiple instances.

Expand
Table 25.66. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-troveclient plugin.

25.17. database cluster upgrade

Usage:

openstack database cluster upgrade [-h] <cluster> <datastore_version>
Copy to Clipboard Toggle word wrap

Upgrades a cluster to a new datastore version.

Expand
Table 25.67. Positional Arguments
ValueSummary

<cluster>

Id or name of the cluster.

<datastore_version>

A datastore version name or id.

Expand
Table 25.68. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-troveclient plugin.

25.18. database configuration attach

Usage:

openstack database configuration attach [-h] <instance> <configuration>
Copy to Clipboard Toggle word wrap

Attaches a configuration group to an instance.

Expand
Table 25.69. Positional Arguments
ValueSummary

<instance>

Id or name of the instance

<configuration>

Id or name of the configuration group to attach to the instance.

Expand
Table 25.70. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-troveclient plugin.

25.19. database configuration create

Usage:

openstack database configuration create [-h]

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

Creates a configuration group.

Expand
Table 25.71. Positional Arguments
ValueSummary

<name>

Name of the configuration group.

<values>

Dictionary of the values to set.

Expand
Table 25.72. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--datastore <datastore>

Datastore assigned to the configuration group. Required if default datastore is not configured.

--datastore_version <datastore_version>

Datastore version ID assigned to the configuration group.

--description <description>

An optional description for the configuration group.

Expand
Table 25.73. Output Formatters
ValueSummary

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

the output format, defaults to table

-c COLUMN, --column COLUMN

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

Expand
Table 25.74. Table Formatter
ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

Expand
Table 25.75. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 25.76. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-troveclient plugin.

25.20. database configuration default

Usage:

openstack database configuration default [-h]

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

Shows the default configuration of an instance.

Expand
Table 25.77. Positional Arguments
ValueSummary

<instance>

Id or name of the instance.

Expand
Table 25.78. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 25.79. Output Formatters
ValueSummary

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

the output format, defaults to table

-c COLUMN, --column COLUMN

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

Expand
Table 25.80. Table Formatter
ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

Expand
Table 25.81. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 25.82. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-troveclient plugin.

25.21. database configuration delete

Usage:

openstack database configuration delete [-h] <configuration_group>
Copy to Clipboard Toggle word wrap

Deletes a configuration group.

Expand
Table 25.83. Positional Arguments
ValueSummary

<configuration_group>

ID or name of the configuration group

Expand
Table 25.84. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-troveclient plugin.

25.22. database configuration detach

Usage:

openstack database configuration detach [-h] <instance>
Copy to Clipboard Toggle word wrap

Detaches a configuration group from an instance.

Expand
Table 25.85. Positional Arguments
ValueSummary

<instance>

Id or name of the instance.

Expand
Table 25.86. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-troveclient plugin.

25.23. database configuration instances

Usage:

openstack database configuration instances [-h]

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

Lists all instances associated with a configuration group.

Expand
Table 25.87. Positional Arguments
ValueSummary

<configuration_group>

ID or name of the configuration group.

Expand
Table 25.88. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--limit <limit>

Limit the number of results displayed.

--marker <ID>

Begin displaying the results for ids greater than the specified marker. When used with --limit, set this to the last ID displayed in the previous run.

Expand
Table 25.89. Output Formatters
ValueSummary

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

the output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
Table 25.90. Table Formatter
ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

Expand
Table 25.91. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 25.92. CSV Formatter
ValueSummary

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

when to include quotes, defaults to nonnumeric

This command is provided by the python-troveclient plugin.

25.24. database configuration list

Usage:

openstack database configuration list [-h]

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

List database configurations

Expand
Table 25.93. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--limit <limit>

Limit the number of results displayed.

--marker <ID>

Begin displaying the results for ids greater than the specified marker. When used with --limit, set this to the last ID displayed in the previous run.

Expand
Table 25.94. Output Formatters
ValueSummary

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

the output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
Table 25.95. Table Formatter
ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

Expand
Table 25.96. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 25.97. CSV Formatter
ValueSummary

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

when to include quotes, defaults to nonnumeric

This command is provided by the python-troveclient plugin.

25.25. database configuration parameter list

Usage:

openstack database configuration parameter list [-h]

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

Lists available parameters for a configuration group.

Expand
Table 25.98. Positional Arguments
ValueSummary

<datastore_version>

Datastore version name or id assignedto the configuration group.

Expand
Table 25.99. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--datastore <datastore>

ID or name of the datastore to list configurationparameters for. Optional if the ID of thedatastore_version is provided.

Expand
Table 25.100. Output Formatters
ValueSummary

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

the output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
Table 25.101. Table Formatter
ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

Expand
Table 25.102. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 25.103. CSV Formatter
ValueSummary

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

when to include quotes, defaults to nonnumeric

This command is provided by the python-troveclient plugin.

25.26. database configuration parameter show

Usage:

openstack database configuration parameter show [-h]

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

Shows details of a database configuration parameter.

Expand
Table 25.104. Positional Arguments
ValueSummary

<datastore_version>

Datastore version name or id assigned to the configuration group.

<parameter>

Name of the configuration parameter.

Expand
Table 25.105. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--datastore <datastore>

ID or name of the datastore to list configuration parameters for. Optional if the ID of the datastore_version is provided.

Expand
Table 25.106. Output Formatters
ValueSummary

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

the output format, defaults to table

-c COLUMN, --column COLUMN

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

Expand
Table 25.107. Table Formatter
ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

Expand
Table 25.108. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 25.109. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-troveclient plugin.

25.27. database configuration show

Usage:

openstack database configuration show [-h]

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

Shows details of a database configuration group.

Expand
Table 25.110. Positional Arguments
ValueSummary

<configuration_group>

ID or name of the configuration group

Expand
Table 25.111. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 25.112. Output Formatters
ValueSummary

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

the output format, defaults to table

-c COLUMN, --column COLUMN

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

Expand
Table 25.113. Table Formatter
ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

Expand
Table 25.114. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 25.115. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-troveclient plugin.

25.28. database db create

Usage:

openstack database db create [-h] [--character_set <character_set>]

                                  [--collate <collate>]
                                  <instance> <name>
Copy to Clipboard Toggle word wrap

Creates a database on an instance.

Expand
Table 25.116. Positional Arguments
ValueSummary

<instance>

Id or name of the instance.

<name>

Name of the database.

Expand
Table 25.117. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--character_set <character_set>

Optional character set for database.

--collate <collate>

Optional collation type for database.

This command is provided by the python-troveclient plugin.

25.29. database db delete

Usage:

openstack database db delete [-h] <instance> <database>
Copy to Clipboard Toggle word wrap

Deletes a database from an instance.

Expand
Table 25.118. Positional Arguments
ValueSummary

<instance>

Id or name of the instance.

<database>

Name of the database.

Expand
Table 25.119. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-troveclient plugin.

25.30. database db list

Usage:

openstack database db list [-h] [-f {csv,json,table,value,yaml}]

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

Get a list of all Databases from the instance.

Expand
Table 25.120. Positional Arguments
ValueSummary

<instance>

Id or name of the instance.

Expand
Table 25.121. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 25.122. Output Formatters
ValueSummary

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

the output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
Table 25.123. Table Formatter
ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

Expand
Table 25.124. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 25.125. CSV Formatter
ValueSummary

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

when to include quotes, defaults to nonnumeric

This command is provided by the python-troveclient plugin.

25.31. database flavor list

Usage:

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

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

List database flavors

Expand
Table 25.126. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--datastore-type <datastore-type>

Type of the datastore. For eg: mysql.

--datastore-version-id <datastore-version-id>

ID of the datastore version.

Expand
Table 25.127. Output Formatters
ValueSummary

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

the output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
Table 25.128. Table Formatter
ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

Expand
Table 25.129. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 25.130. CSV Formatter
ValueSummary

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

when to include quotes, defaults to nonnumeric

This command is provided by the python-troveclient plugin.

25.32. database flavor show

Usage:

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

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

Shows details of a database flavor

Expand
Table 25.131. Positional Arguments
ValueSummary

<flavor>

Id or name of the flavor

Expand
Table 25.132. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 25.133. Output Formatters
ValueSummary

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

the output format, defaults to table

-c COLUMN, --column COLUMN

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

Expand
Table 25.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.

Expand
Table 25.135. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 25.136. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-troveclient plugin.

25.33. database instance create

Usage:

openstack database instance create [-h]

                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent] [--prefix PREFIX]
                                        [--size <size>]
                                        [--volume_type <volume_type>]
                                        [--databases <database> [<database> ...]]
                                        [--users <user:password> [<user:password> ...]]
                                        [--backup <backup>]
                                        [--availability_zone <availability_zone>]
                                        [--datastore <datastore>]
                                        [--datastore_version <datastore_version>]
                                        [--nic <net-id=<net-uuid>,v4-fixed-ip=<ip-addr>,port-id=<port-uuid>>]
                                        [--configuration <configuration>]
                                        [--replica_of <source_instance>]
                                        [--replica_count <count>]
                                        [--module <module>]
                                        [--locality <policy>]
                                        <name> <flavor>
Copy to Clipboard Toggle word wrap

Creates a new database instance.

Expand
Table 25.137. Positional Arguments
ValueSummary

<name>

Name of the instance.

<flavor>

A flavor name or id.

Expand
Table 25.138. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--size <size>

Size of the instance disk volume in gb. required when volume support is enabled.

--volume_type <volume_type>

Volume type. Optional when volume support is enabled.

--databases <database> [<database> …​]

Optional list of databases.

--users <user:password> [<user:password> …​]

Optional list of users.

--backup <backup>

A backup name or id.

--availability_zone <availability_zone>

The Zone hint to give to Nova.

--datastore <datastore>

A datastore name or ID.

--datastore_version <datastore_version>

A datastore version name or ID.

--nic <net-id=<net-uuid>,v4-fixed-ip=<ip-addr>,port-id=<port-uuid>>

Create a NIC on the instance. Specify option multiple times to create multiple NICs. net-id: attach NIC to network with this ID (either port-id or net-id must be specified), v4-fixed-ip: IPv4 fixed address for NIC (optional), port-id: attach NIC to port with this ID (either port-id or net-id must be specified).

--configuration <configuration>

ID of the configuration group to attach to the instance.

--replica_of <source_instance>

ID or name of an existing instance to replicate from.

--replica_count <count>

Number of replicas to create (defaults to 1 if replica_of specified).

--module <module>

Id or name of the module to apply. specify multiple times to apply multiple modules.

--locality <policy>

Locality policy to use when creating replicas. choose one of affinity, anti-affinity.

Expand
Table 25.139. Output Formatters
ValueSummary

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

the output format, defaults to table

-c COLUMN, --column COLUMN

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

Expand
Table 25.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.

Expand
Table 25.141. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 25.142. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-troveclient plugin.

25.34. database instance delete

Usage:

openstack database instance delete [-h] <instance>
Copy to Clipboard Toggle word wrap

Deletes an instance.

Expand
Table 25.143. Positional Arguments
ValueSummary

<instance>

Id or name of the instance

Expand
Table 25.144. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-troveclient plugin.

25.35. database instance detach replica

Usage:

openstack database instance detach replica [-h] <instance>
Copy to Clipboard Toggle word wrap

Detaches a replica instance from its replication source.

Expand
Table 25.145. Positional Arguments
ValueSummary

<instance>

Id or name of the instance.

Expand
Table 25.146. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-troveclient plugin.

25.36. database instance eject replica source

Usage:

openstack database instance eject replica source [-h] <instance>
Copy to Clipboard Toggle word wrap

Ejects a replica source from its set.

Expand
Table 25.147. Positional Arguments
ValueSummary

<instance>

Id or name of the instance.

Expand
Table 25.148. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-troveclient plugin.

25.37. database instance force delete

Usage:

openstack database instance force delete [-h] <instance>
Copy to Clipboard Toggle word wrap

Force delete an instance.

Expand
Table 25.149. Positional Arguments
ValueSummary

<instance>

Id or name of the instance

Expand
Table 25.150. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-troveclient plugin.

25.38. database instance list

Usage:

openstack database instance list [-h] [-f {csv,json,table,value,yaml}]

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

List database instances

Expand
Table 25.151. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--limit <limit>

Limit the number of results displayed.

--marker <ID>

Begin displaying the results for ids greater than thespecified marker. When used with :option:`--limit,` setthis to the last ID displayed in the previous run.

--include_clustered, --include-clustered

Include instances that are part of a cluster (default False). --include-clustered may be deprecated in the future, retaining just --include_clustered.

Expand
Table 25.152. Output Formatters
ValueSummary

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

the output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
Table 25.153. Table Formatter
ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

Expand
Table 25.154. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 25.155. CSV Formatter
ValueSummary

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

when to include quotes, defaults to nonnumeric

This command is provided by the python-troveclient plugin.

25.39. database instance promote to replica source

Usage:

openstack database instance promote to replica source [-h] <instance>
Copy to Clipboard Toggle word wrap

Promotes a replica to be the new replica source of its set.

Expand
Table 25.156. Positional Arguments
ValueSummary

<instance>

Id or name of the instance.

Expand
Table 25.157. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-troveclient plugin.

25.40. database instance reset status

Usage:

openstack database instance reset status [-h] <instance>
Copy to Clipboard Toggle word wrap

Set the task status of an instance to NONE if the instance is in BUILD or ERROR state. Resetting task status of an instance in BUILD state will allow the instance to be deleted.

Expand
Table 25.158. Positional Arguments
ValueSummary

<instance>

Id or name of the instance

Expand
Table 25.159. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-troveclient plugin.

25.41. database instance resize flavor

Usage:

openstack database instance resize flavor [-h] <instance> <flavor_id>
Copy to Clipboard Toggle word wrap

Resize an instance with a new flavor

Expand
Table 25.160. Positional Arguments
ValueSummary

<instance>

Id or name of the instance

<flavor_id>

New flavor of the instance

Expand
Table 25.161. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-troveclient plugin.

25.42. database instance resize volume

Usage:

openstack database instance resize volume [-h] <instance> <size>
Copy to Clipboard Toggle word wrap

Resizes the volume size of an instance.

Expand
Table 25.162. Positional Arguments
ValueSummary

<instance>

Id or name of the instance.

<size>

New size of the instance disk volume in gb.

Expand
Table 25.163. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-troveclient plugin.

25.43. database instance restart

Usage:

openstack database instance restart [-h] <instance>
Copy to Clipboard Toggle word wrap

Restarts an instance.

Expand
Table 25.164. Positional Arguments
ValueSummary

<instance>

Id or name of the instance.

Expand
Table 25.165. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-troveclient plugin.

25.44. database instance show

Usage:

openstack database instance show [-h]

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

Show instance details

Expand
Table 25.166. Positional Arguments
ValueSummary

<instance>

Instance (name or id)

Expand
Table 25.167. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 25.168. Output Formatters
ValueSummary

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

the output format, defaults to table

-c COLUMN, --column COLUMN

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

Expand
Table 25.169. Table Formatter
ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

Expand
Table 25.170. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 25.171. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-troveclient plugin.

25.45. database instance update

Usage:

openstack database instance update [-h] [--name <name>]

                                        [--configuration <configuration>]
                                        [--detach_replica_source]
                                        [--remove_configuration]
                                        <instance>
Copy to Clipboard Toggle word wrap

Updates an instance: Edits name, configuration, or replica source.

Expand
Table 25.172. Positional Arguments
ValueSummary

<instance>

Id or name of the instance.

Expand
Table 25.173. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--name <name>

Id or name of the instance.

--configuration <configuration>

ID of the configuration reference to attach.

--detach_replica_source, --detach-replica-source

Detach the replica instance from its replication source. --detach-replica-source may be deprecated in the future in favor of just --detach_replica_source

--remove_configuration

Drops the current configuration reference.

This command is provided by the python-troveclient plugin.

25.46. database instance upgrade

Usage:

openstack database instance upgrade [-h] <instance> <datastore_version>
Copy to Clipboard Toggle word wrap

Upgrades an instance to a new datastore version.

Expand
Table 25.174. Positional Arguments
ValueSummary

<instance>

Id or name of the instance.

<datastore_version>

Id or name of the instance.

Expand
Table 25.175. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-troveclient plugin.

25.47. database limit list

Usage:

openstack database limit list [-h] [-f {csv,json,table,value,yaml}]

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

List database limits

Expand
Table 25.176. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 25.177. Output Formatters
ValueSummary

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

the output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
Table 25.178. Table Formatter
ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

Expand
Table 25.179. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 25.180. CSV Formatter
ValueSummary

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

when to include quotes, defaults to nonnumeric

This command is provided by the python-troveclient plugin.

25.48. database log enable

Usage:

openstack database log enable [-h] [-f {json,shell,table,value,yaml}]

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

Instructs Trove guest to start collecting log details.

Expand
Table 25.181. Positional Arguments
ValueSummary

<instance>

Id or name of the instance.

<log_name>

Name of log to publish.

Expand
Table 25.182. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 25.183. Output Formatters
ValueSummary

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

the output format, defaults to table

-c COLUMN, --column COLUMN

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

Expand
Table 25.184. Table Formatter
ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

Expand
Table 25.185. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 25.186. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-troveclient plugin.

25.49. database log list

Usage:

openstack database log list [-h] [-f {csv,json,table,value,yaml}]

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

Lists the log files available for instance.

Expand
Table 25.187. Positional Arguments
ValueSummary

<instance>

Id or name of the instance.

Expand
Table 25.188. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 25.189. Output Formatters
ValueSummary

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

the output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
Table 25.190. Table Formatter
ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

Expand
Table 25.191. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 25.192. CSV Formatter
ValueSummary

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

when to include quotes, defaults to nonnumeric

This command is provided by the python-troveclient plugin.

25.50. database quota show

Usage:

openstack database quota show [-h] [-f {csv,json,table,value,yaml}]

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

Show quotas for a tenant.

Expand
Table 25.193. Positional Arguments
ValueSummary

<tenant_id>

Id of tenant for which to show quotas.

Expand
Table 25.194. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 25.195. Output Formatters
ValueSummary

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

the output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
Table 25.196. Table Formatter
ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

Expand
Table 25.197. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 25.198. CSV Formatter
ValueSummary

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

when to include quotes, defaults to nonnumeric

This command is provided by the python-troveclient plugin.

25.51. database quota update

Usage:

openstack database quota update [-h] [-f {json,shell,table,value,yaml}]

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

Update quotas for a tenant.

Expand
Table 25.199. Positional Arguments
ValueSummary

<tenant_id>

Id of tenant for which to update quotas.

<resource>

Id of resource to change.

<limit>

New limit to set for the named resource.

Expand
Table 25.200. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 25.201. Output Formatters
ValueSummary

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

the output format, defaults to table

-c COLUMN, --column COLUMN

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

Expand
Table 25.202. Table Formatter
ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

Expand
Table 25.203. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 25.204. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-troveclient plugin.

25.52. database root disable

Usage:

openstack database root disable [-h] <instance>
Copy to Clipboard Toggle word wrap

Disables root for an instance.

Expand
Table 25.205. Positional Arguments
ValueSummary

<instance>

Id or name of the instance.

Expand
Table 25.206. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-troveclient plugin.

25.53. database root enable

Usage:

openstack database root enable [-h] [-f {json,shell,table,value,yaml}]

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

Enables root for an instance and resets if already exists.

Expand
Table 25.207. Positional Arguments
ValueSummary

<instance_or_cluster>

ID or name of the instance or cluster.

Expand
Table 25.208. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--root_password <root_password>

Root password to set.

Expand
Table 25.209. Output Formatters
ValueSummary

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

the output format, defaults to table

-c COLUMN, --column COLUMN

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

Expand
Table 25.210. Table Formatter
ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

Expand
Table 25.211. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 25.212. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-troveclient plugin.

25.54. database root show

Usage:

openstack database root show [-h] [-f {json,shell,table,value,yaml}]

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

Gets status if root was ever enabled for an instance or cluster.

Expand
Table 25.213. Positional Arguments
ValueSummary

<instance_or_cluster>

ID or name of the instance or cluster.

Expand
Table 25.214. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 25.215. Output Formatters
ValueSummary

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

the output format, defaults to table

-c COLUMN, --column COLUMN

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

Expand
Table 25.216. Table Formatter
ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

Expand
Table 25.217. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 25.218. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-troveclient plugin.

25.55. database user create

Usage:

openstack database user create [-h] [--host <host>]

                                    [--databases <databases> [<databases> ...]]
                                    <instance> <name> <password>
Copy to Clipboard Toggle word wrap

Creates a user on an instance.

Expand
Table 25.219. Positional Arguments
ValueSummary

<instance>

Id or name of the instance.

<name>

Name of user.

<password>

Password of user.

Expand
Table 25.220. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--host <host>

Optional host of user.

--databases <databases> [<databases> …​]

Optional list of databases.

This command is provided by the python-troveclient plugin.

25.56. database user delete

Usage:

openstack database user delete [-h] [--host <host>] <instance> <name>
Copy to Clipboard Toggle word wrap

Deletes a user from an instance.

Expand
Table 25.221. Positional Arguments
ValueSummary

<instance>

Id or name of the instance.

<name>

Name of user.

Expand
Table 25.222. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--host <host>

Optional host of user.

This command is provided by the python-troveclient plugin.

25.57. database user grant access

Usage:

openstack database user grant access [-h] [--host <host>]

                                          <instance> <name> <databases>
                                          [<databases> ...]
Copy to Clipboard Toggle word wrap

Grants access to a database(s) for a user.

Expand
Table 25.223. Positional Arguments
ValueSummary

<instance>

Id or name of the instance.

<name>

Name of user.

<databases>

List of databases.

Expand
Table 25.224. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--host <host>

Optional host of user.

This command is provided by the python-troveclient plugin.

25.58. database user list

Usage:

openstack database user list [-h] [-f {csv,json,table,value,yaml}]

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

Lists the users for an instance.

Expand
Table 25.225. Positional Arguments
ValueSummary

<instance>

Id or name of the instance.

Expand
Table 25.226. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 25.227. Output Formatters
ValueSummary

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

the output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
Table 25.228. Table Formatter
ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

Expand
Table 25.229. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 25.230. CSV Formatter
ValueSummary

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

when to include quotes, defaults to nonnumeric

This command is provided by the python-troveclient plugin.

25.59. database user revoke access

Usage:

openstack database user revoke access [-h] [--host <host>]

                                           <instance> <name> <databases>
Copy to Clipboard Toggle word wrap

Revokes access to a database for a user.

Expand
Table 25.231. Positional Arguments
ValueSummary

<instance>

Id or name of the instance.

<name>

Name of user.

<databases>

A single database.

Expand
Table 25.232. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--host <host>

Optional host of user.

This command is provided by the python-troveclient plugin.

25.60. database user show

Usage:

openstack database user show [-h] [-f {json,shell,table,value,yaml}]

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

Shows details of a database user of an instance.

Expand
Table 25.233. Positional Arguments
ValueSummary

<instance>

Id or name of the instance.

<name>

Name of user.

Expand
Table 25.234. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--host <host>

Optional host of user.

Expand
Table 25.235. Output Formatters
ValueSummary

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

the output format, defaults to table

-c COLUMN, --column COLUMN

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

Expand
Table 25.236. Table Formatter
ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

Expand
Table 25.237. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 25.238. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-troveclient plugin.

25.61. database user show access

Usage:

openstack database user show access [-h]

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

Shows access details of a user of an instance.

Expand
Table 25.239. Positional Arguments
ValueSummary

<instance>

Id or name of the instance.

<name>

Name of user.

Expand
Table 25.240. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--host <host>

Optional host of user.

Expand
Table 25.241. Output Formatters
ValueSummary

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

the output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

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

Expand
Table 25.242. Table Formatter
ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

Expand
Table 25.243. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 25.244. CSV Formatter
ValueSummary

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

when to include quotes, defaults to nonnumeric

This command is provided by the python-troveclient plugin.

25.62. database user update attributes

Usage:

openstack database user update attributes [-h] [--host <host>]

                                               [--new_name <new_name>]
                                               [--new_password <new_password>]
                                               [--new_host <new_host>]
                                               <instance> <name>
Copy to Clipboard Toggle word wrap

Updates a user’s attributes on an instance.At least one optional argument must be provided.

Expand
Table 25.245. Positional Arguments
ValueSummary

<instance>

Id or name of the instance.

<name>

Name of user.

Expand
Table 25.246. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--host <host>

Optional host of user.

--new_name <new_name>

Optional new name of user.

--new_password <new_password>

Optional new password of user.

--new_host <new_host>

Optional new host of user.

This command is provided by the python-troveclient plugin.

トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2025 Red Hat