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

--namespace <name> (ref)

Verifier plugin namespace. Should be specified in case of two verifier plugins with equal names but in different namespaces.

Type: str

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: master

--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:

--namespace <name> (ref)

Namespace name (for example, openstack).

Type: str

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 types) to save the report to or a connection string. It depends on 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.

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 use to run 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