Workflow service command-line client

Workflow service command-line client

The mistral client is the command-line interface (CLI) for the Workflow service API and its extensions.

This chapter documents mistral version 2.0.0.

For help on a specific mistral command, enter:

$ mistral help COMMAND

mistral usage

usage: mistral [--version] [-v] [--log-file LOG_FILE] [-q] [-h] [--debug]
               [--os-mistral-url MISTRAL_URL]
               [--os-mistral-version MISTRAL_VERSION]
               [--os-mistral-service-type SERVICE_TYPE]
               [--os-mistral-endpoint-type ENDPOINT_TYPE]
               [--os-username USERNAME] [--os-password PASSWORD]
               [--os-tenant-id TENANT_ID] [--os-tenant-name TENANT_NAME]
               [--os-auth-token TOKEN] [--os-auth-url AUTH_URL]
               [--os-cacert CACERT] [--insecure]

mistral optional arguments

--version
Show program’s version number and exit.
-v, --verbose
Increase verbosity of output. Can be repeated.
--log-file LOG_FILE
Specify a file to log output. Disabled by default.
-q, --quiet
Suppress output except warnings and errors.
-h, --help
Show this help message and exit.
--debug
Show tracebacks on errors.
--os-mistral-url MISTRAL_URL
Mistral API host (Env: OS_MISTRAL_URL)
--os-mistral-version MISTRAL_VERSION
Mistral API version (default = v2) (Env: OS_MISTRAL_VERSION)
--os-mistral-service-type SERVICE_TYPE
Mistral service-type (should be the same name as in keystone-endpoint) (default = workflowv2) (Env: OS_MISTRAL_SERVICE_TYPE)
--os-mistral-endpoint-type ENDPOINT_TYPE
Mistral endpoint-type (should be the same name as in keystone-endpoint) (default = publicURL) (Env: OS_MISTRAL_ENDPOINT_TYPE)
--os-username USERNAME
Authentication username (Env: OS_USERNAME)
--os-password PASSWORD
Authentication password (Env: OS_PASSWORD)
--os-tenant-id TENANT_ID
Authentication tenant identifier (Env: OS_TENANT_ID)
--os-tenant-name TENANT_NAME
Authentication tenant name (Env: OS_TENANT_NAME)
--os-auth-token TOKEN
Authentication token (Env: OS_AUTH_TOKEN)
--os-auth-url AUTH_URL
Authentication URL (Env: OS_AUTH_URL)
--os-cacert CACERT
Authentication CA Certificate (Env: OS_CACERT)
--insecure
Disables SSL/TLS certificate verification (Env: MISTRALCLIENT_INSECURE)

mistral action-create

usage: mistral action-create [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--max-width <integer>] [--noindent]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--public]
                             definition

Create new action.

Positional arguments:

definition
Action definition file

Optional arguments:

-h, --help
show this help message and exit
--public
With this flag action will be marked as “public”.

mistral action-delete

usage: mistral action-delete [-h] name [name ...]

Delete action.

Positional arguments:

name
Name of action(s).

Optional arguments:

-h, --help
show this help message and exit

mistral action-execution-delete

usage: mistral action-execution-delete [-h] id [id ...]

Delete action execution.

Positional arguments:

id
Id of action execution identifier(s).

Optional arguments:

-h, --help
show this help message and exit

mistral action-execution-get

usage: mistral action-execution-get [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--noindent] [--prefix PREFIX]
                                    id

Show specific Action execution.

Positional arguments:

id
Action execution ID.

Optional arguments:

-h, --help
show this help message and exit

mistral action-execution-get-input

usage: mistral action-execution-get-input [-h] id

Show Action execution input data.

Positional arguments:

id
Action execution ID.

Optional arguments:

-h, --help
show this help message and exit

mistral action-execution-get-output

usage: mistral action-execution-get-output [-h] id

Show Action execution output data.

Positional arguments:

id
Action execution ID.

Optional arguments:

-h, --help
show this help message and exit

mistral action-execution-list

usage: mistral action-execution-list [-h] [-f {csv,json,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--noindent]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [task_execution_id]

List all Action executions.

Positional arguments:

task_execution_id
Task execution ID.

Optional arguments:

-h, --help
show this help message and exit

mistral action-execution-update

usage: mistral action-execution-update [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--noindent] [--prefix PREFIX]
                                       [--state {IDLE,RUNNING,SUCCESS,ERROR}]
                                       [--output OUTPUT]
                                       id

Update specific Action execution.

Positional arguments:

id
Action execution ID.

Optional arguments:

-h, --help
show this help message and exit
--state {IDLE,RUNNING,SUCCESS,ERROR}
Action execution state
--output OUTPUT
Action execution output

mistral action-get

usage: mistral action-get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                          [--max-width <integer>] [--noindent]
                          [--prefix PREFIX]
                          name

Show specific action.

Positional arguments:

name
Action name

Optional arguments:

-h, --help
show this help message and exit

mistral action-get-definition

usage: mistral action-get-definition [-h] name

Show action definition.

Positional arguments:

name
Action name

Optional arguments:

-h, --help
show this help message and exit

mistral action-list

usage: mistral action-list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                           [--max-width <integer>] [--noindent]
                           [--quote {all,minimal,none,nonnumeric}]

List all actions.

Optional arguments:

-h, --help
show this help message and exit

mistral action-update

usage: mistral action-update [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--max-width <integer>] [--noindent]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--public]
                             definition

Update action.

Positional arguments:

definition
Action definition file

Optional arguments:

-h, --help
show this help message and exit
--public
With this flag action will be marked as “public”.

mistral cron-trigger-create

usage: mistral cron-trigger-create [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--noindent] [--prefix PREFIX]
                                   [--params PARAMS] [--pattern <* * * * *>]
                                   [--first-time <YYYY-MM-DD HH:MM>]
                                   [--count <integer>]
                                   name workflow_identifier [workflow_input]

Create new trigger.

Positional arguments:

name
Cron trigger name
workflow_identifier
Workflow name or ID
workflow_input
Workflow input

Optional arguments:

-h, --help
show this help message and exit
--params PARAMS
Workflow params
--pattern <* * * * *>
Cron trigger pattern
--first-time <YYYY-MM-DD HH:MM>
Date and time of the first execution
--count <integer>
Number of wanted executions

mistral cron-trigger-delete

usage: mistral cron-trigger-delete [-h] name [name ...]

Delete trigger.

Positional arguments:

name
Name of cron trigger(s).

Optional arguments:

-h, --help
show this help message and exit

mistral cron-trigger-get

usage: mistral cron-trigger-get [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--noindent] [--prefix PREFIX]
                                name

Show specific cron trigger.

Positional arguments:

name
Cron trigger name

Optional arguments:

-h, --help
show this help message and exit

mistral cron-trigger-list

usage: mistral cron-trigger-list [-h] [-f {csv,json,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--noindent]
                                 [--quote {all,minimal,none,nonnumeric}]

List all cron triggers.

Optional arguments:

-h, --help
show this help message and exit

mistral environment-create

usage: mistral environment-create [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--noindent] [--prefix PREFIX]
                                  file

Create new environment.

Positional arguments:

file
Environment configuration file in JSON or YAML

Optional arguments:

-h, --help
show this help message and exit

mistral environment-delete

usage: mistral environment-delete [-h] name [name ...]

Delete environment.

Positional arguments:

name
Name of environment(s).

Optional arguments:

-h, --help
show this help message and exit

mistral environment-get

usage: mistral environment-get [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--noindent] [--prefix PREFIX]
                               name

Show specific environment.

Positional arguments:

name
Environment name

Optional arguments:

-h, --help
show this help message and exit

mistral environment-list

usage: mistral environment-list [-h] [-f {csv,json,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--noindent]
                                [--quote {all,minimal,none,nonnumeric}]

List all environments.

Optional arguments:

-h, --help
show this help message and exit

mistral environment-update

usage: mistral environment-update [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--noindent] [--prefix PREFIX]
                                  file

Update environment.

Positional arguments:

file
Environment configuration file in JSON or YAML

Optional arguments:

-h, --help
show this help message and exit

mistral execution-create

usage: mistral execution-create [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--noindent] [--prefix PREFIX]
                                [-d DESCRIPTION]
                                workflow_identifier [workflow_input] [params]

Create new execution.

Positional arguments:

workflow_identifier
Workflow ID or name. Workflow name will be deprecated sinceMitaka.
workflow_input
Workflow input
params
Workflow additional parameters

Optional arguments:

-h, --help
show this help message and exit
-d DESCRIPTION, --description DESCRIPTION
Execution description

mistral execution-delete

usage: mistral execution-delete [-h] id [id ...]

Delete execution.

Positional arguments:

id
Id of execution identifier(s).

Optional arguments:

-h, --help
show this help message and exit

mistral execution-get

usage: mistral execution-get [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--noindent]
                             [--prefix PREFIX]
                             id

Show specific execution.

Positional arguments:

id
Execution identifier

Optional arguments:

-h, --help
show this help message and exit

mistral execution-get-input

usage: mistral execution-get-input [-h] id

Show execution input data.

Positional arguments:

id
Execution ID

Optional arguments:

-h, --help
show this help message and exit

mistral execution-get-output

usage: mistral execution-get-output [-h] id

Show execution output data.

Positional arguments:

id
Execution ID

Optional arguments:

-h, --help
show this help message and exit

mistral execution-list

usage: mistral execution-list [-h] [-f {csv,json,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>] [--noindent]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--marker [MARKER]] [--limit [LIMIT]]
                              [--sort_keys [SORT_KEYS]]
                              [--sort_dirs [SORT_DIRS]]

List all executions.

Optional arguments:

-h, --help
show this help message and exit
--marker [MARKER]
The last execution uuid of the previous page, displays list of executions after “marker”.
--limit [LIMIT]
Maximum number of executions to return in a single result.
--sort_keys [SORT_KEYS]
Comma-separated list of sort keys to sort results by. Default: created_at. Example: mistral execution-list --sort_keys=id,description
--sort_dirs [SORT_DIRS]
Comma-separated list of sort directions. Default: asc. Example: mistral execution-list --sort_keys=id,description --sort_dirs=asc,desc

mistral execution-update

usage: mistral execution-update [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--noindent] [--prefix PREFIX]
                                [-s {RUNNING,PAUSED,SUCCESS,ERROR}] [-e ENV]
                                [-d DESCRIPTION]
                                id

Update execution.

Positional arguments:

id
Execution identifier

Optional arguments:

-h, --help
show this help message and exit
-s {RUNNING,PAUSED,SUCCESS,ERROR}, --state {RUNNING,PAUSED,SUCCESS,ERROR}
Execution state
-e ENV, --env ENV
Environment variables
-d DESCRIPTION, --description DESCRIPTION
Execution description

mistral member-create

usage: mistral member-create [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--noindent]
                             [--prefix PREFIX]
                             resource_id resource_type member_id

Shares a resource to another tenant.

Positional arguments:

resource_id
Resource ID to be shared.
resource_type
Resource type.
member_id
Project ID to whom the resource is shared to.

Optional arguments:

-h, --help
show this help message and exit

mistral member-delete

usage: mistral member-delete [-h] resource_id resource_type member_id

Delete a resource sharing relationship.

Positional arguments:

resource_id
Resource ID to be shared.
resource_type
Resource type.
member_id
Project ID to whom the resource is shared to.

Optional arguments:

-h, --help
show this help message and exit

mistral member-get

usage: mistral member-get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                          [--max-width <integer>] [--noindent]
                          [--prefix PREFIX] [-m MEMBER_ID]
                          resource_id resource_type

Show specific member information.

Positional arguments:

resource_id
Resource ID to be shared.
resource_type
Resource type.

Optional arguments:

-h, --help
show this help message and exit
-m MEMBER_ID, --member-id MEMBER_ID
Project ID to whom the resource is shared to. No need to provide this param if you are the resource member.

mistral member-list

usage: mistral member-list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                           [--max-width <integer>] [--noindent]
                           [--quote {all,minimal,none,nonnumeric}]
                           resource_id resource_type

List all members.

Positional arguments:

resource_id
Resource id to be shared.
resource_type
Resource type.

Optional arguments:

-h, --help
show this help message and exit

mistral member-update

usage: mistral member-update [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--noindent]
                             [--prefix PREFIX] [-m MEMBER_ID]
                             [-s {pending,accepted,rejected}]
                             resource_id resource_type

Update resource sharing status.

Positional arguments:

resource_id
Resource ID to be shared.
resource_type
Resource type.

Optional arguments:

-h, --help
show this help message and exit
-m MEMBER_ID, --member-id MEMBER_ID
Project ID to whom the resource is shared to. No need to provide this param if you are the resource member.
-s {pending,accepted,rejected}, --status {pending,accepted,rejected}
status of the sharing.

mistral run-action

usage: mistral run-action [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                          [--max-width <integer>] [--noindent]
                          [--prefix PREFIX] [-s] [-t TARGET]
                          name [input]

Create new Action execution or just run specific action.

Positional arguments:

name
Action name to execute.
input
Action input.

Optional arguments:

-h, --help
show this help message and exit
-s, --save-result
Save the result into DB.
-t TARGET, --target TARGET
Action will be executed on <target> executor.

mistral service-list

usage: mistral service-list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                            [--max-width <integer>] [--noindent]
                            [--quote {all,minimal,none,nonnumeric}]

List all services.

Optional arguments:

-h, --help
show this help message and exit

mistral task-get

usage: mistral task-get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                        [--max-width <integer>] [--noindent] [--prefix PREFIX]
                        id

Show specific task.

Positional arguments:

id
Task identifier

Optional arguments:

-h, --help
show this help message and exit

mistral task-get-published

usage: mistral task-get-published [-h] id

Show task published variables.

Positional arguments:

id
Task ID

Optional arguments:

-h, --help
show this help message and exit

mistral task-get-result

usage: mistral task-get-result [-h] id

Show task output data.

Positional arguments:

id
Task ID

Optional arguments:

-h, --help
show this help message and exit

mistral task-list

usage: mistral task-list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                         [--max-width <integer>] [--noindent]
                         [--quote {all,minimal,none,nonnumeric}]
                         [workflow_execution]

List all tasks.

Positional arguments:

workflow_execution
Workflow execution ID associated with list of Tasks.

Optional arguments:

-h, --help
show this help message and exit

mistral task-rerun

usage: mistral task-rerun [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                          [--max-width <integer>] [--noindent]
                          [--prefix PREFIX] [--resume] [-e ENV]
                          id

Rerun an existing task.

Positional arguments:

id
Task identifier

Optional arguments:

-h, --help
show this help message and exit
--resume
rerun only failed or unstarted action executions for with-items task
-e ENV, --env ENV
Environment variables

mistral workbook-create

usage: mistral workbook-create [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--noindent] [--prefix PREFIX]
                               definition

Create new workbook.

Positional arguments:

definition
Workbook definition file

Optional arguments:

-h, --help
show this help message and exit

mistral workbook-delete

usage: mistral workbook-delete [-h] name [name ...]

Delete workbook.

Positional arguments:

name
Name of workbook(s).

Optional arguments:

-h, --help
show this help message and exit

mistral workbook-get

usage: mistral workbook-get [-h] [-f {json,shell,table,value,yaml}]
                            [-c COLUMN] [--max-width <integer>] [--noindent]
                            [--prefix PREFIX]
                            name

Show specific workbook.

Positional arguments:

name
Workbook name

Optional arguments:

-h, --help
show this help message and exit

mistral workbook-get-definition

usage: mistral workbook-get-definition [-h] name

Show workbook definition.

Positional arguments:

name
Workbook name

Optional arguments:

-h, --help
show this help message and exit

mistral workbook-list

usage: mistral workbook-list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--max-width <integer>] [--noindent]
                             [--quote {all,minimal,none,nonnumeric}]

List all workbooks.

Optional arguments:

-h, --help
show this help message and exit

mistral workbook-update

usage: mistral workbook-update [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--noindent] [--prefix PREFIX]
                               definition

Update workbook.

Positional arguments:

definition
Workbook definition file

Optional arguments:

-h, --help
show this help message and exit

mistral workbook-validate

usage: mistral workbook-validate [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--noindent] [--prefix PREFIX]
                                 definition

Validate workbook.

Positional arguments:

definition
Workbook definition file

Optional arguments:

-h, --help
show this help message and exit

mistral workflow-create

usage: mistral workflow-create [-h] [-f {csv,json,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--noindent]
                               [--quote {all,minimal,none,nonnumeric}]
                               [--public]
                               definition

Create new workflow.

Positional arguments:

definition
Workflow definition file.

Optional arguments:

-h, --help
show this help message and exit
--public
With this flag workflow will be marked as “public”.

mistral workflow-delete

usage: mistral workflow-delete [-h] identifier [identifier ...]

Delete workflow.

Positional arguments:

identifier
Name or ID of workflow(s).

Optional arguments:

-h, --help
show this help message and exit

mistral workflow-get

usage: mistral workflow-get [-h] [-f {json,shell,table,value,yaml}]
                            [-c COLUMN] [--max-width <integer>] [--noindent]
                            [--prefix PREFIX]
                            identifier

Show specific workflow.

Positional arguments:

identifier
Workflow ID or name.

Optional arguments:

-h, --help
show this help message and exit

mistral workflow-get-definition

usage: mistral workflow-get-definition [-h] identifier

Show workflow definition.

Positional arguments:

identifier
Workflow ID or name.

Optional arguments:

-h, --help
show this help message and exit

mistral workflow-list

usage: mistral workflow-list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--max-width <integer>] [--noindent]
                             [--quote {all,minimal,none,nonnumeric}]

List all workflows.

Optional arguments:

-h, --help
show this help message and exit

mistral workflow-update

usage: mistral workflow-update [-h] [-f {csv,json,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--noindent]
                               [--quote {all,minimal,none,nonnumeric}]
                               [--id ID] [--public]
                               definition

Update workflow.

Positional arguments:

definition
Workflow definition

Optional arguments:

-h, --help
show this help message and exit
--id ID
Workflow ID.
--public
With this flag workflow will be marked as “public”.

mistral workflow-validate

usage: mistral workflow-validate [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--noindent] [--prefix PREFIX]
                                 definition

Validate workflow.

Positional arguments:

definition
Workflow definition file

Optional arguments:

-h, --help
show this help message and exit
Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.

Contents