usage: trove [--version] [--debug] [--service-type <service-type>] [--service-name <service-name>]
[--bypass-url <bypass-url>] [--database-service-name <database-service-name>]
[--endpoint-type <endpoint-type>] [--os-database-api-version <database-api-ver>]
[--retries <retries>] [--json] [--profile HMAC_KEY] [--insecure]
[--os-cacert <ca-certificate>] [--os-cert <certificate>] [--os-key <key>]
[--timeout <seconds>] [--collect-timing] [--os-auth-type <name>]
[--os-auth-url OS_AUTH_URL] [--os-system-scope OS_SYSTEM_SCOPE]
[--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 <region-name>]
<subcommand> ...
Command-line interface to the OpenStack Trove API.
Positional arguments:
<subcommand>
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 Delete specified cluster(s).
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 Delete specified instance(s).
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 <id>.
metadata-delete Deletes metadata for instance <id>.
metadata-edit Replaces metadata value with a new one, this is non-destructive.
metadata-list Shows all metadata for instance <id>.
metadata-show Shows metadata entry for key <key> and instance <id>.
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 task status of an instance to NONE if the instance is in
BUILD
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.
Options:
--version Show program's version number and exit.
--debug Print debugging output.
--service-type <service-type> Defaults to database for most actions.
--service-name <service-name> Defaults to env[TROVE_SERVICE_NAME].
--bypass-url <bypass-url> Defaults to env[TROVE_BYPASS_URL].
--database-service-name <database-service-name>
Defaults to env[TROVE_DATABASE_SERVICE_NAME].
--endpoint-type <endpoint-type>
Defaults to env[TROVE_ENDPOINT_TYPE] or env[OS_ENDPOINT_TYPE] or
publicURL.
--os-database-api-version <database-api-ver>
Accepts 1, defaults to env[OS_DATABASE_API_VERSION].
--retries <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
configuration files, 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 <name>
Authentication type to use
--os-region-name <region-name> Specify the region to use. Defaults to env[OS_REGION_NAME].
API Connection Options:
Options controlling the HTTP API Connections
--insecure Explicitly allow client to perform "insecure" TLS (https)
requests. The server's certificate will not be verified against
any certificate authorities. This option should be used with
caution.
--os-cacert <ca-certificate> Specify a CA bundle file to use in verifying a TLS (https)
server certificate. Defaults to env[OS_CACERT].
--os-cert <certificate> The location for the keystore (PEM formatted) containing the
public key of this client. Defaults to env[OS_CERT].
--os-key <key> The location for the keystore (PEM formatted) containing the
private key of this client. Defaults to env[OS_KEY].
--timeout <seconds> Set request timeout (in seconds).
--collect-timing Collect per-API call timing information.
Authentication Options:
Options specific to the password plugin.
--os-auth-url OS_AUTH_URL Authentication URL
--os-system-scope OS_SYSTEM_SCOPE
Scope for system operations
--os-domain-id OS_DOMAIN_ID Domain ID to scope to
--os-domain-name OS_DOMAIN_NAME
Domain name to scope to
--os-project-id, --os-tenant-id OS_PROJECT_ID
Project ID to scope to
--os-project-name, --os-tenant-name OS_PROJECT_NAME
Project name to scope to
--os-project-domain-id OS_PROJECT_DOMAIN_ID
Domain ID containing project
--os-project-domain-name OS_PROJECT_DOMAIN_NAME
Domain name containing project
--os-trust-id OS_TRUST_ID ID of the trust to use as a trustee use
--os-default-domain-id OS_DEFAULT_DOMAIN_ID
Optional domain ID to use with v3 and v2 parameters. It will be
used for both the user and project domain in v3 and ignored in
v2 authentication.
--os-default-domain-name OS_DEFAULT_DOMAIN_NAME
Optional domain name to use with v3 API and v2 parameters. It
will be used for both the user and project domain in v3 and
ignored in v2 authentication.
--os-user-id OS_USER_ID User id
--os-username, --os-user-name OS_USERNAME
Username
--os-user-domain-id OS_USER_DOMAIN_ID
User's domain id
--os-user-domain-name OS_USER_DOMAIN_NAME
User's domain name
--os-password OS_PASSWORD User's password
See "trove help COMMAND" for help on a specific command.
Options (35)
| Option | Description | Source |
|---|---|---|
--version | Show program's version number and exit. | help |
--debug | Print debugging output. | help |
--service-type service-type | Defaults to database for most actions. | help |
--service-name service-name | Defaults to env[TROVE_SERVICE_NAME]. | help |
--bypass-url bypass-url | Defaults to env[TROVE_BYPASS_URL]. | help |
--database-service-name database-service-name | Defaults to env[TROVE_DATABASE_SERVICE_NAME]. | help |
--endpoint-type endpoint-type | Defaults to env[TROVE_ENDPOINT_TYPE] or env[OS_ENDPOINT_TYPE] or publicURL. | help |
--os-database-api-version database-api-ver | Accepts 1, defaults to env[OS_DATABASE_API_VERSION]. | help |
--retries retries | Number of retries. | help |
--json, --os-json-output | Output JSON instead of prettyprint. | help |
--profile HMAC_KEY | HMAC key used to encrypt context data when profiling the performance of an operation. | help |
--os-auth-type, --os-auth-plugin name | Authentication type to use | help |
--os-region-name region-name | Specify the region to use. | help |
--insecure | Explicitly allow client to perform "insecure" TLS (https) requests. | help |
--os-cacert ca-certificate | Specify a CA bundle file to use in verifying a TLS (https) server certificate. | help |
--os-cert certificate | The location for the keystore (PEM formatted) containing the public key of this client. | help |
--os-key key | The location for the keystore (PEM formatted) containing the private key of this client. | help |
--timeout seconds | Set request timeout (in seconds). | help |
--collect-timing | Collect per-API call timing information. | help |
--os-auth-url OS_AUTH_URL | Authentication URL | help |
--os-system-scope OS_SYSTEM_SCOPE | Scope for system operations | help |
--os-domain-id OS_DOMAIN_ID | Domain ID to scope to | help |
--os-domain-name OS_DOMAIN_NAME | Domain name to scope to | help |
--os-project-id, --os-tenant-id OS_PROJECT_ID | Project ID to scope to | help |
--os-project-name, --os-tenant-name OS_PROJECT_NAME | Project name to scope to | help |
--os-project-domain-id OS_PROJECT_DOMAIN_ID | Domain ID containing project | help |
--os-project-domain-name OS_PROJECT_DOMAIN_NAME | Domain name containing project | help |
--os-trust-id OS_TRUST_ID | ID of the trust to use as a trustee use | help |
--os-default-domain-id OS_DEFAULT_DOMAIN_ID | Optional domain ID to use with v3 and v2 parameters. | help |
--os-default-domain-name OS_DEFAULT_DOMAIN_NAME | Optional domain name to use with v3 API and v2 parameters. | help |
--os-user-id OS_USER_ID | User id | help |
--os-username, --os-user-name OS_USERNAME | Username | help |
--os-user-domain-id OS_USER_DOMAIN_ID | User's domain id | help |
--os-user-domain-name OS_USER_DOMAIN_NAME | User's domain name | help |
--os-password OS_PASSWORD | User's password | help |