The mistral client is the command-line interface (CLI) for the Workflow service API and its extensions.
This chapter documents mistral version 2.1.1
.
For help on a specific mistral command, enter:
$ mistral help COMMAND
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-cert OS_CERT] [--os-key OS_KEY] [--os-cacert OS_CACERT]
[--insecure] [--auth-type AUTH_TYPE]
[--openid-client-id CLIENT_ID]
[--openid-client-secret CLIENT_SECRET]
[--os-target-username TARGET_USERNAME]
[--os-target-password TARGET_PASSWORD]
[--os-target-tenant-id TARGET_TENANT_ID]
[--os-target-tenant-name TARGET_TENANT_NAME]
[--os-target-auth-token TARGET_TOKEN]
[--os-target-auth-url TARGET_AUTH_URL]
[--os-target_cacert TARGET_CACERT] [--target_insecure]
[--profile HMAC_KEY]
--version
-v, --verbose
--log-file LOG_FILE
-q, --quiet
-h, --help
--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-cert OS_CERT
--os-key OS_KEY
--os-cacert OS_CACERT
--insecure
--auth-type AUTH_TYPE
--openid-client-id CLIENT_ID
--openid-client-secret CLIENT_SECRET
--os-target-username TARGET_USERNAME
--os-target-password TARGET_PASSWORD
--os-target-tenant-id TARGET_TENANT_ID
--os-target-tenant-name TARGET_TENANT_NAME
--os-target-auth-token TARGET_TOKEN
--os-target-auth-url TARGET_AUTH_URL
--os-target_cacert TARGET_CACERT
--target_insecure
--profile HMAC_KEY
usage: mistral action-create [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--public]
definition
Create new action.
Positional arguments:
definition
Optional arguments:
-h, --help
--public
usage: mistral action-delete [-h] action [action ...]
Delete action.
Positional arguments:
action
Optional arguments:
-h, --help
usage: mistral action-execution-delete [-h]
action_execution [action_execution ...]
Delete action execution.
Positional arguments:
action_execution
Optional arguments:
-h, --help
usage: mistral action-execution-get [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
action_execution
Show specific Action execution.
Positional arguments:
action_execution
Optional arguments:
-h, --help
usage: mistral action-execution-get-input [-h] id
Show Action execution input data.
Positional arguments:
id
Optional arguments:
-h, --help
usage: mistral action-execution-get-output [-h] id
Show Action execution output data.
Positional arguments:
id
Optional arguments:
-h, --help
usage: mistral action-execution-list [-h]
[-f {csv,html,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
Optional arguments:
-h, --help
usage: mistral action-execution-update [-h]
[-f {html,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
Optional arguments:
-h, --help
--state {IDLE,RUNNING,SUCCESS,ERROR}
--output OUTPUT
usage: mistral action-get [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
action
Show specific action.
Positional arguments:
action
Optional arguments:
-h, --help
usage: mistral action-get-definition [-h] name
Show action definition.
Positional arguments:
name
Optional arguments:
-h, --help
usage: mistral action-list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
List all actions.
Optional arguments:
-h, --help
usage: mistral action-update [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}] [--id ID]
[--public]
definition
Update action.
Positional arguments:
definition
Optional arguments:
-h, --help
--id ID
--public
usage: mistral action-validate [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
definition
Validate action.
Positional arguments:
definition
Optional arguments:
-h, --help
usage: mistral cron-trigger-create [-h]
[-f {html,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
workflow_identifier
workflow_input
Optional arguments:
-h, --help
--params PARAMS
--pattern <* * * * *>
--first-time <YYYY-MM-DD HH:MM>
--count <integer>
usage: mistral cron-trigger-delete [-h] cron_trigger [cron_trigger ...]
Delete trigger.
Positional arguments:
cron_trigger
Optional arguments:
-h, --help
usage: mistral cron-trigger-get [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
cron_trigger
Show specific cron trigger.
Positional arguments:
cron_trigger
Optional arguments:
-h, --help
usage: mistral cron-trigger-list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
List all cron triggers.
Optional arguments:
-h, --help
usage: mistral environment-create [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
file
Create new environment.
Positional arguments:
file
Optional arguments:
-h, --help
usage: mistral environment-delete [-h] environment [environment ...]
Delete environment.
Positional arguments:
environment
Optional arguments:
-h, --help
usage: mistral environment-get [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
environment
Show specific environment.
Positional arguments:
environment
Optional arguments:
-h, --help
usage: mistral environment-list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
List all environments.
Optional arguments:
-h, --help
usage: mistral environment-update [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
file
Update environment.
Positional arguments:
file
Optional arguments:
-h, --help
usage: mistral execution-create [-h] [-f {html,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_input
params
Optional arguments:
-h, --help
-d DESCRIPTION, --description DESCRIPTION
usage: mistral execution-delete [-h] execution [execution ...]
Delete execution.
Positional arguments:
execution
Optional arguments:
-h, --help
usage: mistral execution-get [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
execution
Show specific execution.
Positional arguments:
execution
Optional arguments:
-h, --help
usage: mistral execution-get-input [-h] id
Show execution input data.
Positional arguments:
id
Optional arguments:
-h, --help
usage: mistral execution-get-output [-h] id
Show execution output data.
Positional arguments:
id
Optional arguments:
-h, --help
usage: mistral execution-list [-h] [-f {csv,html,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
--marker [MARKER]
--limit [LIMIT]
--sort_keys [SORT_KEYS]
--sort_keys=id,description
--sort_dirs [SORT_DIRS]
--sort_keys=id,description
--sort_dirs=asc,desc
usage: mistral execution-update [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-s {RUNNING,PAUSED,SUCCESS,ERROR,CANCELLED}]
[-e ENV] [-d DESCRIPTION]
id
Update execution.
Positional arguments:
id
Optional arguments:
-h, --help
-s {RUNNING,PAUSED,SUCCESS,ERROR,CANCELLED}, --state {RUNNING,PAUSED,SUCCESS,ERROR,CANCELLED}
-e ENV, --env ENV
-d DESCRIPTION, --description DESCRIPTION
usage: mistral member-create [-h] [-f {html,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_type
member_id
Optional arguments:
-h, --help
usage: mistral member-delete [-h] resource resource_type member_id
Delete a resource sharing relationship.
Positional arguments:
resource
resource_type
member_id
Optional arguments:
-h, --help
usage: mistral member-get [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [-m MEMBER_ID]
resource resource_type
Show specific member information.
Positional arguments:
resource
resource_type
Optional arguments:
-h, --help
-m MEMBER_ID, --member-id MEMBER_ID
usage: mistral member-list [-h] [-f {csv,html,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_type
Optional arguments:
-h, --help
usage: mistral member-update [-h] [-f {html,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_type
Optional arguments:
-h, --help
-m MEMBER_ID, --member-id MEMBER_ID
-s {pending,accepted,rejected}, --status {pending,accepted,rejected}
usage: mistral run-action [-h] [-f {html,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
input
Optional arguments:
-h, --help
-s, --save-result
-t TARGET, --target TARGET
usage: mistral service-list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
List all services.
Optional arguments:
-h, --help
usage: mistral task-get [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
task
Show specific task.
Positional arguments:
task
Optional arguments:
-h, --help
usage: mistral task-get-published [-h] id
Show task published variables.
Positional arguments:
id
Optional arguments:
-h, --help
usage: mistral task-get-result [-h] id
Show task output data.
Positional arguments:
id
Optional arguments:
-h, --help
usage: mistral task-list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[workflow_execution]
List all tasks.
Positional arguments:
workflow_execution
Optional arguments:
-h, --help
usage: mistral task-rerun [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [--resume] [-e ENV]
id
Rerun an existing task.
Positional arguments:
id
Optional arguments:
-h, --help
--resume
-e ENV, --env ENV
usage: mistral workbook-create [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
definition
Create new workbook.
Positional arguments:
definition
Optional arguments:
-h, --help
usage: mistral workbook-delete [-h] workbook [workbook ...]
Delete workbook.
Positional arguments:
workbook
Optional arguments:
-h, --help
usage: mistral workbook-get [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
workbook
Show specific workbook.
Positional arguments:
workbook
Optional arguments:
-h, --help
usage: mistral workbook-get-definition [-h] name
Show workbook definition.
Positional arguments:
name
Optional arguments:
-h, --help
usage: mistral workbook-list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
List all workbooks.
Optional arguments:
-h, --help
usage: mistral workbook-update [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
definition
Update workbook.
Positional arguments:
definition
Optional arguments:
-h, --help
usage: mistral workbook-validate [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
definition
Validate workbook.
Positional arguments:
definition
Optional arguments:
-h, --help
usage: mistral workflow-create [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--public]
definition
Create new workflow.
Positional arguments:
definition
Optional arguments:
-h, --help
--public
usage: mistral workflow-delete [-h] workflow [workflow ...]
Delete workflow.
Positional arguments:
workflow
Optional arguments:
-h, --help
usage: mistral workflow-get [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
workflow
Show specific workflow.
Positional arguments:
workflow
Optional arguments:
-h, --help
usage: mistral workflow-get-definition [-h] identifier
Show workflow definition.
Positional arguments:
identifier
Optional arguments:
-h, --help
usage: mistral workflow-list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
List all workflows.
Optional arguments:
-h, --help
usage: mistral workflow-update [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--id ID] [--public]
definition
Update workflow.
Positional arguments:
definition
Optional arguments:
-h, --help
--id ID
--public
usage: mistral workflow-validate [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
definition
Validate workflow.
Positional arguments:
definition
Optional arguments:
-h, --help
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.