From c8bffdadc228c7793cbf46e7dd0fbbc14030367f Mon Sep 17 00:00:00 2001 From: venkatamahesh Date: Fri, 4 Mar 2016 13:18:00 +0530 Subject: [PATCH] [cli-ref] Update python-troveclient to 2.1.0 Change-Id: I97382418ae96a142d4a60e71744216e83f4d8455 --- doc/cli-reference/source/trove.rst | 670 +++++++++++++++++++++-------- 1 file changed, 496 insertions(+), 174 deletions(-) diff --git a/doc/cli-reference/source/trove.rst b/doc/cli-reference/source/trove.rst index 2d96c00115..356330ae04 100644 --- a/doc/cli-reference/source/trove.rst +++ b/doc/cli-reference/source/trove.rst @@ -9,7 +9,7 @@ Database service command-line client The trove client is the command-line interface (CLI) for the Database service API and its extensions. -This chapter documents :command:`trove` version ``2.0.0``. +This chapter documents :command:`trove` version ``2.1.0``. For help on a specific :command:`trove` command, enter: @@ -47,8 +47,7 @@ trove usage [--os-region-name ] ... -Subcommands ------------ +**Subcommands:** ``backup-copy`` Creates a backup from another backup. @@ -176,6 +175,35 @@ Subcommands ``list`` Lists all the instances. +``log-disable`` + Instructs Trove guest to stop collecting log + details. + +``log-discard`` + Instructs Trove guest to discard the + container of the published log. + +``log-enable`` + Instructs Trove guest to start collecting + log details. + +``log-list`` + Lists the log files available for instance. + +``log-publish`` + Instructs Trove guest to publish latest log + entries on instance. + +``log-save`` + Save log file for instance. + +``log-show`` + Instructs Trove guest to show details of + log. + +``log-tail`` + Display log entries for instance. + ``metadata-create`` Creates metadata in the database for instance . @@ -197,6 +225,21 @@ Subcommands ``metadata-update`` Updates metadata, this is destructive. +``module-create`` + Create a module. + +``module-delete`` + Delete a module. + +``module-list`` + Lists the modules available. + +``module-show`` + Shows details of a module. + +``module-update`` + Create a module. + ``promote-to-replica-source`` Promotes a replica to be the new replica source of its set. @@ -304,7 +347,7 @@ trove optional arguments ``--endpoint-type `` Defaults to ``env[TROVE_ENDPOINT_TYPE]`` or - publicURL. + ``env[OS_ENDPOINT_TYPE]`` or publicURL. ``--os-database-api-version `` Accepts 1, defaults to @@ -404,8 +447,7 @@ trove backup-copy Creates a backup from another backup. -Positional arguments --------------------- +**Positional arguments:** ```` Name of the backup. @@ -413,8 +455,7 @@ Positional arguments ```` Backup ID of the source backup. -Optional arguments ------------------- +**Optional arguments:** ``--region `` Region where the source backup resides. @@ -434,8 +475,7 @@ trove backup-create Creates a backup of an instance. -Positional arguments --------------------- +**Positional arguments:** ```` ID or name of the instance. @@ -443,8 +483,7 @@ Positional arguments ```` Name of the backup. -Optional arguments ------------------- +**Optional arguments:** ``--description `` An optional description for the backup. @@ -464,8 +503,7 @@ trove backup-delete Deletes a backup. -Positional arguments --------------------- +**Positional arguments:** ```` ID or name of the backup. @@ -482,8 +520,7 @@ trove backup-list Lists available backups. -Optional arguments ------------------- +**Optional arguments:** ``--limit `` Return up to N number of the most recent backups. @@ -507,14 +544,12 @@ trove backup-list-instance Lists available backups for an instance. -Positional arguments --------------------- +**Positional arguments:** ```` ID or name of the instance. -Optional arguments ------------------- +**Optional arguments:** ``--limit `` Return up to N number of the most recent backups. @@ -535,8 +570,7 @@ trove backup-show Shows details of a backup. -Positional arguments --------------------- +**Positional arguments:** ```` ID of the backup. @@ -553,8 +587,7 @@ trove cluster-create Creates a new cluster. -Positional arguments --------------------- +**Positional arguments:** ```` Name of the cluster. @@ -565,8 +598,7 @@ Positional arguments ```` A datastore version name or ID. -Optional arguments ------------------- +**Optional arguments:** ``--instance ""`` Create an instance for the cluster. Specify @@ -590,8 +622,7 @@ trove cluster-delete Deletes a cluster. -Positional arguments --------------------- +**Positional arguments:** ```` ID or name of the cluster. @@ -608,14 +639,12 @@ trove cluster-grow Adds more instances to a cluster. -Positional arguments --------------------- +**Positional arguments:** ```` ID or name of the cluster. -Optional arguments ------------------- +**Optional arguments:** ``--instance `` Add an instance to the cluster. Specify @@ -632,8 +661,7 @@ trove cluster-instances Lists all instances of a cluster. -Positional arguments --------------------- +**Positional arguments:** ```` ID or name of the cluster. @@ -649,8 +677,7 @@ trove cluster-list Lists all the clusters. -Optional arguments ------------------- +**Optional arguments:** ``--limit `` Limit the number of results displayed. @@ -671,8 +698,7 @@ trove cluster-show Shows details of a cluster. -Positional arguments --------------------- +**Positional arguments:** ```` ID or name of the cluster. @@ -688,8 +714,7 @@ trove cluster-shrink Drops instances from a cluster. -Positional arguments --------------------- +**Positional arguments:** ```` ID or name of the cluster. @@ -709,8 +734,7 @@ trove configuration-attach Attaches a configuration group to an instance. -Positional arguments --------------------- +**Positional arguments:** ```` ID or name of the instance. @@ -732,8 +756,7 @@ trove configuration-create Creates a configuration group. -Positional arguments --------------------- +**Positional arguments:** ```` Name of the configuration group. @@ -741,8 +764,7 @@ Positional arguments ```` Dictionary of the values to set. -Optional arguments ------------------- +**Optional arguments:** ``--datastore `` Datastore assigned to the configuration @@ -768,8 +790,7 @@ trove configuration-default Shows the default configuration of an instance. -Positional arguments --------------------- +**Positional arguments:** ```` ID or name of the instance. @@ -785,8 +806,7 @@ trove configuration-delete Deletes a configuration group. -Positional arguments --------------------- +**Positional arguments:** ```` ID of the configuration group. @@ -802,8 +822,7 @@ trove configuration-detach Detaches a configuration group from an instance. -Positional arguments --------------------- +**Positional arguments:** ```` ID or name of the instance. @@ -819,8 +838,7 @@ trove configuration-instances Lists all instances associated with a configuration group. -Positional arguments --------------------- +**Positional arguments:** ```` ID of the configuration group. @@ -848,15 +866,13 @@ trove configuration-parameter-list Lists available parameters for a configuration group. -Positional arguments --------------------- +**Positional arguments:** ```` Datastore version name or ID assigned to the configuration group. -Optional arguments ------------------- +**Optional arguments:** ``--datastore `` ID or name of the datastore to list configuration @@ -875,8 +891,7 @@ trove configuration-parameter-show Shows details of a configuration parameter. -Positional arguments --------------------- +**Positional arguments:** ```` Datastore version name or ID assigned to the @@ -885,8 +900,7 @@ Positional arguments ```` Name of the configuration parameter. -Optional arguments ------------------- +**Optional arguments:** ``--datastore `` ID or name of the datastore to list configuration @@ -904,8 +918,7 @@ trove configuration-patch Patches a configuration group. -Positional arguments --------------------- +**Positional arguments:** ```` ID of the configuration group. @@ -924,8 +937,7 @@ trove configuration-show Shows details of a configuration group. -Positional arguments --------------------- +**Positional arguments:** ```` ID of the configuration group. @@ -943,8 +955,7 @@ trove configuration-update Updates a configuration group. -Positional arguments --------------------- +**Positional arguments:** ```` ID of the configuration group. @@ -952,8 +963,7 @@ Positional arguments ```` Dictionary of the values to set. -Optional arguments ------------------- +**Optional arguments:** ``--name `` Name of the configuration group. @@ -982,8 +992,7 @@ trove create Creates a new instance. -Positional arguments --------------------- +**Positional arguments:** ```` Name of the instance. @@ -991,8 +1000,7 @@ Positional arguments ```` Flavor ID or name of the instance. -Optional arguments ------------------- +**Optional arguments:** ``--size `` Size of the instance disk volume in GB. @@ -1058,8 +1066,7 @@ trove database-create Creates a database on an instance. -Positional arguments --------------------- +**Positional arguments:** ```` ID or name of the instance. @@ -1067,8 +1074,7 @@ Positional arguments ```` Name of the database. -Optional arguments ------------------- +**Optional arguments:** ``--character_set `` Optional character set for database. @@ -1087,8 +1093,7 @@ trove database-delete Deletes a database from an instance. -Positional arguments --------------------- +**Positional arguments:** ```` ID or name of the instance. @@ -1107,8 +1112,7 @@ trove database-list Lists available databases on an instance. -Positional arguments --------------------- +**Positional arguments:** ```` ID or name of the instance. @@ -1135,8 +1139,7 @@ trove datastore-show Shows details of a datastore. -Positional arguments --------------------- +**Positional arguments:** ```` ID of the datastore. @@ -1152,8 +1155,7 @@ trove datastore-version-list Lists available versions for a datastore. -Positional arguments --------------------- +**Positional arguments:** ```` ID or name of the datastore. @@ -1170,14 +1172,12 @@ trove datastore-version-show Shows details of a datastore version. -Positional arguments --------------------- +**Positional arguments:** ```` ID or name of the datastore version. -Optional arguments ------------------- +**Optional arguments:** ``--datastore `` ID or name of the datastore. Optional if the ID of @@ -1194,8 +1194,7 @@ trove delete Deletes an instance. -Positional arguments --------------------- +**Positional arguments:** ```` ID or name of the instance. @@ -1211,8 +1210,7 @@ trove detach-replica Detaches a replica instance from its replication source. -Positional arguments --------------------- +**Positional arguments:** ```` ID or name of the instance. @@ -1228,8 +1226,7 @@ trove eject-replica-source Ejects a replica source from its set. -Positional arguments --------------------- +**Positional arguments:** ```` ID or name of the instance. @@ -1246,8 +1243,7 @@ trove flavor-list Lists available flavors. -Optional arguments ------------------- +**Optional arguments:** ``--datastore_type `` Type of the datastore. For eg: mysql. @@ -1266,8 +1262,7 @@ trove flavor-show Shows details of a flavor. -Positional arguments --------------------- +**Positional arguments:** ```` ID or name of the flavor. @@ -1294,8 +1289,7 @@ trove list Lists all the instances. -Optional arguments ------------------- +**Optional arguments:** ``--limit `` Limit the number of results displayed. @@ -1309,6 +1303,184 @@ Optional arguments Include instances that are part of a cluster (default false). +.. _trove_log-disable: + +trove log-disable +~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: trove log-disable [--discard] + +Instructs Trove guest to stop collecting log details. + +**Positional arguments:** + +```` + Id or Name of the instance. + +```` + Name of log to publish. + +**Optional arguments:** + +``--discard`` + Discard published contents of specified log. + +.. _trove_log-discard: + +trove log-discard +~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: trove log-discard + +Instructs Trove guest to discard the container of the published log. + +**Positional arguments:** + +```` + Id or Name of the instance. + +```` + Name of log to publish. + +.. _trove_log-enable: + +trove log-enable +~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: trove log-enable + +Instructs Trove guest to start collecting log details. + +**Positional arguments:** + +```` + Id or Name of the instance. + +```` + Name of log to publish. + +.. _trove_log-list: + +trove log-list +~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: trove log-list + +Lists the log files available for instance. + +**Positional arguments:** + +```` + Id or Name of the instance. + +.. _trove_log-publish: + +trove log-publish +~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: trove log-publish [--disable] [--discard] + +Instructs Trove guest to publish latest log entries on instance. + +**Positional arguments:** + +```` + Id or Name of the instance. + +```` + Name of log to publish. + +**Optional arguments:** + +``--disable`` + Stop collection of specified log. + +``--discard`` + Discard published contents of specified log. + +.. _trove_log-save: + +trove log-save +~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: trove log-save [--publish] [--file ] + +Save log file for instance. + +**Positional arguments:** + +```` + Id or Name of the instance. + +```` + Name of log to publish. + +**Optional arguments:** + +``--publish`` + Publish latest entries from guest before display. + +``--file `` + Path of file to save log to for instance. + +.. _trove_log-show: + +trove log-show +~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: trove log-show + +Instructs Trove guest to show details of log. + +**Positional arguments:** + +```` + Id or Name of the instance. + +```` + Name of log to show. + +.. _trove_log-tail: + +trove log-tail +~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: trove log-tail [--publish] [--lines ] + +Display log entries for instance. + +**Positional arguments:** + +```` + Id or Name of the instance. + +```` + Name of log to publish. + +**Optional arguments:** + +``--publish`` + Publish latest entries from guest before display. + +``--lines `` + Publish latest entries from guest before display. + .. _trove_metadata-create: trove metadata-create @@ -1320,8 +1492,7 @@ trove metadata-create Creates metadata in the database for instance . -Positional arguments --------------------- +**Positional arguments:** ```` UUID for instance. @@ -1343,8 +1514,7 @@ trove metadata-delete Deletes metadata for instance . -Positional arguments --------------------- +**Positional arguments:** ```` UUID for instance. @@ -1363,8 +1533,7 @@ trove metadata-edit Replaces metadata value with a new one, this is non-destructive. -Positional arguments --------------------- +**Positional arguments:** ```` UUID for instance. @@ -1386,8 +1555,7 @@ trove metadata-list Shows all metadata for instance . -Positional arguments --------------------- +**Positional arguments:** ```` UUID for instance. @@ -1403,8 +1571,7 @@ trove metadata-show Shows metadata entry for key and instance . -Positional arguments --------------------- +**Positional arguments:** ```` UUID for instance. @@ -1423,8 +1590,7 @@ trove metadata-update Updates metadata, this is destructive. -Positional arguments --------------------- +**Positional arguments:** ```` UUID for instance. @@ -1438,6 +1604,192 @@ Positional arguments ```` Value to assign to . +.. _trove_module-create: + +trove module-create +~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: trove module-create + [--description ] + [--datastore ] + [--datastore_version ] [--auto_apply] + [--all_tenants] [--live_update] + +Create a module. + +**Positional arguments:** + +```` + Name of the module. + +```` + Type of the module. The type must be + supported by a corresponding module plugin on + the datastore it is applied to. + +```` + File containing data contents for the module. + +**Optional arguments:** + +``--description `` + Description of the module. + +``--datastore `` + Name or ID of datastore this module can be + applied to. If not specified, module can be + applied to all datastores. + +``--datastore_version `` + Name or ID of datastore version this module + can be applied to. If not specified, module + can be applied to all versions. + +``--auto_apply`` + Automatically apply this module when creating + an instance or cluster. + +``--all_tenants`` + Module is valid for all tenants (Admin only). + +``--live_update`` + Allow module to be updated even if it is + already applied to a current instance or + cluster. Automatically attempt to reapply + this module if the contents change. + +.. _trove_module-delete: + +trove module-delete +~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: trove module-delete + +Delete a module. + +**Positional arguments:** + +```` + ID or name of the module. + +.. _trove_module-list: + +trove module-list +~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: trove module-list [--datastore ] + +Lists the modules available. + +**Optional arguments:** + +``--datastore `` + Name or ID of datastore to list modules for. + +.. _trove_module-show: + +trove module-show +~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: trove module-show + +Shows details of a module. + +**Positional arguments:** + +```` + ID or name of the module. + +.. _trove_module-update: + +trove module-update +~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: trove module-update + [--name ] [--type ] [--file ] + [--description ] + [--datastore ] [--all_datastores] + [--datastore_version ] + [--all_datastore_versions] [--auto_apply] + [--no_auto_apply] [--all_tenants] + [--no_all_tenants] [--live_update] + [--no_live_update] + +Create a module. + +**Positional arguments:** + +```` + Name or ID of the module. + +**Optional arguments:** + +``--name `` + Name of the module. + +``--type `` + Type of the module. The type must be + supported by a corresponding module plugin on + the datastore it is applied to. + +``--file `` + File containing data contents for the module. + +``--description `` + Description of the module. + +``--datastore `` + Name or ID of datastore this module can be + applied to. If not specified, module can be + applied to all datastores. + +``--all_datastores`` + Module is valid for all datastores. + +``--datastore_version `` + Name or ID of datastore version this module + can be applied to. If not specified, module + can be applied to all versions. + +``--all_datastore_versions`` + Module is valid for all datastore version. + +``--auto_apply`` + Automatically apply this module when creating + an instance or cluster. + +``--no_auto_apply`` + Do not automatically apply this module when + creating an instance or cluster. + +``--all_tenants`` + Module is valid for all tenants (Admin only). + +``--no_all_tenants`` + Module is valid for current tenant only + (Admin only). + +``--live_update`` + Allow module to be updated or deleted even if + it is already applied to a current instance + or cluster. Automatically attempt to reapply + this module if the contents change. + +``--no_live_update`` + Restricts a module from being updated or + deleted if it is already applied to a current + instance or cluster. + .. _trove_promote-to-replica-source: trove promote-to-replica-source @@ -1449,8 +1801,7 @@ trove promote-to-replica-source Promotes a replica to be the new replica source of its set. -Positional arguments --------------------- +**Positional arguments:** ```` ID or name of the instance. @@ -1466,8 +1817,7 @@ trove resize-instance Resizes an instance with a new flavor. -Positional arguments --------------------- +**Positional arguments:** ```` ID or name of the instance. @@ -1486,8 +1836,7 @@ trove resize-volume Resizes the volume size of an instance. -Positional arguments --------------------- +**Positional arguments:** ```` ID or name of the instance. @@ -1506,8 +1855,7 @@ trove restart Restarts an instance. -Positional arguments --------------------- +**Positional arguments:** ```` ID or name of the instance. @@ -1523,8 +1871,7 @@ trove root-disable Disables root for an instance. -Positional arguments --------------------- +**Positional arguments:** ```` ID or name of the instance. @@ -1541,14 +1888,12 @@ trove root-enable Enables root for an instance and resets if already exists. -Positional arguments --------------------- +**Positional arguments:** ```` ID or name of the instance or cluster. -Optional arguments ------------------- +**Optional arguments:** ``--root_password `` Root password to set. @@ -1564,8 +1909,7 @@ trove root-show Gets status if root was ever enabled for an instance or cluster. -Positional arguments --------------------- +**Positional arguments:** ```` ID or name of the instance or cluster. @@ -1581,8 +1925,7 @@ trove secgroup-add-rule Creates a security group rule. -Positional arguments --------------------- +**Positional arguments:** ```` Security group ID. @@ -1601,8 +1944,7 @@ trove secgroup-delete-rule Deletes a security group rule. -Positional arguments --------------------- +**Positional arguments:** ```` Name of security group rule. @@ -1629,8 +1971,7 @@ trove secgroup-list-rules Lists all rules for a security group. -Positional arguments --------------------- +**Positional arguments:** ```` Security group ID. @@ -1646,8 +1987,7 @@ trove secgroup-show Shows details of a security group. -Positional arguments --------------------- +**Positional arguments:** ```` Security group ID. @@ -1663,8 +2003,7 @@ trove show Shows details of an instance. -Positional arguments --------------------- +**Positional arguments:** ```` ID or name of the instance. @@ -1682,14 +2021,12 @@ trove update Updates an instance: Edits name, configuration, or replica source. -Positional arguments --------------------- +**Positional arguments:** ```` ID or name of the instance. -Optional arguments ------------------- +**Optional arguments:** ``--name `` Name of the instance. @@ -1717,8 +2054,7 @@ trove user-create Creates a user on an instance. -Positional arguments --------------------- +**Positional arguments:** ```` ID or name of the instance. @@ -1729,8 +2065,7 @@ Positional arguments ```` Password of user. -Optional arguments ------------------- +**Optional arguments:** ``--host `` Optional host of user. @@ -1749,8 +2084,7 @@ trove user-delete Deletes a user from an instance. -Positional arguments --------------------- +**Positional arguments:** ```` ID or name of the instance. @@ -1758,8 +2092,7 @@ Positional arguments ```` Name of user. -Optional arguments ------------------- +**Optional arguments:** ``--host `` Optional host of user. @@ -1776,8 +2109,7 @@ trove user-grant-access Grants access to a database(s) for a user. -Positional arguments --------------------- +**Positional arguments:** ```` ID or name of the instance. @@ -1788,8 +2120,7 @@ Positional arguments ```` List of databases. -Optional arguments ------------------- +**Optional arguments:** ``--host `` Optional host of user. @@ -1805,8 +2136,7 @@ trove user-list Lists the users for an instance. -Positional arguments --------------------- +**Positional arguments:** ```` ID or name of the instance. @@ -1822,8 +2152,7 @@ trove user-revoke-access Revokes access to a database for a user. -Positional arguments --------------------- +**Positional arguments:** ```` ID or name of the instance. @@ -1834,8 +2163,7 @@ Positional arguments ```` A single database. -Optional arguments ------------------- +**Optional arguments:** ``--host `` Optional host of user. @@ -1851,8 +2179,7 @@ trove user-show Shows details of a user of an instance. -Positional arguments --------------------- +**Positional arguments:** ```` ID or name of the instance. @@ -1860,8 +2187,7 @@ Positional arguments ```` Name of user. -Optional arguments ------------------- +**Optional arguments:** ``--host `` Optional host of user. @@ -1877,8 +2203,7 @@ trove user-show-access Shows access details of a user of an instance. -Positional arguments --------------------- +**Positional arguments:** ```` ID or name of the instance. @@ -1886,8 +2211,7 @@ Positional arguments ```` Name of user. -Optional arguments ------------------- +**Optional arguments:** ``--host `` Optional host of user. @@ -1907,8 +2231,7 @@ trove user-update-attributes Updates a user's attributes on an instance. At least one optional argument must be provided. -Positional arguments --------------------- +**Positional arguments:** ```` ID or name of the instance. @@ -1916,8 +2239,7 @@ Positional arguments ```` Name of user. -Optional arguments ------------------- +**Optional arguments:** ``--host `` Optional host of user.