Command Line Interface

Cut down from Global Command Line Interface

Category: verify

Verify an OpenStack cloud via a verifier.

rally verify add-verifier-ext

Add a verifier extension.

Command arguments:

  • –id <id> [ref]
Verifier name or UUID. HINT: You can list all verifiers, executing command rally verify list-verifiers.
type: str
default: none
  • –source <source> [ref]
Path or URL to the repo to clone verifier extension from.
type: str
default: none
  • –version <version> [ref]
Branch, tag or commit ID to checkout before installation of the verifier extension (the ‘master’ branch is used by default).
type: str
default: none
  • –extra-settings <extra_settings> [ref]
Extra installation settings for verifier extension.
type: str
default: none

rally verify configure-verifier

Configure a verifier for a specific deployment.

Command arguments:

  • –id <id> [ref]
Verifier name or UUID. HINT: You can list all verifiers, executing command rally verify list-verifiers.
type: str
default: none
  • –deployment-id <id> [ref]

Note

The default value for the --deployment-id 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).

Deployment name or UUID. HINT: You can list all deployments, executing command rally deployment list.
type: str
  • –reconfigure [ref]
Reconfigure verifier.
  • –extend <path/json/yaml> [ref]
Extend verifier configuration with extra options. If options are already present, the given ones will override them. Can be a path to a regular config file or just a json/yaml.
type: str
default: none
  • –override <path> [ref]
Override verifier configuration by another one from a given source.
type: str
default: none
  • –show [ref]
Show verifier configuration.

rally verify create-verifier

Create a verifier.

Command arguments:

  • –name <name> [ref]
Verifier name (for example, ‘My verifier’).
type: str
  • –type <type> [ref]
Verifier plugin name. HINT: You can list all verifier plugins, executing command rally verify list-plugins.
type: str
  • –platform <platform> [ref]
Verifier plugin platform. Should be specified in case of two verifier plugins with equal names but in different platforms.
type: str
default:
  • –namespace [ref]
[deprecated since rally 0.10.0] use ‘–platform’ instead.
default:
  • –source <source> [ref]
Path or URL to the repo to clone verifier from.
type: str
default: none
  • –version <version> [ref]
Branch, tag or commit ID to checkout before verifier installation (the ‘master’ branch is used by default).
type: str
default: none
  • –system-wide [ref]
Use the system-wide environment for verifier instead of a virtual environment.
  • –extra-settings <extra_settings> [ref]
Extra installation settings for verifier.
type: str
default: none
  • –no-use [ref]
Not to set the created verifier as the default verifier for future operations.

rally verify delete

Delete a verification or a few verifications.

Command arguments:

  • –uuid <uuid> [ref]
UUIDs of verifications. HINT: You can list all verifications, executing command rally verify list.
type: str

rally verify delete-verifier

Delete a verifier.

Command arguments:

  • –id <id> [ref]
Verifier name or UUID. HINT: You can list all verifiers, executing command rally verify list-verifiers.
type: str
  • –deployment-id <id> [ref]

Note

The default value for the --deployment-id 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).

Deployment name or UUID. If specified, only the deployment-specific data will be deleted for verifier. HINT: You can list all deployments, executing command rally deployment list.
type: str
  • –force [ref]
Delete all stored verifications of the specified verifier. If a deployment specified, only verifications of this deployment will be deleted. Use this argument carefully! You can delete verifications that may be important to you.

rally verify delete-verifier-ext

Delete a verifier extension.

Command arguments:

  • –id <id> [ref]
Verifier name or UUID. HINT: You can list all verifiers, executing command rally verify list-verifiers.
type: str
default: none
  • –name <name> [ref]
Verifier extension name.
type: str
default: none

rally verify import

Import results of a test run into the Rally database.

Command arguments:

  • –id <id> [ref]
Verifier name or UUID. HINT: You can list all verifiers, executing command rally verify list-verifiers.
type: str
default: none
  • –deployment-id <id> [ref]

Note

The default value for the --deployment-id 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).

Deployment name or UUID. HINT: You can list all deployments, executing command rally deployment list.
type: str
  • –file <path> [ref]
File to import test results from.
type: str
default: none
  • –run-args <run_args> [ref]
Arguments that might be used when running tests. For example, ‘{concurrency: 2, pattern: set=identity}’.
type: str
default: none
  • –no-use [ref]
Not to set the created verification as the default verification for future operations.

rally verify list

List all verifications.

Command arguments:

  • –id <id> [ref]
Verifier name or UUID. HINT: You can list all verifiers, executing command rally verify list-verifiers.
type: str
default: none
  • –deployment-id <id> [ref]

Note

The default value for the --deployment-id 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).

Deployment name or UUID. HINT: You can list all deployments, executing command rally deployment list.
type: str
  • –tag <tag> [ref]
Tags to filter verifications by.
type: str
default: none
  • –status <status> [ref]
Status to filter verifications by.
type: str
default: none

rally verify list-plugins

List all plugins for verifiers management.

Command arguments:

  • –platform <platform> [ref]
Requried patform (e.g. openstack).
type: str
default: none
  • –namespace [ref]
[deprecated since rally 0.10.0] use ‘–platform’ instead.
default: none

rally verify list-verifier-exts

List all verifier extensions.

Command arguments:

  • –id <id> [ref]
Verifier name or UUID. HINT: You can list all verifiers, executing command rally verify list-verifiers.
type: str
default: none

rally verify list-verifier-tests

List all verifier tests.

Command arguments:

  • –id <id> [ref]
Verifier name or UUID. HINT: You can list all verifiers, executing command rally verify list-verifiers.
type: str
default: none
  • –pattern <pattern> [ref]
Pattern which will be used for matching. Can be a regexp or a verifier-specific entity (for example, in case of Tempest you can specify ‘set=smoke’).
type: str
default:

rally verify list-verifiers

List all verifiers.

Command arguments:

  • –status <status> [ref]
Status to filter verifiers by.
type: str
default: none

rally verify report

Generate a report for a verification or a few verifications.

Command arguments:

  • –uuid <uuid> [ref]
UUIDs of verifications. HINT: You can list all verifications, executing command rally verify list.
type: str
default: none
  • –type <type> [ref]
Report type (Defaults to JSON). Out-of-the-box types: HTML, HTML-Static, JSON, JUnit-XML. HINT: You can list all types, executing rally plugin list –plugin-base VerificationReporter command.
type: str
default: none
  • –to <dest> [ref]
Report destination. Can be a path to a file (in case of HTML, JSON, etc. types) to save the report to or a connection string. It depends on the report type.
type: str
default: none
  • –open [ref]
Open the output file in a browser.

rally verify rerun

Rerun tests from a verification for a specific deployment.

Command arguments:

  • –uuid <uuid> [ref]
Verification UUID. HINT: You can list all verifications, executing command rally verify list.
type: str
default: none
  • –deployment-id <id> [ref]

Note

The default value for the --deployment-id 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).

Deployment name or UUID. HINT: You can list all deployments, executing command rally deployment list.
type: str
  • –failed [ref]
Rerun only failed tests.
  • –tag <tag> [ref]
Mark verification with a tag or a few tags.
type: str
default: none
  • –concurrency <N> [ref]
How many processes to be used for running verifier tests. The default value (0) auto-detects your CPU count.
type: int
default: none
  • –detailed [ref]
Show verification details such as errors of failed tests.
  • –no-use [ref]
Not to set the finished verification as the default verification for future operations.

rally verify show

Show detailed information about a verification.

Command arguments:

  • –uuid <uuid> [ref]
Verification UUID. HINT: You can list all verifications, executing command rally verify list.
type: str
default: none
  • –sort-by <query> [ref]
Sort tests by ‘name’, ‘duration’ or ‘status’.
type: str
default: name
  • –detailed [ref]
Show verification details such as run arguments and errors of failed tests.

rally verify show-verifier

Show detailed information about a verifier.

Command arguments:

  • –id <id> [ref]
Verifier name or UUID. HINT: You can list all verifiers, executing command rally verify list-verifiers.
type: str
default: none

rally verify start

Start a verification (run verifier tests).

Command arguments:

  • –id <id> [ref]
Verifier name or UUID. HINT: You can list all verifiers, executing command rally verify list-verifiers.
type: str
default: none
  • –deployment-id <id> [ref]

Note

The default value for the --deployment-id 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).

Deployment name or UUID. HINT: You can list all deployments, executing command rally deployment list.
type: str
  • –tag <tag> [ref]
Mark verification with a tag or a few tags.
type: str
default: none
  • –pattern <pattern> [ref]
Pattern which will be used for running tests. Can be a regexp or a verifier-specific entity (for example, in case of Tempest you can specify ‘set=smoke’).
type: str
default: none
  • –concurrency <N> [ref]
How many processes to be used for running verifier tests. The default value (0) auto-detects your CPU count.
type: int
default: 0
  • –load-list <path> [ref]
Path to a file with a list of tests to run.
type: str
default: none
  • –skip-list <path> [ref]
Path to a file with a list of tests to skip. Format: json or yaml like a dictionary where keys are test names and values are reasons.
type: str
default: none
  • –xfail-list <path> [ref]
Path to a file with a list of tests that will be considered as expected failures. Format: json or yaml like a dictionary where keys are test names and values are reasons.
type: str
default: none
  • –detailed [ref]
Show verification details such as errors of failed tests.
  • –no-use [ref]
Not to set the finished verification as the default verification for future operations.

rally verify update-verifier

Update a verifier.

Command arguments:

  • –id <id> [ref]
Verifier name or UUID. HINT: You can list all verifiers, executing command rally verify list-verifiers.
type: str
default: none
  • –update-venv [ref]
Update the virtual environment for verifier.
  • –version <version> [ref]
Branch, tag or commit ID to checkout. HINT: Specify the same version to pull the latest repo code.
type: str
default: none
  • –system-wide [ref]
Switch to using the system-wide environment.
  • –no-system-wide [ref]
Switch to using the virtual environment. If the virtual environment doesn’t exist, it will be created.

rally verify use

Choose a verification to use for the future operations.

Command arguments:

  • –uuid <uuid> [ref]
Verification UUID. HINT: You can list all verifications, executing command rally verify list.
type: str

rally verify use-verifier

Choose a verifier to use for the future operations.

Command arguments:

  • –id <id> [ref]
Verifier name or UUID. HINT: You can list all verifiers, executing command rally verify list-verifiers.
type: str