openstack-manuals/doc/cli-reference/generated/ch_cli_mistral_commands.xml
Christian Berendt 5a495454d6 [cli-reference] fix current version of python-mistralclient
'mistral --version' is broken in the release version of
python-mistralclient and will be fixed with
Iaa006fedb4ffacbadbaf3b04923eee868b83ad0b in a newer version. The
correct current version is 1.1.0.

Change-Id: Iff9bffbef531d80d2153100568dad3f9e45b6162
2015-10-13 16:47:19 +02:00

1759 lines
53 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xml:id="mistralclient_commands">
<!-- This file is automatically generated, do not edit -->
<?dbhtml stop-chunking?>
<title>Workflow service command-line client</title>
<para>The <command>mistral</command> client is the command-line
interface (CLI) for the Workflow service API and its extensions.
This chapter documents <command>mistral</command> version
<literal>1.1.0</literal>.
</para>
<para>For help on a specific <command>mistral</command>
command, enter:
</para>
<screen><prompt>$</prompt> <userinput><command>mistral</command> <option>help</option> <replaceable>COMMAND</replaceable></userinput></screen>
<section xml:id="mistralclient_command_usage">
<title>mistral usage</title>
<screen><computeroutput>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]</computeroutput></screen>
</section>
<section xml:id="mistralclient_command_optional">
<title>mistral optional arguments</title>
<variablelist wordsize="10">
<varlistentry>
<term><command>--version</command></term>
<listitem>
<para>
Show program's version number and exit.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-v, --verbose</command></term>
<listitem>
<para>
Increase verbosity of output. Can be repeated.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--log-file LOG_FILE</command></term>
<listitem>
<para>
Specify a file to log output. Disabled by
default.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-q, --quiet</command></term>
<listitem>
<para>
Suppress output except warnings and errors.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
Show this help message and exit.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--debug</command></term>
<listitem>
<para>
Show tracebacks on errors.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-mistral-url MISTRAL_URL</command></term>
<listitem>
<para>
Mistral API host (Env: OS_MISTRAL_URL)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-mistral-version MISTRAL_VERSION</command></term>
<listitem>
<para>
Mistral API version (default = v2) (Env:
OS_MISTRAL_VERSION)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-mistral-service-type SERVICE_TYPE</command></term>
<listitem>
<para>
Mistral service-type (should be the same name
as in keystone-endpoint) (default =
workflowv2) (Env: OS_MISTRAL_SERVICE_TYPE)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-mistral-endpoint-type ENDPOINT_TYPE</command></term>
<listitem>
<para>
Mistral endpoint-type (should be the same name
as in keystone-endpoint) (default = publicURL)
(Env: OS_MISTRAL_ENDPOINT_TYPE)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-username USERNAME</command></term>
<listitem>
<para>
Authentication username (Env: OS_USERNAME)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-password PASSWORD</command></term>
<listitem>
<para>
Authentication password (Env: OS_PASSWORD)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-tenant-id TENANT_ID</command></term>
<listitem>
<para>
Authentication tenant identifier (Env:
OS_TENANT_ID)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-tenant-name TENANT_NAME</command></term>
<listitem>
<para>
Authentication tenant name (Env:
OS_TENANT_NAME)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-auth-token TOKEN</command></term>
<listitem>
<para>
Authentication token (Env: OS_AUTH_TOKEN)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-auth-url AUTH_URL</command></term>
<listitem>
<para>
Authentication URL (Env: OS_AUTH_URL)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-cacert CACERT</command></term>
<listitem>
<para>
Authentication CA Certificate (Env: OS_CACERT)
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_action-create">
<title>mistral action-create</title>
<screen><computeroutput>usage: mistral action-create [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--public]
definition</computeroutput></screen>
<para>
Create new action.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>definition</command></term>
<listitem>
<para>
Action definition file
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--public</command></term>
<listitem>
<para>
With this flag action will be marked as "public".
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_action-delete">
<title>mistral action-delete</title>
<screen><computeroutput>usage: mistral action-delete [-h] name [name ...]</computeroutput></screen>
<para>
Delete action.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>name</command></term>
<listitem>
<para>
Name of action(s).
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_action-execution-delete">
<title>mistral action-execution-delete</title>
<screen><computeroutput>usage: mistral action-execution-delete [-h] id [id ...]</computeroutput></screen>
<para>
Delete action execution.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>id</command></term>
<listitem>
<para>
Id of action execution identifier(s).
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_action-execution-get">
<title>mistral action-execution-get</title>
<screen><computeroutput>usage: mistral action-execution-get [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--noindent] [--prefix PREFIX]
id</computeroutput></screen>
<para>
Show specific Action execution.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>id</command></term>
<listitem>
<para>
Action execution ID.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_action-execution-get-input">
<title>mistral action-execution-get-input</title>
<screen><computeroutput>usage: mistral action-execution-get-input [-h] id</computeroutput></screen>
<para>
Show Action execution input data.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>id</command></term>
<listitem>
<para>
Action execution ID.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_action-execution-get-output">
<title>mistral action-execution-get-output</title>
<screen><computeroutput>usage: mistral action-execution-get-output [-h] id</computeroutput></screen>
<para>
Show Action execution output data.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>id</command></term>
<listitem>
<para>
Action execution ID.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_action-execution-list">
<title>mistral action-execution-list</title>
<screen><computeroutput>usage: mistral action-execution-list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[task_execution_id]</computeroutput></screen>
<para>
List all Action executions.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>task_execution_id</command></term>
<listitem>
<para>
Task execution ID.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_action-execution-update">
<title>mistral action-execution-update</title>
<screen><computeroutput>usage: mistral action-execution-update [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--noindent] [--prefix PREFIX]
[--state {IDLE,RUNNING,SUCCESS,ERROR}]
[--output OUTPUT]
id</computeroutput></screen>
<para>
Update specific Action execution.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>id</command></term>
<listitem>
<para>
Action execution ID.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--state {IDLE,RUNNING,SUCCESS,ERROR}</command></term>
<listitem>
<para>
Action execution state
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--output OUTPUT</command></term>
<listitem>
<para>
Action execution output
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_action-get">
<title>mistral action-get</title>
<screen><computeroutput>usage: mistral action-get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--noindent]
[--prefix PREFIX]
name</computeroutput></screen>
<para>
Show specific action.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>name</command></term>
<listitem>
<para>
Action name
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_action-get-definition">
<title>mistral action-get-definition</title>
<screen><computeroutput>usage: mistral action-get-definition [-h] name</computeroutput></screen>
<para>
Show action definition.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>name</command></term>
<listitem>
<para>
Action name
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_action-list">
<title>mistral action-list</title>
<screen><computeroutput>usage: mistral action-list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--noindent]
[--quote {all,minimal,none,nonnumeric}]</computeroutput></screen>
<para>
List all actions.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_action-update">
<title>mistral action-update</title>
<screen><computeroutput>usage: mistral action-update [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--public]
definition</computeroutput></screen>
<para>
Update action.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>definition</command></term>
<listitem>
<para>
Action definition file
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--public</command></term>
<listitem>
<para>
With this flag action will be marked as "public".
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_cron-trigger-create">
<title>mistral cron-trigger-create</title>
<screen><computeroutput>usage: mistral cron-trigger-create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--noindent] [--prefix PREFIX]
[--params PARAMS] [--pattern &lt;* * * * *&gt;]
[--first-time &lt;YYYY-MM-DD HH:MM&gt;]
[--count &lt;integer&gt;]
name workflow_name [workflow_input]</computeroutput></screen>
<para>
Create new trigger.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>name</command></term>
<listitem>
<para>
Cron trigger name
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>workflow_name</command></term>
<listitem>
<para>
Workflow name
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>workflow_input</command></term>
<listitem>
<para>
Workflow input
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--params PARAMS</command></term>
<listitem>
<para>
Workflow params
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--pattern &lt;* * * * *&gt;</command></term>
<listitem>
<para>
Cron trigger pattern
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--first-time &lt;YYYY-MM-DD HH:MM&gt;</command></term>
<listitem>
<para>
Date and time of the first execution
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--count &lt;integer&gt;</command></term>
<listitem>
<para>
Number of wanted executions
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_cron-trigger-delete">
<title>mistral cron-trigger-delete</title>
<screen><computeroutput>usage: mistral cron-trigger-delete [-h] name [name ...]</computeroutput></screen>
<para>
Delete trigger.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>name</command></term>
<listitem>
<para>
Name of cron trigger(s).
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_cron-trigger-get">
<title>mistral cron-trigger-get</title>
<screen><computeroutput>usage: mistral cron-trigger-get [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--noindent] [--prefix PREFIX]
name</computeroutput></screen>
<para>
Show specific cron trigger.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>name</command></term>
<listitem>
<para>
Cron trigger name
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_cron-trigger-list">
<title>mistral cron-trigger-list</title>
<screen><computeroutput>usage: mistral cron-trigger-list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]</computeroutput></screen>
<para>
List all cron triggers.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_environment-create">
<title>mistral environment-create</title>
<screen><computeroutput>usage: mistral environment-create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--noindent] [--prefix PREFIX]
file</computeroutput></screen>
<para>
Create new environment.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>file</command></term>
<listitem>
<para>
Environment configuration file in JSON or YAML
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_environment-delete">
<title>mistral environment-delete</title>
<screen><computeroutput>usage: mistral environment-delete [-h] name [name ...]</computeroutput></screen>
<para>
Delete environment.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>name</command></term>
<listitem>
<para>
Name of environment(s).
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_environment-get">
<title>mistral environment-get</title>
<screen><computeroutput>usage: mistral environment-get [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--noindent] [--prefix PREFIX]
name</computeroutput></screen>
<para>
Show specific environment.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>name</command></term>
<listitem>
<para>
Environment name
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_environment-list">
<title>mistral environment-list</title>
<screen><computeroutput>usage: mistral environment-list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]</computeroutput></screen>
<para>
List all environments.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_environment-update">
<title>mistral environment-update</title>
<screen><computeroutput>usage: mistral environment-update [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--noindent] [--prefix PREFIX]
file</computeroutput></screen>
<para>
Update environment.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>file</command></term>
<listitem>
<para>
Environment configuration file in JSON or YAML
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_execution-create">
<title>mistral execution-create</title>
<screen><computeroutput>usage: mistral execution-create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--noindent] [--prefix PREFIX]
[-d DESCRIPTION]
workflow_name [workflow_input] [params]</computeroutput></screen>
<para>
Create new execution.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>workflow_name</command></term>
<listitem>
<para>
Workflow name
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>workflow_input</command></term>
<listitem>
<para>
Workflow input
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>params</command></term>
<listitem>
<para>
Workflow additional parameters
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-d DESCRIPTION, --description DESCRIPTION</command></term>
<listitem>
<para>
Execution description
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_execution-delete">
<title>mistral execution-delete</title>
<screen><computeroutput>usage: mistral execution-delete [-h] id [id ...]</computeroutput></screen>
<para>
Delete execution.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>id</command></term>
<listitem>
<para>
Id of execution identifier(s).
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_execution-get">
<title>mistral execution-get</title>
<screen><computeroutput>usage: mistral execution-get [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;] [--noindent]
[--prefix PREFIX]
id</computeroutput></screen>
<para>
Show specific execution.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>id</command></term>
<listitem>
<para>
Execution identifier
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_execution-get-input">
<title>mistral execution-get-input</title>
<screen><computeroutput>usage: mistral execution-get-input [-h] id</computeroutput></screen>
<para>
Show execution input data.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>id</command></term>
<listitem>
<para>
Execution ID
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_execution-get-output">
<title>mistral execution-get-output</title>
<screen><computeroutput>usage: mistral execution-get-output [-h] id</computeroutput></screen>
<para>
Show execution output data.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>id</command></term>
<listitem>
<para>
Execution ID
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_execution-list">
<title>mistral execution-list</title>
<screen><computeroutput>usage: mistral execution-list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;] [--noindent]
[--quote {all,minimal,none,nonnumeric}]</computeroutput></screen>
<para>
List all executions.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_execution-update">
<title>mistral execution-update</title>
<screen><computeroutput>usage: mistral execution-update [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--noindent] [--prefix PREFIX]
(-s {RUNNING,PAUSED,SUCCESS,ERROR} | -d DESCRIPTION)
id</computeroutput></screen>
<para>
Update execution.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>id</command></term>
<listitem>
<para>
Execution identifier
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-s {RUNNING,PAUSED,SUCCESS,ERROR}, --state {RUNNING,PAUSED,SUCCESS,ERROR}</command></term>
<listitem>
<para>
Execution state
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-d DESCRIPTION, --description DESCRIPTION</command></term>
<listitem>
<para>
Execution description
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_run-action">
<title>mistral run-action</title>
<screen><computeroutput>usage: mistral run-action [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--noindent]
[--prefix PREFIX] [-s] [-t TARGET]
name [input]</computeroutput></screen>
<para>
Create new Action execution or just run specific action.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>name</command></term>
<listitem>
<para>
Action name to execute.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>input</command></term>
<listitem>
<para>
Action input.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-s, --save-result</command></term>
<listitem>
<para>
Save the result into DB.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-t TARGET, --target TARGET</command></term>
<listitem>
<para>
Action will be executed on &lt;target&gt; executor.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_service-list">
<title>mistral service-list</title>
<screen><computeroutput>usage: mistral service-list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--noindent]
[--quote {all,minimal,none,nonnumeric}]</computeroutput></screen>
<para>
List all services.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_task-get">
<title>mistral task-get</title>
<screen><computeroutput>usage: mistral task-get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--noindent] [--prefix PREFIX]
id</computeroutput></screen>
<para>
Show specific task.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>id</command></term>
<listitem>
<para>
Task identifier
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_task-get-published">
<title>mistral task-get-published</title>
<screen><computeroutput>usage: mistral task-get-published [-h] id</computeroutput></screen>
<para>
Show task published variables.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>id</command></term>
<listitem>
<para>
Task ID
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_task-get-result">
<title>mistral task-get-result</title>
<screen><computeroutput>usage: mistral task-get-result [-h] id</computeroutput></screen>
<para>
Show task output data.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>id</command></term>
<listitem>
<para>
Task ID
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_task-list">
<title>mistral task-list</title>
<screen><computeroutput>usage: mistral task-list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[workflow_execution]</computeroutput></screen>
<para>
List all tasks.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>workflow_execution</command></term>
<listitem>
<para>
Workflow execution ID associated with list of Tasks.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_task-rerun">
<title>mistral task-rerun</title>
<screen><computeroutput>usage: mistral task-rerun [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--noindent]
[--prefix PREFIX] [--resume]
id</computeroutput></screen>
<para>
Rerun an existing task.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>id</command></term>
<listitem>
<para>
Task identifier
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--resume</command></term>
<listitem>
<para>
rerun only failed or unstarted action executions for
with-items task
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_workbook-create">
<title>mistral workbook-create</title>
<screen><computeroutput>usage: mistral workbook-create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--noindent] [--prefix PREFIX]
definition</computeroutput></screen>
<para>
Create new workbook.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>definition</command></term>
<listitem>
<para>
Workbook definition file
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_workbook-delete">
<title>mistral workbook-delete</title>
<screen><computeroutput>usage: mistral workbook-delete [-h] name [name ...]</computeroutput></screen>
<para>
Delete workbook.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>name</command></term>
<listitem>
<para>
Name of workbook(s).
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_workbook-get">
<title>mistral workbook-get</title>
<screen><computeroutput>usage: mistral workbook-get [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;] [--noindent]
[--prefix PREFIX]
name</computeroutput></screen>
<para>
Show specific workbook.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>name</command></term>
<listitem>
<para>
Workbook name
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_workbook-get-definition">
<title>mistral workbook-get-definition</title>
<screen><computeroutput>usage: mistral workbook-get-definition [-h] name</computeroutput></screen>
<para>
Show workbook definition.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>name</command></term>
<listitem>
<para>
Workbook name
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_workbook-list">
<title>mistral workbook-list</title>
<screen><computeroutput>usage: mistral workbook-list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--noindent]
[--quote {all,minimal,none,nonnumeric}]</computeroutput></screen>
<para>
List all workbooks.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_workbook-update">
<title>mistral workbook-update</title>
<screen><computeroutput>usage: mistral workbook-update [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--noindent] [--prefix PREFIX]
definition</computeroutput></screen>
<para>
Update workbook.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>definition</command></term>
<listitem>
<para>
Workbook definition file
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_workbook-validate">
<title>mistral workbook-validate</title>
<screen><computeroutput>usage: mistral workbook-validate [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--noindent] [--prefix PREFIX]
definition</computeroutput></screen>
<para>
Validate workbook.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>definition</command></term>
<listitem>
<para>
Workbook definition file
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_workflow-create">
<title>mistral workflow-create</title>
<screen><computeroutput>usage: mistral workflow-create [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--public]
definition</computeroutput></screen>
<para>
Create new workflow.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>definition</command></term>
<listitem>
<para>
Workflow definition file
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--public</command></term>
<listitem>
<para>
With this flag workflow will be marked as "public".
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_workflow-delete">
<title>mistral workflow-delete</title>
<screen><computeroutput>usage: mistral workflow-delete [-h] name [name ...]</computeroutput></screen>
<para>
Delete workflow.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>name</command></term>
<listitem>
<para>
Name of workflow(s).
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_workflow-get">
<title>mistral workflow-get</title>
<screen><computeroutput>usage: mistral workflow-get [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;] [--noindent]
[--prefix PREFIX]
name</computeroutput></screen>
<para>
Show specific workflow.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>name</command></term>
<listitem>
<para>
Workflow name
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_workflow-get-definition">
<title>mistral workflow-get-definition</title>
<screen><computeroutput>usage: mistral workflow-get-definition [-h] name</computeroutput></screen>
<para>
Show workflow definition.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>name</command></term>
<listitem>
<para>
Workflow name
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_workflow-list">
<title>mistral workflow-list</title>
<screen><computeroutput>usage: mistral workflow-list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--noindent]
[--quote {all,minimal,none,nonnumeric}]</computeroutput></screen>
<para>
List all workflows.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_workflow-update">
<title>mistral workflow-update</title>
<screen><computeroutput>usage: mistral workflow-update [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--public]
definition</computeroutput></screen>
<para>
Update workflow.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>definition</command></term>
<listitem>
<para>
Workflow definition
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--public</command></term>
<listitem>
<para>
With this flag workflow will be marked as "public".
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="mistralclient_subcommand_workflow-validate">
<title>mistral workflow-validate</title>
<screen><computeroutput>usage: mistral workflow-validate [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--noindent] [--prefix PREFIX]
definition</computeroutput></screen>
<para>
Validate workflow.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>definition</command></term>
<listitem>
<para>
Workflow definition file
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
</chapter>