Command Line Interface

Category: db

Commands for DB management.

rally-manage db create

Create Rally database.

rally-manage db recreate

Drop and create Rally database.

This will delete all existing data.

rally-manage db revision

Print current Rally database revision UUID.

rally-manage db upgrade

Upgrade Rally database to the latest state.

Category: deployment

Set of commands that allow you to manage deployments.

rally deployment check

Check keystone authentication and list all available services.

Command arguments:

--deployment <uuid> (ref)

Note

The default value for the --deployment argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.

Hint

You can set the default value by executing rally deployment use <uuid> (ref).

UUID or name of the deployment.
Type: str

rally deployment config

Display configuration of the deployment.

Output is the configuration of the deployment in a pretty-printed JSON format.

Command arguments:

--deployment <uuid> (ref)

Note

The default value for the --deployment argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.

Hint

You can set the default value by executing rally deployment use <uuid> (ref).

UUID or name of the deployment.
Type: str

rally deployment create

Create new deployment.

This command will create a new deployment record in rally database. In the case of ExistingCloud deployment engine it will use the cloud represented in the configuration. If the cloud doesn't exist, Rally can deploy a new one for you with Devstack or Fuel. Different deployment engines exist for these cases.

If you use the ExistingCloud deployment engine you can pass a deployment config by environment variables with --fromenv:

OS_USERNAME OS_PASSWORD OS_AUTH_URL OS_TENANT_NAME OS_ENDPOINT_TYPE or OS_INTERFACE OS_ENDPOINT OS_REGION_NAME OS_CACERT OS_INSECURE

All other deployment engines need more complex configuration data, so it should be stored in a configuration file.

You can use physical servers, LXC containers, KVM virtual machines or virtual machines in OpenStack for deploying the cloud. Except physical servers, Rally can create cluster nodes for you. Interaction with virtualization software, OpenStack cloud or physical servers is provided by server providers.

Command arguments:

--name <name> (ref)

Name of the deployment.
Type: str

--fromenv (ref)

Read environment variables instead of config file.

--filename <path> (ref)

Path to the configuration file of the deployment.
Type: str
Default: None

--no-use (ref)

Don't set new deployment as default for future operations.

rally deployment destroy

Destroy existing deployment.

This will delete all containers, virtual machines, OpenStack instances or Fuel clusters created during Rally deployment creation. Also it will remove the deployment record from the Rally database.

Command arguments:

--deployment <uuid> (ref)

Note

The default value for the --deployment argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.

Hint

You can set the default value by executing rally deployment use <uuid> (ref).

UUID or name of the deployment.
Type: str

rally deployment list

List existing deployments.

rally deployment recreate

Destroy and create an existing deployment.

Unlike 'deployment destroy', the deployment database record will not be deleted, so the deployment UUID stays the same.

Command arguments:

--deployment <uuid> (ref)

Note

The default value for the --deployment argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.

Hint

You can set the default value by executing rally deployment use <uuid> (ref).

UUID or name of the deployment.
Type: str

rally deployment show

Show the credentials of the deployment.

Command arguments:

--deployment <uuid> (ref)

Note

The default value for the --deployment argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.

Hint

You can set the default value by executing rally deployment use <uuid> (ref).

UUID or name of the deployment.
Type: str

rally deployment use

Set active deployment.

Command arguments:

--deployment <uuid> (ref)

UUID or name of a deployment.
Type: str

Category: plugin

Set of commands that allow you to manage Rally plugins.

rally plugin list

List all Rally plugins that match name and namespace.

Command arguments:

--name <name> (ref)

List only plugins that match the given name.
Type: str
Default: None

--namespace <namespace> (ref)

List only plugins that are in the specified namespace.
Type: str
Default: None

rally plugin show

Show detailed information about a Rally plugin.

Command arguments:

--name <name> (ref)

Plugin name.
Type: str

--namespace <namespace> (ref)

Plugin namespace.
Type: str
Default: None

Category: show

Warning

Deprecated since 0.2.0

Show resources.

Set of commands that allow you to view resources, provided by OpenStack cloud represented by deployment.

rally show flavors

Display available flavors.

Command arguments:

--deployment <uuid> (ref)

Note

The default value for the --deployment argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.

Hint

You can set the default value by executing rally deployment use <uuid> (ref).

UUID or name of a deployment.
Type: str

rally show images

Display available images.

Command arguments:

--deployment <uuid> (ref)

Note

The default value for the --deployment argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.

Hint

You can set the default value by executing rally deployment use <uuid> (ref).

UUID or name of a deployment.
Type: str

rally show keypairs

Display available ssh keypairs.

Command arguments:

--deployment <uuid> (ref)

Note

The default value for the --deployment argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.

Hint

You can set the default value by executing rally deployment use <uuid> (ref).

UUID or name of a deployment.
Type: str

rally show networks

Display configured networks.

Command arguments:

--deployment <uuid> (ref)

Note

The default value for the --deployment argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.

Hint

You can set the default value by executing rally deployment use <uuid> (ref).

UUID or name of a deployment.
Type: str

rally show secgroups

Display security groups.

Command arguments:

--deployment <uuid> (ref)

Note

The default value for the --deployment argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.

Hint

You can set the default value by executing rally deployment use <uuid> (ref).

UUID or name of a deployment.
Type: str

Category: task

Set of commands that allow you to manage benchmarking tasks and results.

rally task abort

Abort a running benchmarking task.

Command arguments:

--uuid <uuid> (ref)

UUID of task.
Type: str

--soft (ref)

Abort task after current scenario finishes execution.

rally task delete

Delete task and its results.

Command arguments:

--force (ref)

force delete

--uuid <task-id> (ref)

UUID of task or a list of task UUIDs.
Type: str

rally task detailed

Print detailed information about given task.

Command arguments:

--uuid <uuid> (ref)

UUID of task. If --uuid is "last" the results of the most recently created task will be displayed.
Type: str

--iterations-data (ref)

Print detailed results for each iteration.

rally task export

Export task results to the custom task's exporting system.

Command arguments:

--uuid <uuid> (ref)

UUID of a the task.
Type: str

--connection <connection> (ref)

Connection url to the task export system.
Type: str

rally task list

List tasks, started and finished.

Displayed tasks can be filtered by status or deployment. By default 'rally task list' will display tasks from the active deployment without filtering by status.

Command arguments:

--deployment <uuid> (ref)

Note

The default value for the --deployment argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.

Hint

You can set the default value by executing rally deployment use <uuid> (ref).

UUID or name of a deployment.
Type: str

--all-deployments (ref)

List tasks from all deployments.

--status <status> (ref)

List tasks with specified status. Available statuses: aborted, aborting, cleaning up, failed, finished, init, paused, running, setting up, soft_aborting, verifying
Type: str
Default: None

--uuids-only (ref)

List task UUIDs only.

rally task report

Generate report file for specified task.

Command arguments:

--tasks <tasks> (ref)

UUIDs of tasks, or JSON files with task results
Default: None

--out <path> (ref)

Path to output file.
Type: str
Default: None

--open (ref)

Open the output in a browser.

--html (ref)

Generate the report in HTML.

--html-static (ref)

Generate the report in HTML with embedded JS and CSS, so it will not depend on Internet availability.

--junit (ref)

Generate the report in the JUnit format.

rally task results

Display raw task results.

This will produce a lot of output data about every iteration.

Command arguments:

--uuid <uuid> (ref)

UUID of task.
Type: str

rally task sla_check

Display SLA check results table.

Command arguments:

--uuid <uuid> (ref)

UUID of task.
Type: str

--json (ref)

Output in JSON format.

rally task start

Start benchmark task.

If both task_args and task_args_file are specified, they will be merged. task_args has a higher priority so it will override values from task_args_file.

Command arguments:

--deployment <uuid> (ref)

Note

The default value for the --deployment argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.

Hint

You can set the default value by executing rally deployment use <uuid> (ref).

UUID or name of a deployment.
Type: str

--task <path>, --filename <path> (ref)

Note

The default value for the --task argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally task start, if the --no-use argument was not used.

Hint

You can set the default value by executing rally task use <uuid> (ref).

Path to the input task file

--task-args <json> (ref)

Input task args (JSON dict). These args are used to render the Jinja2 template in the input task.
Default: None

--task-args-file <path> (ref)

Path to the file with input task args (dict in JSON/YAML). These args are used to render the Jinja2 template in the input task.
Default: None

--tag <tag> (ref)

Tag for this task
Default: None

--no-use (ref)

Don't set new task as default for future operations.

--abort-on-sla-failure (ref)

Abort the execution of a benchmark scenario whenany SLA check for it fails.

rally task status

Display the current status of a task.

Command arguments:

--uuid <uuid> (ref)

UUID of task
Type: str

rally task use

Set active task.

Command arguments:

--uuid <uuid> (ref)

UUID of the task
Type: str

--task (ref)

[Deprecated since Rally 0.2.0] Use '--uuid' instead.
Type: str

rally task validate

Validate a task configuration file.

This will check that task configuration file has valid syntax and all required options of scenarios, contexts, SLA and runners are set.

If both task_args and task_args_file are specified, they will be merged. task_args has a higher priority so it will override values from task_args_file.

Command arguments:

--deployment <uuid> (ref)

Note

The default value for the --deployment argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.

Hint

You can set the default value by executing rally deployment use <uuid> (ref).

UUID or name of a deployment.
Type: str

--task <path>, --filename <path> (ref)

Note

The default value for the --task argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally task start, if the --no-use argument was not used.

Hint

You can set the default value by executing rally task use <uuid> (ref).

Path to the input task file.

--task-args <json> (ref)

Input task args (JSON dict). These args are used to render the Jinja2 template in the input task.
Default: None

--task-args-file <path> (ref)

Path to the file with input task args (dict in JSON/YAML). These args are used to render the Jinja2 template in the input task.
Default: None

Category: verify

Verify an OpenStack cloud via Tempest.

Set of commands that allow you to run Tempest tests.

rally verify compare

Compare two verification results.

Command arguments:

--uuid-1 <uuid_1> (ref)

UUID of the first verification
Type: str
Default: None

--uuid-2 <uuid_2> (ref)

UUID of the second verification
Type: str
Default: None

--csv (ref)

Display results in CSV format

--html (ref)

Display results in HTML format

--json (ref)

Display results in JSON format

--output-file <output_file> (ref)

Path to a file to save results
Type: str
Default: None

--threshold <threshold> (ref)

If specified, timing differences must exceed this percentage threshold to be included in output
Type: int
Default: 0

rally verify detailed

Display results table of a verification with detailed errors.

Command arguments:

--uuid <uuid> (ref)

Note

The default value for the --uuid argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally verify start, rally verify import_results, if the --no-use argument was not used.

Hint

You can set the default value by executing rally verify use <uuid> (ref).

UUID of a verification.
Type: str

--sort-by <sort_by> (ref)

Sort results by 'name' or 'duration'
Default: name

rally verify discover

Show a list of discovered tests.

Command arguments:

--deployment <uuid> (ref)

Note

The default value for the --deployment argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.

Hint

You can set the default value by executing rally deployment use <uuid> (ref).

UUID or name of a deployment
Type: str

--pattern <pattern> (ref)

Test name pattern which can be used to match
Type: str
Default:

--system-wide (ref)

Discover tests for system-wide Tempest installation

rally verify genconfig

Generate Tempest configuration file.

Command arguments:

--deployment <uuid> (ref)

Note

The default value for the --deployment argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.

Hint

You can set the default value by executing rally deployment use <uuid> (ref).

UUID or name of a deployment.
Type: str

--tempest-config <path> (ref)

User-specified Tempest config file location
Type: str
Default: None

--add-options <path> (ref)

Path to a file with additional options to extend/update Tempest config file
Type: str
Default: None

--override (ref)

Override existing Tempest config file

rally verify import

Import Tempest tests results into the Rally database.

Command arguments:

--deployment <uuid> (ref)

Note

The default value for the --deployment argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.

Hint

You can set the default value by executing rally deployment use <uuid> (ref).

UUID or name of a deployment.
Type: str

--set <set_name> (ref)

Name of a Tempest test set. Available sets are full, scenario, smoke, baremetal, clustering, compute, database, data_processing, identity, image, messaging, network, object_storage, orchestration, telemetry, volume
Type: str
Default:

--file <path> (ref)

User specified Tempest log file location. Note, Tempest log file needs to be in subunit format
Type: str
Default: None

--no-use (ref)

Not to set new task as default for future operations

rally verify install

Install Tempest.

Command arguments:

--deployment <uuid> (ref)

Note

The default value for the --deployment argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.

Hint

You can set the default value by executing rally deployment use <uuid> (ref).

UUID or name of a deployment.
Type: str

--source <source> (ref)

Path/URL to repo to clone Tempest from
Type: str
Default: None

--version <version> (ref)

Commit ID or tag to checkout before Tempest installation
Type: str
Default: None

--system-wide (ref)

Not to install Tempest package and not to create a virtual env for Tempest. Note that Tempest package and all Tempest requirements have to be already installed in the local env!

rally verify installplugin

Install Tempest plugin.

Command arguments:

--deployment <deployment> (ref)

Note

The default value for the --deployment argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.

Hint

You can set the default value by executing rally deployment use <uuid> (ref).

UUID or name of a deployment
Type: str

--source <source> (ref)

Path/URL to repo to clone Tempest plugin from
Type: str
Default: None

--version <version> (ref)

Branch, commit ID or tag to checkout before Tempest plugin installation
Type: str
Default: None

--system-wide (ref)

Install plugin in the local env, not in Tempest virtual env. Note that all Tempest plugin requirements have to be already installed in the local env!

rally verify list

List verification runs.

rally verify listplugins

List all installed Tempest plugins.

Command arguments:

--deployment <deployment> (ref)

Note

The default value for the --deployment argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.

Hint

You can set the default value by executing rally deployment use <uuid> (ref).

UUID or name of a deployment
Type: str

--system-wide (ref)

List all plugins installed in the local env, not in Tempest virtual env

rally verify reinstall

Uninstall Tempest and install again.

Command arguments:

--deployment <uuid> (ref)

Note

The default value for the --deployment argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.

Hint

You can set the default value by executing rally deployment use <uuid> (ref).

UUID or name of a deployment.
Type: str

--source <source> (ref)

Path/URL to repo to clone Tempest from
Type: str
Default: None

--version <version> (ref)

Commit ID or tag to checkout before Tempest installation
Type: str
Default: None

--system-wide (ref)

Not to install Tempest package and not to create a virtual env for Tempest. Note that Tempest package and all Tempest requirements have to be already installed in the local env!

rally verify results

Display results of a verification.

Command arguments:

--uuid <uuid> (ref)

Note

The default value for the --uuid argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally verify start, rally verify import_results, if the --no-use argument was not used.

Hint

You can set the default value by executing rally verify use <uuid> (ref).

UUID of a verification.
Type: str

--html (ref)

Display results in HTML format.

--json (ref)

Display results in JSON format.

--output-file <path> (ref)

Path to a file to save results to.
Type: str
Default: None

rally verify show

Display results table of a verification.

Command arguments:

--uuid <uuid> (ref)

Note

The default value for the --uuid argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally verify start, rally verify import_results, if the --no-use argument was not used.

Hint

You can set the default value by executing rally verify use <uuid> (ref).

UUID of a verification
Type: str

--sort-by <query> (ref)

Sort results by 'name' or 'duration'
Type: str
Default: name

--detailed (ref)

Display detailed errors of failed tests

rally verify showconfig

Show Tempest configuration file.

Command arguments:

--deployment <uuid> (ref)

Note

The default value for the --deployment argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.

Hint

You can set the default value by executing rally deployment use <uuid> (ref).

UUID or name of a deployment.
Type: str

rally verify start

Start verification (run Tempest tests).

Command arguments:

--deployment <uuid> (ref)

Note

The default value for the --deployment argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.

Hint

You can set the default value by executing rally deployment use <uuid> (ref).

UUID or name of a deployment.
Type: str

--set <set_name> (ref)

Name of a Tempest test set. Available sets are full, scenario, smoke, baremetal, clustering, compute, database, data_processing, identity, image, messaging, network, object_storage, orchestration, telemetry, volume
Type: str
Default:

--regex <regex> (ref)

Test name regular expression
Type: str
Default: None

--load-list <path> (ref)

Path to a file with a list of Tempest tests to run only them
Type: str
Default: None

--tests-file <path> (ref)

[Deprecated since Rally 0.6.0] Path to a file with a list of Tempest tests to run only them
Type: str
Default: None

--skip-list <path> (ref)

Path to a file with a list of Tempest tests to skip their run
Type: str
Default: None

--tempest-config <path> (ref)

User-specified Tempest config file location
Type: str
Default: None

--xfail-list <path> (ref)

Path to a YAML file with a list of Tempest tests that are expected to fail
Type: str
Default: None

--xfails-file <path> (ref)

[Deprecated since Rally 0.6.0] Path to a YAML file with a list of Tempest tests that are expected to fail
Type: str
Default: None

--no-use (ref)

Not to set the task as default for future operations

--system-wide (ref)

Not to create a virtual env when installing Tempest; use the local env instead of the Tempest virtual env when running the tests. Note that all Tempest requirements have to be already installed in the local env!

--concurrency N (ref)

How many processes to use to run Tempest tests. The default value (0) auto-detects your CPU count
Type: int
Default: 0

--failing (ref)

Re-run the tests that failed in the last execution

rally verify uninstall

Remove the deployment's local Tempest installation.

Command arguments:

--deployment <uuid> (ref)

Note

The default value for the --deployment argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.

Hint

You can set the default value by executing rally deployment use <uuid> (ref).

UUID or name of a deployment.
Type: str

rally verify uninstallplugin

Uninstall Tempest plugin.

Command arguments:

--deployment <deployment> (ref)

Note

The default value for the --deployment argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.

Hint

You can set the default value by executing rally deployment use <uuid> (ref).

UUID or name of a deployment
Type: str

--repo-name <repo_name> (ref)

Plugin repo name
Type: str
Default: None

--system-wide (ref)

Uninstall plugin from the local env, not from Tempest virtual env

rally verify use

Set active verification.

Command arguments:

--uuid <uuid> (ref)

UUID of a verification
Type: str