The mistral client is the command-line interface (CLI) for the Workflow service API and its extensions. This chapter documents mistral version 0.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-cacert CACERT]

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

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. definition Action definition file -h, --help show this help message and exit --public With this flag action will be marked as "public".

usage: mistral action-delete [-h] name [name ...] Delete action. name Name of action(s). -h, --help show this help message and exit

usage: mistral action-execution-delete [-h] id [id ...] Delete action execution. id Id of action execution identifier(s). -h, --help show this help message and exit

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. id Action execution ID. -h, --help show this help message and exit

usage: mistral action-execution-get-input [-h] id Show Action execution input data. id Action execution ID. -h, --help show this help message and exit

usage: mistral action-execution-get-output [-h] id Show Action execution output data. id Action execution ID. -h, --help show this help message and exit

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. task_execution_id Task execution ID. -h, --help show this help message and exit

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. id Action execution ID. -h, --help show this help message and exit --state {IDLE,RUNNING,SUCCESS,ERROR} Action execution state --output OUTPUT Action execution output

usage: mistral action-get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] name Show specific action. name Action name -h, --help show this help message and exit

usage: mistral action-get-definition [-h] name Show action definition. name Action name -h, --help show this help message and exit

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. -h, --help show this help message and exit

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. definition Action definition file -h, --help show this help message and exit --public With this flag action will be marked as "public".

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_name [workflow_input] Create new trigger. name Cron trigger name workflow_name Workflow name workflow_input Workflow input -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

usage: mistral cron-trigger-delete [-h] name [name ...] Delete trigger. name Name of cron trigger(s). -h, --help show this help message and exit

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. name Cron trigger name -h, --help show this help message and exit

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. -h, --help show this help message and exit

usage: mistral environment-create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] file Create new environment. file Environment configuration file in JSON or YAML -h, --help show this help message and exit

usage: mistral environment-delete [-h] name [name ...] Delete environment. name Name of environment(s). -h, --help show this help message and exit

usage: mistral environment-get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] name Show specific environment. name Environment name -h, --help show this help message and exit

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. -h, --help show this help message and exit

usage: mistral environment-update [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] file Update environment. file Environment configuration file in JSON or YAML -h, --help show this help message and exit

usage: mistral execution-create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [-d DESCRIPTION] workflow_name [workflow_input] [params] Create new execution. workflow_name Workflow name workflow_input Workflow input params Workflow additional parameters -h, --help show this help message and exit -d DESCRIPTION, --description DESCRIPTION Execution description

usage: mistral execution-delete [-h] id [id ...] Delete execution. id Id of execution identifier(s). -h, --help show this help message and exit

usage: mistral execution-get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] id Show specific execution. id Execution identifier -h, --help show this help message and exit

usage: mistral execution-get-input [-h] id Show execution input data. id Execution ID -h, --help show this help message and exit

usage: mistral execution-get-output [-h] id Show execution output data. id Execution ID -h, --help show this help message and exit

usage: mistral execution-list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] List all executions. -h, --help show this help message and exit

usage: mistral execution-update [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] (-s {RUNNING,PAUSED,SUCCESS,ERROR} | -d DESCRIPTION) id Update execution. id Execution identifier -h, --help show this help message and exit -s {RUNNING,PAUSED,SUCCESS,ERROR}, --state {RUNNING,PAUSED,SUCCESS,ERROR} Execution state -d DESCRIPTION, --description DESCRIPTION Execution description

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. name Action name to execute. input Action input. -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.

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. -h, --help show this help message and exit

usage: mistral task-get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] id Show specific task. id Task identifier -h, --help show this help message and exit

usage: mistral task-get-published [-h] id Show task published variables. id Task ID -h, --help show this help message and exit

usage: mistral task-get-result [-h] id Show task output data. id Task ID -h, --help show this help message and exit

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. workflow_execution Workflow execution ID associated with list of Tasks. -h, --help show this help message and exit

usage: mistral task-rerun [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--resume] id Rerun an existing task. id Task identifier -h, --help show this help message and exit --resume rerun only failed or unstarted action executions for with-items task

usage: mistral workbook-create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] definition Create new workbook. definition Workbook definition file -h, --help show this help message and exit

usage: mistral workbook-delete [-h] name [name ...] Delete workbook. name Name of workbook(s). -h, --help show this help message and exit

usage: mistral workbook-get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] name Show specific workbook. name Workbook name -h, --help show this help message and exit

usage: mistral workbook-get-definition [-h] name Show workbook definition. name Workbook name -h, --help show this help message and exit

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. -h, --help show this help message and exit

usage: mistral workbook-update [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] definition Update workbook. definition Workbook definition file -h, --help show this help message and exit

usage: mistral workbook-validate [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] definition Validate workbook. definition Workbook definition file -h, --help show this help message and exit

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. definition Workflow definition file -h, --help show this help message and exit --public With this flag workflow will be marked as "public".

usage: mistral workflow-delete [-h] name [name ...] Delete workflow. name Name of workflow(s). -h, --help show this help message and exit

usage: mistral workflow-get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] name Show specific workflow. name Workflow name -h, --help show this help message and exit

usage: mistral workflow-get-definition [-h] name Show workflow definition. name Workflow name -h, --help show this help message and exit

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. -h, --help show this help message and exit

usage: mistral workflow-update [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--public] definition Update workflow. definition Workflow definition -h, --help show this help message and exit --public With this flag workflow will be marked as "public".

usage: mistral workflow-validate [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] definition Validate workflow. definition Workflow definition file -h, --help show this help message and exit