diff --git a/README.rst b/README.rst index b407d21f..3a35209f 100644 --- a/README.rst +++ b/README.rst @@ -16,11 +16,11 @@ This is a client for the OpenStack Trove API. There's a Python API (the ``troveclient`` module), and a command-line script (``trove``). Each implements 100% of the OpenStack Trove API. -See the `OpenStack CLI Guide`_ for information on how to use the ``trove`` +See the `Trove CLI Guide`_ for information on how to use the ``trove`` command-line tool. You may also want to look at the `OpenStack API documentation`_. -.. _OpenStack CLI Guide: http://docs.openstack.org/user-guide/cli.html +.. _Trove CLI Guide: http://docs.openstack.org/trove/latest/cli .. _OpenStack API documentation: http://docs.openstack.org/api/quick-start/content/ python-troveclient is licensed under the Apache License like the rest of OpenStack. diff --git a/doc/source/cli/index.rst b/doc/source/cli/index.rst new file mode 100644 index 00000000..a407afd4 --- /dev/null +++ b/doc/source/cli/index.rst @@ -0,0 +1,3 @@ +.. toctree:: + + trove.rst diff --git a/doc/source/cli/trove.rst b/doc/source/cli/trove.rst new file mode 100644 index 00000000..84c52a5f --- /dev/null +++ b/doc/source/cli/trove.rst @@ -0,0 +1,2924 @@ +.. ################################################### +.. ## WARNING ###################################### +.. ############## WARNING ########################## +.. ########################## WARNING ############## +.. ###################################### WARNING ## +.. ################################################### +.. ################################################### +.. ## +.. This file is tool-generated. Do not edit manually. +.. http://docs.openstack.org/contributor-guide/ +.. doc-tools/cli-reference.html +.. ## +.. ## WARNING ###################################### +.. ############## WARNING ########################## +.. ########################## WARNING ############## +.. ###################################### WARNING ## +.. ################################################### + +============================================ +Database service (trove) command-line client +============================================ + +The trove client is the command-line interface (CLI) for +the Database service (trove) API and its extensions. + +This chapter documents :command:`trove` version ``2.10.0``. + +For help on a specific :command:`trove` command, enter: + +.. code-block:: console + + $ trove help COMMAND + +.. _trove_command_usage: + +trove usage +~~~~~~~~~~~ + +.. code-block:: console + + usage: trove [--version] [--debug] [--service-type ] + [--service-name ] [--bypass-url ] + [--database-service-name ] + [--endpoint-type ] + [--os-database-api-version ] + [--retries ] [--json] [--profile HMAC_KEY] [--insecure] + [--os-cacert ] [--os-cert ] + [--os-key ] [--timeout ] [--os-auth-type ] + [--os-auth-url OS_AUTH_URL] [--os-domain-id OS_DOMAIN_ID] + [--os-domain-name OS_DOMAIN_NAME] [--os-project-id OS_PROJECT_ID] + [--os-project-name OS_PROJECT_NAME] + [--os-project-domain-id OS_PROJECT_DOMAIN_ID] + [--os-project-domain-name OS_PROJECT_DOMAIN_NAME] + [--os-trust-id OS_TRUST_ID] + [--os-default-domain-id OS_DEFAULT_DOMAIN_ID] + [--os-default-domain-name OS_DEFAULT_DOMAIN_NAME] + [--os-user-id OS_USER_ID] [--os-username OS_USERNAME] + [--os-user-domain-id OS_USER_DOMAIN_ID] + [--os-user-domain-name OS_USER_DOMAIN_NAME] + [--os-password OS_PASSWORD] [--os-region-name ] + ... + +**Subcommands:** + +``backup-copy`` + Creates a backup from another backup. + +``backup-create`` + Creates a backup of an instance. + +``backup-delete`` + Deletes a backup. + +``backup-list`` + Lists available backups. + +``backup-list-instance`` + Lists available backups for an instance. + +``backup-show`` + Shows details of a backup. + +``cluster-create`` + Creates a new cluster. + +``cluster-delete`` + Deletes a cluster. + +``cluster-force-delete`` + Force delete a cluster + +``cluster-grow`` + Adds more instances to a cluster. + +``cluster-instances`` + Lists all instances of a cluster. + +``cluster-list`` + Lists all the clusters. + +``cluster-modules`` + Lists all modules for each instance of a + cluster. + +``cluster-reset-status`` + Set the cluster task to NONE. + +``cluster-show`` + Shows details of a cluster. + +``cluster-shrink`` + Drops instances from a cluster. + +``cluster-upgrade`` + Upgrades a cluster to a new datastore + version. + +``configuration-attach`` + Attaches a configuration group to an + instance. + +``configuration-create`` + Creates a configuration group. + +``configuration-default`` + Shows the default configuration of an + instance. + +``configuration-delete`` + Deletes a configuration group. + +``configuration-detach`` + Detaches a configuration group from an + instance. + +``configuration-instances`` + Lists all instances associated with a + configuration group. + +``configuration-list`` + Lists all configuration groups. + +``configuration-parameter-list`` + Lists available parameters for a + configuration group. + +``configuration-parameter-show`` + Shows details of a configuration parameter. + +``configuration-patch`` + Patches a configuration group. + +``configuration-show`` + Shows details of a configuration group. + +``configuration-update`` + Updates a configuration group. + +``create`` + Creates a new instance. + +``database-create`` + Creates a database on an instance. + +``database-delete`` + Deletes a database from an instance. + +``database-list`` + Lists available databases on an instance. + +``datastore-list`` + Lists available datastores. + +``datastore-show`` + Shows details of a datastore. + +``datastore-version-list`` + Lists available versions for a datastore. + +``datastore-version-show`` + Shows details of a datastore version. + +``delete`` + Deletes an instance. + +``detach-replica`` + Detaches a replica instance from its + replication source. + +``eject-replica-source`` + Ejects a replica source from its set. + +``execution-delete`` + Deletes an execution. + +``execution-list`` + Lists executions of a scheduled backup of an + instance. + +``flavor-list`` + Lists available flavors. + +``flavor-show`` + Shows details of a flavor. + +``force-delete`` + Force delete an instance. + +``limit-list`` + Lists the limits for a tenant. + +``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 . + +``metadata-delete`` + Deletes metadata for instance . + +``metadata-edit`` + Replaces metadata value with a new one, this + is non-destructive. + +``metadata-list`` + Shows all metadata for instance . + +``metadata-show`` + Shows metadata entry for key and + instance . + +``metadata-update`` + Updates metadata, this is destructive. + +``module-apply`` + Apply modules to an instance. + +``module-create`` + Create a module. + +``module-delete`` + Delete a module. + +``module-instance-count`` + Lists a count of the instances for each + module md5. + +``module-instances`` + Lists the instances that have a particular + module applied. + +``module-list`` + Lists the modules available. + +``module-list-instance`` + Lists the modules that have been applied to + an instance. + +``module-query`` + Query the status of the modules on an + instance. + +``module-reapply`` + Reapply a module. + +``module-remove`` + Remove a module from an instance. + +``module-retrieve`` + Retrieve module contents from an instance. + +``module-show`` + Shows details of a module. + +``module-update`` + Update a module. + +``promote-to-replica-source`` + Promotes a replica to be the new replica + source of its set. + +``quota-show`` + Show quotas for a tenant. + +``quota-update`` + Update quotas for a tenant. + +``reset-status`` + Set the status to NONE. + +``resize-instance`` + Resizes an instance with a new flavor. + +``resize-volume`` + Resizes the volume size of an instance. + +``restart`` + Restarts an instance. + +``root-disable`` + Disables root for an instance. + +``root-enable`` + Enables root for an instance and resets if + already exists. + +``root-show`` + Gets status if root was ever enabled for an + instance or cluster. + +``schedule-create`` + Schedules backups for an instance. + +``schedule-delete`` + Deletes a schedule. + +``schedule-list`` + Lists scheduled backups for an instance. + +``schedule-show`` + Shows details of a schedule. + +``secgroup-add-rule`` + Creates a security group rule. + +``secgroup-delete-rule`` + Deletes a security group rule. + +``secgroup-list`` + Lists all security groups. + +``secgroup-list-rules`` + Lists all rules for a security group. + +``secgroup-show`` + Shows details of a security group. + +``show`` + Shows details of an instance. + +``update`` + Updates an instance: Edits name, + configuration, or replica source. + +``upgrade`` + Upgrades an instance to a new datastore + version. + +``user-create`` + Creates a user on an instance. + +``user-delete`` + Deletes a user from an instance. + +``user-grant-access`` + Grants access to a database(s) for a user. + +``user-list`` + Lists the users for an instance. + +``user-revoke-access`` + Revokes access to a database for a user. + +``user-show`` + Shows details of a user of an instance. + +``user-show-access`` + Shows access details of a user of an + instance. + +``user-update-attributes`` + Updates a user's attributes on an instance. + +``volume-type-list`` + Lists available volume types. + +``volume-type-show`` + Shows details of a volume type. + +``bash-completion`` + Prints arguments for bash_completion. + +``help`` + Displays help about this program or one of + its subcommands. + +.. _trove_command_options: + +trove optional arguments +~~~~~~~~~~~~~~~~~~~~~~~~ + +``--version`` + Show program's version number and exit. + +``--debug`` + Print debugging output. + +``--service-type `` + Defaults to database for most actions. + +``--service-name `` + Defaults to ``env[TROVE_SERVICE_NAME]``. + +``--bypass-url `` + Defaults to ``env[TROVE_BYPASS_URL]``. + +``--database-service-name `` + Defaults to + ``env[TROVE_DATABASE_SERVICE_NAME]``. + +``--endpoint-type `` + Defaults to ``env[TROVE_ENDPOINT_TYPE]`` or + ``env[OS_ENDPOINT_TYPE]`` or publicURL. + +``--os-database-api-version `` + Accepts 1, defaults to + ``env[OS_DATABASE_API_VERSION]``. + +``--retries `` + Number of retries. + +``--json, --os-json-output`` + Output JSON instead of prettyprint. Defaults + to ``env[OS_JSON_OUTPUT]``. + +``--profile HMAC_KEY`` + HMAC key used to encrypt context data when + profiling the performance of an operation. + This key should be set to one of the HMAC + keys configured in Trove (they are found in + api-paste.ini, typically in /etc/trove). + Without the key, profiling will not be + triggered even if it is enabled on the + server side. Defaults to + ``env[OS_PROFILE_HMACKEY]``. + +``--os-auth-type , --os-auth-plugin `` + Authentication type to use + +``--os-region-name `` + Specify the region to use. Defaults to + ``env[OS_REGION_NAME]``. + +.. _trove_backup-copy: + +trove backup-copy +----------------- + +.. code-block:: console + + usage: trove backup-copy [--description ] + +Creates a backup from another backup. + +**Positional arguments:** + +```` + Name of the backup. + +```` + Backup ID of the source backup. + +**Optional arguments:** + +``--description `` + An optional description for the backup. + +.. _trove_backup-create: + +trove backup-create +------------------- + +.. code-block:: console + + usage: trove backup-create + [--description ] [--parent ] + [--incremental] + +Creates a backup of an instance. + +**Positional arguments:** + +```` + ID or name of the instance. + +```` + Name of the backup. + +**Optional arguments:** + +``--description `` + An optional description for the backup. + +``--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. + +.. _trove_backup-delete: + +trove backup-delete +------------------- + +.. code-block:: console + + usage: trove backup-delete + +Deletes a backup. + +**Positional arguments:** + +```` + ID or name of the backup. + +.. _trove_backup-list: + +trove backup-list +----------------- + +.. code-block:: console + + usage: trove backup-list [--limit ] [--marker ] + [--datastore ] + +Lists available backups. + +**Optional arguments:** + +``--limit `` + Return up to N number of the most recent backups. + +``--marker `` + 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. + +``--datastore `` + ID or name of the datastore (to filter backups by). + +.. _trove_backup-list-instance: + +trove backup-list-instance +-------------------------- + +.. code-block:: console + + usage: trove backup-list-instance [--limit ] [--marker ] + +Lists available backups for an instance. + +**Positional arguments:** + +```` + ID or name of the instance. + +**Optional arguments:** + +``--limit `` + Return up to N number of the most recent backups. + +``--marker `` + 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. + +.. _trove_backup-show: + +trove backup-show +----------------- + +.. code-block:: console + + usage: trove backup-show + +Shows details of a backup. + +**Positional arguments:** + +```` + ID or name of the backup. + +.. _trove_cluster-create: + +trove cluster-create +-------------------- + +.. code-block:: console + + usage: trove cluster-create + [--instance "opt=[,opt= ...] "] + [--locality ] + +Creates a new cluster. + +**Positional arguments:** + +```` + Name of the cluster. + +```` + A datastore name or ID. + +```` + A datastore version name or ID. + +**Optional arguments:** + +``--instance "opt=[,opt= ...] "`` + Add an instance to the cluster. Specify + multiple times to create multiple instances. + Valid options are: + flavor=, + volume=, + volume_type=, nic=', + v4-fixed-ip=, port-id=>' + (where net-id=network_id, v4-fixed-ip=IPv4r_fixed_address, port-id=port_id), + availability_zone=, + module=, + type=. + +``--locality `` + Locality policy to use when creating + cluster. Choose one of affinity, anti-affinity. + +.. _trove_cluster-delete: + +trove cluster-delete +-------------------- + +.. code-block:: console + + usage: trove cluster-delete + +Deletes a cluster. + +**Positional arguments:** + +```` + ID or name of the cluster. + +.. _trove_cluster-force-delete: + +trove cluster-force-delete +-------------------------- + +.. code-block:: console + + usage: trove cluster-force-delete + +Force delete a cluster + +**Positional arguments:** + +```` + ID or name of the cluster. + +.. _trove_cluster-grow: + +trove cluster-grow +------------------ + +.. code-block:: console + + usage: trove cluster-grow + [--instance "opt=[,opt= ...] "] + +Adds more instances to a cluster. + +**Positional arguments:** + +```` + ID or name of the cluster. + +**Optional arguments:** + +``--instance "opt=[,opt= ...] "`` + Add an instance to the cluster. Specify + multiple times to create multiple instances. + Valid options are: + flavor=, + volume=, + volume_type=, nic=', + v4-fixed-ip=, port-id=>' + (where net-id=network_id, v4-fixed-ip=IPv4r_fixed_address, port-id=port_id), + availability_zone=, + module=, + type=. + +.. _trove_cluster-instances: + +trove cluster-instances +----------------------- + +.. code-block:: console + + usage: trove cluster-instances + +Lists all instances of a cluster. + +**Positional arguments:** + +```` + ID or name of the cluster. + +.. _trove_cluster-list: + +trove cluster-list +------------------ + +.. code-block:: console + + usage: trove cluster-list [--limit ] [--marker ] + +Lists all the clusters. + +**Optional arguments:** + +``--limit `` + Limit the number of results displayed. + +``--marker `` + 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. + +.. _trove_cluster-modules: + +trove cluster-modules +--------------------- + +.. code-block:: console + + usage: trove cluster-modules + +Lists all modules for each instance of a cluster. + +**Positional arguments:** + +```` + ID or name of the cluster. + +.. _trove_cluster-reset-status: + +trove cluster-reset-status +-------------------------- + +.. code-block:: console + + usage: trove cluster-reset-status + +Set the cluster task to NONE. + +**Positional arguments:** + +```` + ID or name of the cluster. + +.. _trove_cluster-show: + +trove cluster-show +------------------ + +.. code-block:: console + + usage: trove cluster-show + +Shows details of a cluster. + +**Positional arguments:** + +```` + ID or name of the cluster. + +.. _trove_cluster-shrink: + +trove cluster-shrink +-------------------- + +.. code-block:: console + + usage: trove cluster-shrink [ ...] + +Drops instances from a cluster. + +**Positional arguments:** + +```` + ID or name of the cluster. + +```` + Drop instance(s) from the cluster. Specify multiple ids to drop + multiple instances. + +.. _trove_cluster-upgrade: + +trove cluster-upgrade +--------------------- + +.. code-block:: console + + usage: trove cluster-upgrade + +Upgrades a cluster to a new datastore version. + +**Positional arguments:** + +```` + ID or name of the cluster. + +```` + A datastore version name or ID. + +.. _trove_configuration-attach: + +trove configuration-attach +-------------------------- + +.. code-block:: console + + usage: trove configuration-attach + +Attaches a configuration group to an instance. + +**Positional arguments:** + +```` + ID or name of the instance. + +```` + ID or name of the configuration group to attach to the + instance. + +.. _trove_configuration-create: + +trove configuration-create +-------------------------- + +.. code-block:: console + + usage: trove configuration-create + [--datastore ] + [--datastore_version ] + [--description ] + +Creates a configuration group. + +**Positional arguments:** + +```` + Name of the configuration group. + +```` + Dictionary of the values to set. + +**Optional arguments:** + +``--datastore `` + Datastore assigned to the configuration + group. Required if default datastore is not + configured. + +``--datastore_version `` + Datastore version ID assigned to the + configuration group. + +``--description `` + An optional description for the + configuration group. + +.. _trove_configuration-default: + +trove configuration-default +--------------------------- + +.. code-block:: console + + usage: trove configuration-default + +Shows the default configuration of an instance. + +**Positional arguments:** + +```` + ID or name of the instance. + +.. _trove_configuration-delete: + +trove configuration-delete +-------------------------- + +.. code-block:: console + + usage: trove configuration-delete + +Deletes a configuration group. + +**Positional arguments:** + +```` + ID or name of the configuration group. + +.. _trove_configuration-detach: + +trove configuration-detach +-------------------------- + +.. code-block:: console + + usage: trove configuration-detach + +Detaches a configuration group from an instance. + +**Positional arguments:** + +```` + ID or name of the instance. + +.. _trove_configuration-instances: + +trove configuration-instances +----------------------------- + +.. code-block:: console + + usage: trove configuration-instances + [--limit ] [--marker ] + +Lists all instances associated with a configuration group. + +**Positional arguments:** + +```` + ID or name of the configuration group. + +**Optional arguments:** + +``--limit `` + Limit the number of results displayed. + +``--marker `` + 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. + +.. _trove_configuration-list: + +trove configuration-list +------------------------ + +.. code-block:: console + + usage: trove configuration-list [--limit ] [--marker ] + +Lists all configuration groups. + +**Optional arguments:** + +``--limit `` + Limit the number of results displayed. + +``--marker `` + 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. + +.. _trove_configuration-parameter-list: + +trove configuration-parameter-list +---------------------------------- + +.. code-block:: console + + usage: trove configuration-parameter-list + [--datastore ] + +Lists available parameters for a configuration group. + +**Positional arguments:** + +```` + Datastore version name or ID assigned to the + configuration group. + +**Optional arguments:** + +``--datastore `` + ID or name of the datastore to list configuration + parameters for. Optional if the ID of the + datastore_version is provided. + +.. _trove_configuration-parameter-show: + +trove configuration-parameter-show +---------------------------------- + +.. code-block:: console + + usage: trove configuration-parameter-show + [--datastore ] + +Shows details of a configuration parameter. + +**Positional arguments:** + +```` + Datastore version name or ID assigned to the + configuration group. + +```` + Name of the configuration parameter. + +**Optional arguments:** + +``--datastore `` + ID or name of the datastore to list configuration + parameters for. Optional if the ID of the + datastore_version is provided. + +.. _trove_configuration-patch: + +trove configuration-patch +------------------------- + +.. code-block:: console + + usage: trove configuration-patch + +Patches a configuration group. + +**Positional arguments:** + +```` + ID or name of the configuration group. + +```` + Dictionary of the values to set. + +.. _trove_configuration-show: + +trove configuration-show +------------------------ + +.. code-block:: console + + usage: trove configuration-show + +Shows details of a configuration group. + +**Positional arguments:** + +```` + ID or name of the configuration group. + +.. _trove_configuration-update: + +trove configuration-update +-------------------------- + +.. code-block:: console + + usage: trove configuration-update + [--name ] + [--description ] + +Updates a configuration group. + +**Positional arguments:** + +```` + ID or name of the configuration group. + +```` + Dictionary of the values to set. + +**Optional arguments:** + +``--name `` + Name of the configuration group. + +``--description `` + An optional description for the configuration + group. + +.. _trove_create: + +trove create +------------ + +.. code-block:: console + + usage: trove create + [--size ] [--volume_type ] + [--databases [ ...]] + [--users [ ...]] + [--backup ] + [--availability_zone ] + [--datastore ] + [--datastore_version ] + [--nic ,v4-fixed-ip=,port-id=>] + [--configuration ] + [--replica_of ] [--replica_count ] + [--module ] [--locality ] + +Creates a new instance. + +**Positional arguments:** + +```` + Name of the instance. + +```` + A flavor name or ID. + +**Optional arguments:** + +``--size `` + Size of the instance disk volume in GB. + Required when volume support is enabled. + +``--volume_type `` + Volume type. Optional when volume support is + enabled. + +``--databases [ ...]`` + Optional list of databases. + +``--users [ ...]`` + Optional list of users. + +``--backup `` + A backup name or ID. + +``--availability_zone `` + The Zone hint to give to Nova. + +``--datastore `` + A datastore name or ID. + +``--datastore_version `` + A datastore version name or ID. + +``--nic ,v4-fixed-ip=,port-id=>`` + 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 `` + ID of the configuration group to attach to + the instance. + +``--replica_of `` + ID or name of an existing instance to + replicate from. + +``--replica_count `` + Number of replicas to create (defaults to 1 + if replica_of specified). + +``--module `` + ID or name of the module to apply. Specify + multiple times to apply multiple modules. + +``--locality `` + Locality policy to use when creating + replicas. Choose one of affinity, anti-affinity. + +.. _trove_database-create: + +trove database-create +--------------------- + +.. code-block:: console + + usage: trove database-create + [--character_set ] + [--collate ] + +Creates a database on an instance. + +**Positional arguments:** + +```` + ID or name of the instance. + +```` + Name of the database. + +**Optional arguments:** + +``--character_set `` + Optional character set for database. + +``--collate `` + Optional collation type for database. + +.. _trove_database-delete: + +trove database-delete +--------------------- + +.. code-block:: console + + usage: trove database-delete + +Deletes a database from an instance. + +**Positional arguments:** + +```` + ID or name of the instance. + +```` + Name of the database. + +.. _trove_database-list: + +trove database-list +------------------- + +.. code-block:: console + + usage: trove database-list + +Lists available databases on an instance. + +**Positional arguments:** + +```` + ID or name of the instance. + +.. _trove_datastore-list: + +trove datastore-list +-------------------- + +.. code-block:: console + + usage: trove datastore-list + +Lists available datastores. + +.. _trove_datastore-show: + +trove datastore-show +-------------------- + +.. code-block:: console + + usage: trove datastore-show + +Shows details of a datastore. + +**Positional arguments:** + +```` + ID of the datastore. + +.. _trove_datastore-version-list: + +trove datastore-version-list +---------------------------- + +.. code-block:: console + + usage: trove datastore-version-list + +Lists available versions for a datastore. + +**Positional arguments:** + +```` + ID or name of the datastore. + +.. _trove_datastore-version-show: + +trove datastore-version-show +---------------------------- + +.. code-block:: console + + usage: trove datastore-version-show + [--datastore ] + +Shows details of a datastore version. + +**Positional arguments:** + +```` + ID or name of the datastore version. + +**Optional arguments:** + +``--datastore `` + ID or name of the datastore. Optional if the ID of + the datastore_version is provided. + +.. _trove_delete: + +trove delete +------------ + +.. code-block:: console + + usage: trove delete + +Deletes an instance. + +**Positional arguments:** + +```` + ID or name of the instance. + +.. _trove_detach-replica: + +trove detach-replica +-------------------- + +.. code-block:: console + + usage: trove detach-replica + +Detaches a replica instance from its replication source. + +**Positional arguments:** + +```` + ID or name of the instance. + +.. _trove_eject-replica-source: + +trove eject-replica-source +-------------------------- + +.. code-block:: console + + usage: trove eject-replica-source + +Ejects a replica source from its set. + +**Positional arguments:** + +```` + ID or name of the instance. + +.. _trove_execution-delete: + +trove execution-delete +---------------------- + +.. code-block:: console + + usage: trove execution-delete + +Deletes an execution. + +**Positional arguments:** + +```` + Id of the execution to delete. + +.. _trove_execution-list: + +trove execution-list +-------------------- + +.. code-block:: console + + usage: trove execution-list [--limit ] [--marker ] + +Lists executions of a scheduled backup of an instance. + +**Positional arguments:** + +```` + Id of the schedule. + +**Optional arguments:** + +``--limit `` + Return up to N number of the most recent executions. + +``--marker `` + 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. + +.. _trove_flavor-list: + +trove flavor-list +----------------- + +.. code-block:: console + + usage: trove flavor-list [--datastore_type ] + [--datastore_version_id ] + +Lists available flavors. + +**Optional arguments:** + +``--datastore_type `` + Type of the datastore. For eg: mysql. + +``--datastore_version_id `` + ID of the datastore version. + +.. _trove_flavor-show: + +trove flavor-show +----------------- + +.. code-block:: console + + usage: trove flavor-show + +Shows details of a flavor. + +**Positional arguments:** + +```` + ID or name of the flavor. + +.. _trove_force-delete: + +trove force-delete +------------------ + +.. code-block:: console + + usage: trove force-delete + +Force delete an instance. + +**Positional arguments:** + +```` + ID or name of the instance. + +.. _trove_limit-list: + +trove limit-list +---------------- + +.. code-block:: console + + usage: trove limit-list + +Lists the limits for a tenant. + +.. _trove_list: + +trove list +---------- + +.. code-block:: console + + usage: trove list [--limit ] [--marker ] [--include_clustered] + +Lists all the instances. + +**Optional arguments:** + +``--limit `` + Limit the number of results displayed. + +``--marker `` + 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. + +``--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. + +.. _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 +--------------------- + +.. code-block:: console + + usage: trove metadata-create + +Creates metadata in the database for instance . + +**Positional arguments:** + +```` + UUID for instance. + +```` + Key for assignment. + +```` + Value to assign to . + +.. _trove_metadata-delete: + +trove metadata-delete +--------------------- + +.. code-block:: console + + usage: trove metadata-delete + +Deletes metadata for instance . + +**Positional arguments:** + +```` + UUID for instance. + +```` + Metadata key to delete. + +.. _trove_metadata-edit: + +trove metadata-edit +------------------- + +.. code-block:: console + + usage: trove metadata-edit + +Replaces metadata value with a new one, this is non-destructive. + +**Positional arguments:** + +```` + UUID for instance. + +```` + Key to replace. + +```` + New value to assign to . + +.. _trove_metadata-list: + +trove metadata-list +------------------- + +.. code-block:: console + + usage: trove metadata-list + +Shows all metadata for instance . + +**Positional arguments:** + +```` + UUID for instance. + +.. _trove_metadata-show: + +trove metadata-show +------------------- + +.. code-block:: console + + usage: trove metadata-show + +Shows metadata entry for key and instance . + +**Positional arguments:** + +```` + UUID for instance. + +```` + Key to display. + +.. _trove_metadata-update: + +trove metadata-update +--------------------- + +.. code-block:: console + + usage: trove metadata-update + +Updates metadata, this is destructive. + +**Positional arguments:** + +```` + UUID for instance. + +```` + Key to update. + +```` + New key. + +```` + Value to assign to . + +.. _trove_module-apply: + +trove module-apply +------------------ + +.. code-block:: console + + usage: trove module-apply [ ...] + +Apply modules to an instance. + +**Positional arguments:** + +```` + ID or name of the instance. + +```` + ID or name of the module. + +.. _trove_module-create: + +trove module-create +------------------- + +.. code-block:: console + + usage: trove module-create + [--description ] + [--datastore ] + [--datastore_version ] [--auto_apply] + [--all_tenants] [--hidden] [--live_update] + [--priority_apply] + [--apply_order {0,1,2,3,4,5,6,7,8,9}] + [--full_access] + +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. Admin only. + +``--all_tenants`` + Module is valid for all tenants. Admin only. + +``--hidden`` + Hide this module from non-Admin. Useful in + creating auto-apply modules without + cluttering up module lists. Admin only. + +``--live_update`` + Allow module to be updated even if it is + already applied to a current instance or + cluster. + +``--priority_apply`` + Sets a priority for applying the module. All + priority modules will be applied before non-priority ones. Admin only. + +``--apply_order {0,1,2,3,4,5,6,7,8,9}`` + Sets an order for applying the module. + Modules with a lower value will be applied + before modules with a higher value. Modules + having the same value may be applied in any + order (default 5). + +``--full_access`` + Marks a module as 'non-admin', unless an + admin-only option was specified. Admin only. + +.. _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-instance-count: + +trove module-instance-count +--------------------------- + +.. code-block:: console + + usage: trove module-instance-count [--include_clustered] + +Lists a count of the instances for each module md5. + +**Positional arguments:** + +```` + ID or name of the module. + +**Optional arguments:** + +``--include_clustered`` + Include instances that are part of a cluster (default + False). + +.. _trove_module-instances: + +trove module-instances +---------------------- + +.. code-block:: console + + usage: trove module-instances + [--include_clustered] [--limit ] + [--marker ] + +Lists the instances that have a particular module applied. + +**Positional arguments:** + +```` + ID or name of the module. + +**Optional arguments:** + +``--include_clustered`` + Include instances that are part of a cluster (default + False). + +``--limit `` + Return up to N number of the most recent results. + +``--marker `` + 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. + +.. _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. Use + 'all' to list modules that apply to all datastores. + +.. _trove_module-list-instance: + +trove module-list-instance +-------------------------- + +.. code-block:: console + + usage: trove module-list-instance + +Lists the modules that have been applied to an instance. + +**Positional arguments:** + +```` + ID or name of the instance. + +.. _trove_module-query: + +trove module-query +------------------ + +.. code-block:: console + + usage: trove module-query + +Query the status of the modules on an instance. + +**Positional arguments:** + +```` + ID or name of the instance. + +.. _trove_module-reapply: + +trove module-reapply +-------------------- + +.. code-block:: console + + usage: trove module-reapply + [--md5 ] [--include_clustered] + [--batch_size ] [--delay ] + [--force] + +Reapply a module. + +**Positional arguments:** + +```` + Name or ID of the module. + +**Optional arguments:** + +``--md5 `` + Reapply the module only to instances applied with + the specific md5. + +``--include_clustered`` + Include instances that are part of a cluster + (default False). + +``--batch_size `` + Number of instances to reapply the module to + before sleeping. + +``--delay `` + Time to sleep in seconds between applying + batches. + +``--force`` + Force reapply even on modules already having the + current MD5 + +.. _trove_module-remove: + +trove module-remove +------------------- + +.. code-block:: console + + usage: trove module-remove + +Remove a module from an instance. + +**Positional arguments:** + +```` + ID or name of the instance. + +```` + ID or name of the module. + +.. _trove_module-retrieve: + +trove module-retrieve +--------------------- + +.. code-block:: console + + usage: trove module-retrieve + [--directory ] + [--prefix ] + +Retrieve module contents from an instance. + +**Positional arguments:** + +```` + ID or name of the instance. + +**Optional arguments:** + +``--directory `` + Directory to write module content files in. It + will be created if it does not exist. Defaults + to the current directory. + +``--prefix `` + Prefix to prepend to generated filename for each + module. + +.. _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] [--hidden] [--no_hidden] + [--live_update] [--no_live_update] + [--priority_apply] [--no_priority_apply] + [--apply_order {0,1,2,3,4,5,6,7,8,9}] + [--full_access] [--no_full_access] + +Update 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 driver + 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 versions. + +``--auto_apply`` + Automatically apply this module when + creating an instance or cluster. Admin only. + +``--no_auto_apply`` + Do not automatically apply this module when + creating an instance or cluster. Admin only. + +``--all_tenants`` + Module is valid for all tenants. Admin only. + +``--no_all_tenants`` + Module is valid for current tenant only. + Admin only. + +``--hidden`` + Hide this module from non-admin users. + Useful in creating auto-apply modules + without cluttering up module lists. Admin + only. + +``--no_hidden`` + Allow all users to see this module. Admin + only. + +``--live_update`` + Allow module to be updated or deleted even + if it is already applied to a current + instance or cluster. + +``--no_live_update`` + Restricts a module from being updated or + deleted if it is already applied to a + current instance or cluster. + +``--priority_apply`` + Sets a priority for applying the module. All + priority modules will be applied before non-priority ones. Admin only. + +``--no_priority_apply`` + Removes apply priority from the module. + Admin only. + +``--apply_order {0,1,2,3,4,5,6,7,8,9}`` + Sets an order for applying the module. + Modules with a lower value will be applied + before modules with a higher value. Modules + having the same value may be applied in any + order (default None). + +``--full_access`` + Marks a module as 'non-admin', unless an + admin-only option was specified. Admin only. + +``--no_full_access`` + Restricts modification access for non-admin. + Admin only. + +.. _trove_promote-to-replica-source: + +trove promote-to-replica-source +------------------------------- + +.. code-block:: console + + usage: trove promote-to-replica-source + +Promotes a replica to be the new replica source of its set. + +**Positional arguments:** + +```` + ID or name of the instance. + +.. _trove_quota-show: + +trove quota-show +---------------- + +.. code-block:: console + + usage: trove quota-show + +Show quotas for a tenant. + +**Positional arguments:** + +```` + Id of tenant for which to show quotas. + +.. _trove_quota-update: + +trove quota-update +------------------ + +.. code-block:: console + + usage: trove quota-update + +Update quotas for a tenant. + +**Positional arguments:** + +```` + Id of tenant for which to update quotas. + +```` + Id of resource to change. + +```` + New limit to set for the named resource. + +.. _trove_reset-status: + +trove reset-status +------------------ + +.. code-block:: console + + usage: trove reset-status + +Set the status to NONE. + +**Positional arguments:** + +```` + ID or name of the instance. + +.. _trove_resize-instance: + +trove resize-instance +--------------------- + +.. code-block:: console + + usage: trove resize-instance + +Resizes an instance with a new flavor. + +**Positional arguments:** + +```` + ID or name of the instance. + +```` + New flavor of the instance. + +.. _trove_resize-volume: + +trove resize-volume +------------------- + +.. code-block:: console + + usage: trove resize-volume + +Resizes the volume size of an instance. + +**Positional arguments:** + +```` + ID or name of the instance. + +```` + New size of the instance disk volume in GB. + +.. _trove_restart: + +trove restart +------------- + +.. code-block:: console + + usage: trove restart + +Restarts an instance. + +**Positional arguments:** + +```` + ID or name of the instance. + +.. _trove_root-disable: + +trove root-disable +------------------ + +.. code-block:: console + + usage: trove root-disable + +Disables root for an instance. + +**Positional arguments:** + +```` + ID or name of the instance. + +.. _trove_root-enable: + +trove root-enable +----------------- + +.. code-block:: console + + usage: trove root-enable + [--root_password ] + +Enables root for an instance and resets if already exists. + +**Positional arguments:** + +```` + ID or name of the instance or cluster. + +**Optional arguments:** + +``--root_password `` + Root password to set. + +.. _trove_root-show: + +trove root-show +--------------- + +.. code-block:: console + + usage: trove root-show + +Gets status if root was ever enabled for an instance or cluster. + +**Positional arguments:** + +```` + ID or name of the instance or cluster. + +.. _trove_schedule-create: + +trove schedule-create +--------------------- + +.. code-block:: console + + usage: trove schedule-create + [--description ] [--incremental] + +Schedules backups for an instance. + +**Positional arguments:** + +```` + ID or name of the instance. + +```` + Cron style pattern describing schedule + occurrence. + +```` + Name of the backup. + +**Optional arguments:** + +``--description `` + An optional description for the backup. + +``--incremental`` + Flag to select incremental backup based on most + recent backup. + +.. _trove_schedule-delete: + +trove schedule-delete +--------------------- + +.. code-block:: console + + usage: trove schedule-delete + +Deletes a schedule. + +**Positional arguments:** + +```` + Id of the schedule. + +.. _trove_schedule-list: + +trove schedule-list +------------------- + +.. code-block:: console + + usage: trove schedule-list + +Lists scheduled backups for an instance. + +**Positional arguments:** + +```` + ID or name of the instance. + +.. _trove_schedule-show: + +trove schedule-show +------------------- + +.. code-block:: console + + usage: trove schedule-show + +Shows details of a schedule. + +**Positional arguments:** + +```` + Id of the schedule. + +.. _trove_secgroup-add-rule: + +trove secgroup-add-rule +----------------------- + +.. code-block:: console + + usage: trove secgroup-add-rule + +Creates a security group rule. + +**Positional arguments:** + +```` + Security group ID. + +```` + CIDR address. + +.. _trove_secgroup-delete-rule: + +trove secgroup-delete-rule +-------------------------- + +.. code-block:: console + + usage: trove secgroup-delete-rule + +Deletes a security group rule. + +**Positional arguments:** + +```` + Name of security group rule. + +.. _trove_secgroup-list: + +trove secgroup-list +------------------- + +.. code-block:: console + + usage: trove secgroup-list + +Lists all security groups. + +.. _trove_secgroup-list-rules: + +trove secgroup-list-rules +------------------------- + +.. code-block:: console + + usage: trove secgroup-list-rules + +Lists all rules for a security group. + +**Positional arguments:** + +```` + Security group ID. + +.. _trove_secgroup-show: + +trove secgroup-show +------------------- + +.. code-block:: console + + usage: trove secgroup-show + +Shows details of a security group. + +**Positional arguments:** + +```` + Security group ID. + +.. _trove_show: + +trove show +---------- + +.. code-block:: console + + usage: trove show + +Shows details of an instance. + +**Positional arguments:** + +```` + ID or name of the instance. + +.. _trove_update: + +trove update +------------ + +.. code-block:: console + + usage: trove update + [--name ] [--configuration ] + [--detach_replica_source] [--remove_configuration] + +Updates an instance: Edits name, configuration, or replica source. + +**Positional arguments:** + +```` + ID or name of the instance. + +**Optional arguments:** + +``--name `` + Name of the instance. + +``--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. + +.. _trove_upgrade: + +trove upgrade +------------- + +.. code-block:: console + + usage: trove upgrade + +Upgrades an instance to a new datastore version. + +**Positional arguments:** + +```` + ID or name of the instance. + +```` + A datastore version name or ID. + +.. _trove_user-create: + +trove user-create +----------------- + +.. code-block:: console + + usage: trove user-create + [--host ] + [--databases [ ...]] + +Creates a user on an instance. + +**Positional arguments:** + +```` + ID or name of the instance. + +```` + Name of user. + +```` + Password of user. + +**Optional arguments:** + +``--host `` + Optional host of user. + +``--databases [ ...]`` + Optional list of databases. + +.. _trove_user-delete: + +trove user-delete +----------------- + +.. code-block:: console + + usage: trove user-delete [--host ] + +Deletes a user from an instance. + +**Positional arguments:** + +```` + ID or name of the instance. + +```` + Name of user. + +**Optional arguments:** + +``--host `` + Optional host of user. + +.. _trove_user-grant-access: + +trove user-grant-access +----------------------- + +.. code-block:: console + + usage: trove user-grant-access [ ...] + [--host ] + +Grants access to a database(s) for a user. + +**Positional arguments:** + +```` + ID or name of the instance. + +```` + Name of user. + +```` + List of databases. + +**Optional arguments:** + +``--host `` + Optional host of user. + +.. _trove_user-list: + +trove user-list +--------------- + +.. code-block:: console + + usage: trove user-list + +Lists the users for an instance. + +**Positional arguments:** + +```` + ID or name of the instance. + +.. _trove_user-revoke-access: + +trove user-revoke-access +------------------------ + +.. code-block:: console + + usage: trove user-revoke-access [--host ] + +Revokes access to a database for a user. + +**Positional arguments:** + +```` + ID or name of the instance. + +```` + Name of user. + +```` + A single database. + +**Optional arguments:** + +``--host `` + Optional host of user. + +.. _trove_user-show: + +trove user-show +--------------- + +.. code-block:: console + + usage: trove user-show [--host ] + +Shows details of a user of an instance. + +**Positional arguments:** + +```` + ID or name of the instance. + +```` + Name of user. + +**Optional arguments:** + +``--host `` + Optional host of user. + +.. _trove_user-show-access: + +trove user-show-access +---------------------- + +.. code-block:: console + + usage: trove user-show-access [--host ] + +Shows access details of a user of an instance. + +**Positional arguments:** + +```` + ID or name of the instance. + +```` + Name of user. + +**Optional arguments:** + +``--host `` + Optional host of user. + +.. _trove_user-update-attributes: + +trove user-update-attributes +---------------------------- + +.. code-block:: console + + usage: trove user-update-attributes + [--host ] [--new_name ] + [--new_password ] + [--new_host ] + +Updates a user's attributes on an instance. At least one optional argument +must be provided. + +**Positional arguments:** + +```` + ID or name of the instance. + +```` + Name of user. + +**Optional arguments:** + +``--host `` + Optional host of user. + +``--new_name `` + Optional new name of user. + +``--new_password `` + Optional new password of user. + +``--new_host `` + Optional new host of user. + +.. _trove_volume-type-list: + +trove volume-type-list +---------------------- + +.. code-block:: console + + usage: trove volume-type-list [--datastore_type ] + [--datastore_version_id ] + +Lists available volume types. + +**Optional arguments:** + +``--datastore_type `` + Type of the datastore. For eg: mysql. + +``--datastore_version_id `` + ID of the datastore version. + +.. _trove_volume-type-show: + +trove volume-type-show +---------------------- + +.. code-block:: console + + usage: trove volume-type-show + +Shows details of a volume type. + +**Positional arguments:** + +```` + ID or name of the volume type. + diff --git a/doc/source/index.rst b/doc/source/index.rst index 392e5c94..22b0459c 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -11,14 +11,19 @@ License for the specific language governing permissions and limitations under the License. -.. include:: ../../README.rst - :start-line: 0 - :end-line: 22 +============================================ + Python bindings to the OpenStack Trove API +============================================ + +This is a client for the OpenStack Trove API. There's a Python API (the +``troveclient`` module), and a command-line script (``trove``). Each +implements 100% of the OpenStack Trove API. .. toctree:: :maxdepth: 2 user/index + cli/index reference/index Indices and tables