OS Manuals

/opt/chainguard/openstack-cinder-2026.1/bin/mistral

OpenStack Block Storage (Cinder) — 2026.1 Gazpacho

From openstack-cinder-2026.1 28.0.0_git20261031-r0 (enterprise-packages), captured 2026-11-08 by running mistral --help (exit 0). permalink

/opt/chainguard/openstack-cinder-2026.1/lib/python3.13/site-packages/jsonpath_rw_ext/_string.py:19: SyntaxWarning: invalid escape sequence '\('
  SUB = re.compile("sub\(/(.*)/,\s+(.*)\)")
/opt/chainguard/openstack-cinder-2026.1/lib/python3.13/site-packages/jsonpath_rw_ext/_string.py:20: SyntaxWarning: invalid escape sequence '\('
  SPLIT = re.compile("split\((.),\s+(\d+),\s+(\d+|-1)\)")
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-project-id PROJECT_ID] [--os-tenant-name TENANT_NAME]
               [--os-project-name PROJECT_NAME] [--os-auth-token TOKEN]
               [--os-project-domain-name PROJECT_DOMAIN_NAME]
               [--os-project-domain-id PROJECT_DOMAIN_ID] [--os-user-domain-name USER_DOMAIN_NAME]
               [--os-user-domain-id USER_DOMAIN_ID] [--os-auth-url AUTH_URL] [--os-cert OS_CERT]
               [--os-key OS_KEY] [--os-cacert OS_CACERT] [--os-region-name REGION_NAME]
               [--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]
               [--os-target-region-name TARGET_REGION_NAME]
               [--os-target-user-domain-name TARGET_USER_DOMAIN_NAME]
               [--os-target-user-domain-id TARGET_USER_DOMAIN_ID]
               [--os-target-project-domain-name TARGET_PROJECT_DOMAIN_NAME]
               [--os-target-project-domain-id TARGET_PROJECT_DOMAIN_ID] [--target_insecure]
               [--profile HMAC_KEY]

Command-line interface to the Mistral APIs

Options:
  --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 or
                                OS_PROJECT_ID)
  --os-project-id PROJECT_ID    Authentication project identifier (Env: OS_TENANT_ID or
                                OS_PROJECT_ID), will use tenant_id if both tenant_id and
                                project_id are set
  --os-tenant-name TENANT_NAME  Authentication tenant name (Env: OS_TENANT_NAME or
                                OS_PROJECT_NAME)
  --os-project-name PROJECT_NAME
                                Authentication project name (Env: OS_TENANT_NAME or
                                OS_PROJECT_NAME), will use tenant_name if both tenant_name and
                                project_name are set
  --os-auth-token TOKEN         Authentication token (Env: OS_AUTH_TOKEN)
  --os-project-domain-name PROJECT_DOMAIN_NAME
                                Authentication project domain name or ID (Env:
                                OS_PROJECT_DOMAIN_NAME or OS_PROJECT_DOMAIN_NAME)
  --os-project-domain-id PROJECT_DOMAIN_ID
                                Authentication project domain ID (Env: OS_PROJECT_DOMAIN_ID)
  --os-user-domain-name USER_DOMAIN_NAME
                                Authentication user domain name (Env: OS_USER_DOMAIN_NAME)
  --os-user-domain-id USER_DOMAIN_ID
                                Authentication user domain name (Env: OS_USER_DOMAIN_ID)
  --os-auth-url AUTH_URL        Authentication URL (Env: OS_AUTH_URL)
  --os-cert OS_CERT             Client Certificate (Env: OS_CERT)
  --os-key OS_KEY               Client Key (Env: OS_KEY)
  --os-cacert OS_CACERT         Authentication CA Certificate (Env: OS_CACERT)
  --os-region-name REGION_NAME  Region name (Env: OS_REGION_NAME)
  --insecure                    Disables SSL/TLS certificate verification (Env:
                                MISTRALCLIENT_INSECURE)
  --auth-type AUTH_TYPE         Authentication type. Valid options are: keycloak-oidc, keystone.
                                (Env: MISTRAL_AUTH_TYPE)
  --openid-client-id CLIENT_ID  Client ID (according to OpenID Connect). (Env: OPENID_CLIENT_ID)
  --openid-client-secret CLIENT_SECRET
                                Client secret (according to OpenID Connect) (Env:
                                OPENID_CLIENT_SECRET)
  --os-target-username TARGET_USERNAME
                                Authentication username for target cloud (Env: OS_TARGET_USERNAME)
  --os-target-password TARGET_PASSWORD
                                Authentication password for target cloud (Env: OS_TARGET_PASSWORD)
  --os-target-tenant-id TARGET_TENANT_ID
                                Authentication tenant identifier for target cloud (Env:
                                OS_TARGET_TENANT_ID)
  --os-target-tenant-name TARGET_TENANT_NAME
                                Authentication tenant name for target cloud (Env:
                                OS_TARGET_TENANT_NAME)
  --os-target-auth-token TARGET_TOKEN
                                Authentication token for target cloud (Env: OS_TARGET_AUTH_TOKEN)
  --os-target-auth-url TARGET_AUTH_URL
                                Authentication URL for target cloud (Env: OS_TARGET_AUTH_URL)
  --os-target_cacert TARGET_CACERT
                                Authentication CA Certificate for target cloud (Env:
                                OS_TARGET_CACERT)
  --os-target-region-name TARGET_REGION_NAME
                                Region name for target cloud(Env: OS_TARGET_REGION_NAME)
  --os-target-user-domain-name TARGET_USER_DOMAIN_NAME
                                User domain name for target cloud(Env: OS_TARGET_USER_DOMAIN_NAME)
  --os-target-user-domain-id TARGET_USER_DOMAIN_ID
                                User domain ID for target cloud(Env: OS_TARGET_USER_DOMAIN_ID)
  --os-target-project-domain-name TARGET_PROJECT_DOMAIN_NAME
                                Project domain name for target cloud(Env:
                                OS_TARGET_PROJECT_DOMAIN_NAME)
  --os-target-project-domain-id TARGET_PROJECT_DOMAIN_ID
                                Project domain ID for target cloud(Env:
                                OS_TARGET_PROJECT_DOMAIN_ID)
  --target_insecure             Disables SSL/TLS certificate verification for target cloud (Env:
                                TARGET_MISTRALCLIENT_INSECURE)
  --profile HMAC_KEY            HMAC key to use for encrypting context data for performance
                                profiling of operation. This key should be one of the values
                                configured for the osprofiler middleware in mistral, it is
                                specified in the profiler section of the mistral configuration
                                (i.e. /etc/mistral/mistral.conf). Without the key, profiling will
                                not be triggered even if osprofiler is enabled on the server side.

Commands for API v2 :
  action-create                 Create new action.
  action-delete                 Delete action.
  action-execution-delete       Delete action execution.
  action-execution-get          Show specific Action execution.
  action-execution-get-input    Show Action execution input data.
  action-execution-get-output   Show Action execution output data.
  action-execution-list         List all Action executions.
  action-execution-update       Update specific Action execution.
  action-get                    Show specific action.
  action-get-definition         Show action definition.
  action-list                   List all actions.
  action-update                 Update action.
  action-validate               Validate action.
  bash-completion               Prints all of the commands and options for bash-completion.
  code-source-create            Create new code source.
  code-source-delete            Delete workflow.
  code-source-get               Show specific code source.
  code-source-get-content       Show workflow definition.
  code-source-list              List all workflows.
  code-source-update            Update workflow.
  complete                      print bash completion command
  cron-trigger-create           Create new trigger.
  cron-trigger-delete           Delete trigger.
  cron-trigger-get              Show specific cron trigger.
  cron-trigger-list             List all cron triggers.
  dynamic-action-create         Create new action.
  dynamic-action-delete         Delete action.
  dynamic-action-get            Show specific dynamic action.
  dynamic-action-list           List all dynamic actions.
  dynamic-action-update         Update dynamic action.
  environment-create            Create new environment.
  environment-delete            Delete environment.
  environment-get               Show specific environment.
  environment-list              List all environments.
  environment-update            Update environment.
  event-trigger-create          Create new trigger.
  event-trigger-delete          Delete trigger.
  event-trigger-get             Show specific event trigger.
  event-trigger-list            List all event triggers.
  execution-create              Create new execution.
  execution-delete              Delete execution.
  execution-get                 Show specific execution.
  execution-get-input           Show execution input data.
  execution-get-output          Show execution output data.
  execution-get-published       Show workflow global published variables.
  execution-get-report          Print execution report.
  execution-get-sub-executions  Command base class for providing a list of data as output.
  execution-list                List all executions.
  execution-update              Update execution.
  help                          print detailed help for another command
  member-create                 Shares a resource to another tenant.
  member-delete                 Delete a resource sharing relationship.
  member-get                    Show specific member information.
  member-list                   List all members.
  member-update                 Update resource sharing status.
  run-action                    Create new Action execution or just run specific action.
  task-get                      Show specific task.
  task-get-published            Show task published variables.
  task-get-result               Show task output data.
  task-get-sub-executions       Command base class for providing a list of data as output.
  task-list                     List all tasks.
  task-rerun                    Rerun an existing task.
  workbook-create               Create new workbook.
  workbook-delete               Delete workbook.
  workbook-get                  Show specific workbook.
  workbook-get-definition       Show workbook definition.
  workbook-list                 List all workbooks.
  workbook-update               Update workbook.
  workbook-validate             Validate workbook.
  workflow-create               Create new workflow.
  workflow-delete               Delete workflow.
  workflow-get                  Show specific workflow.
  workflow-get-definition       Show workflow definition.
  workflow-list                 List all workflows.
  workflow-update               Update workflow.
  workflow-validate             Validate workflow.
Options (44)
OptionDescriptionSource
--versionShow program's version number and exit.help
-v, --verboseIncrease verbosity of output.help
--log-file LOG_FILESpecify a file to log output.help
-q, --quietSuppress output except warnings and errors.help
-h, --helpShow this help message and exit.help
--debugShow tracebacks on errors.help
--os-mistral-url MISTRAL_URLMistral API host (Env: OS_MISTRAL_URL)help
--os-mistral-version MISTRAL_VERSIONMistral API version (default = v2) (Env: OS_MISTRAL_VERSION)help
--os-mistral-service-type SERVICE_TYPEMistral service-type (should be the same name as in keystone- endpoint) (default = workflowv2) (Env: OS_MISTRAL_SERVICE_TYPE)help
--os-mistral-endpoint-type ENDPOINT_TYPEMistral endpoint-type (should be the same name as in keystone- endpoint) (default = publicURL) (Env: OS_MISTRAL_ENDPOINT_TYPE)help
--os-username USERNAMEAuthentication username (Env: OS_USERNAME)help
--os-password PASSWORDAuthentication password (Env: OS_PASSWORD)help
--os-tenant-id TENANT_IDAuthentication tenant identifier (Env: OS_TENANT_ID or OS_PROJECT_ID)help
--os-project-id PROJECT_IDAuthentication project identifier (Env: OS_TENANT_ID or OS_PROJECT_ID), will use tenant_id if both tenant_id and project_id are sethelp
--os-tenant-name TENANT_NAMEAuthentication tenant name (Env: OS_TENANT_NAME or OS_PROJECT_NAME)help
--os-project-name PROJECT_NAMEAuthentication project name (Env: OS_TENANT_NAME or OS_PROJECT_NAME), will use tenant_name if both tenant_name and project_name are sethelp
--os-auth-token TOKENAuthentication token (Env: OS_AUTH_TOKEN)help
--os-project-domain-name PROJECT_DOMAIN_NAMEAuthentication project domain name or ID (Env: OS_PROJECT_DOMAIN_NAME or OS_PROJECT_DOMAIN_NAME)help
--os-project-domain-id PROJECT_DOMAIN_IDAuthentication project domain ID (Env: OS_PROJECT_DOMAIN_ID)help
--os-user-domain-name USER_DOMAIN_NAMEAuthentication user domain name (Env: OS_USER_DOMAIN_NAME)help
--os-user-domain-id USER_DOMAIN_IDAuthentication user domain name (Env: OS_USER_DOMAIN_ID)help
--os-auth-url AUTH_URLAuthentication URL (Env: OS_AUTH_URL)help
--os-cert OS_CERTClient Certificate (Env: OS_CERT)help
--os-key OS_KEYClient Key (Env: OS_KEY)help
--os-cacert OS_CACERTAuthentication CA Certificate (Env: OS_CACERT)help
--os-region-name REGION_NAMERegion name (Env: OS_REGION_NAME)help
--insecureDisables SSL/TLS certificate verification (Env: MISTRALCLIENT_INSECURE)help
--auth-type AUTH_TYPEAuthentication type.help
--openid-client-id CLIENT_IDClient ID (according to OpenID Connect).help
--openid-client-secret CLIENT_SECRETClient secret (according to OpenID Connect) (Env: OPENID_CLIENT_SECRET)help
--os-target-username TARGET_USERNAMEAuthentication username for target cloud (Env: OS_TARGET_USERNAME)help
--os-target-password TARGET_PASSWORDAuthentication password for target cloud (Env: OS_TARGET_PASSWORD)help
--os-target-tenant-id TARGET_TENANT_IDAuthentication tenant identifier for target cloud (Env: OS_TARGET_TENANT_ID)help
--os-target-tenant-name TARGET_TENANT_NAMEAuthentication tenant name for target cloud (Env: OS_TARGET_TENANT_NAME)help
--os-target-auth-token TARGET_TOKENAuthentication token for target cloud (Env: OS_TARGET_AUTH_TOKEN)help
--os-target-auth-url TARGET_AUTH_URLAuthentication URL for target cloud (Env: OS_TARGET_AUTH_URL)help
--os-target_cacert TARGET_CACERTAuthentication CA Certificate for target cloud (Env: OS_TARGET_CACERT)help
--os-target-region-name TARGET_REGION_NAMERegion name for target cloud(Env: OS_TARGET_REGION_NAME)help
--os-target-user-domain-name TARGET_USER_DOMAIN_NAMEUser domain name for target cloud(Env: OS_TARGET_USER_DOMAIN_NAME)help
--os-target-user-domain-id TARGET_USER_DOMAIN_IDUser domain ID for target cloud(Env: OS_TARGET_USER_DOMAIN_ID)help
--os-target-project-domain-name TARGET_PROJECT_DOMAIN_NAMEProject domain name for target cloud(Env: OS_TARGET_PROJECT_DOMAIN_NAME)help
--os-target-project-domain-id TARGET_PROJECT_DOMAIN_IDProject domain ID for target cloud(Env: OS_TARGET_PROJECT_DOMAIN_ID)help
--target_insecureDisables SSL/TLS certificate verification for target cloud (Env: TARGET_MISTRALCLIENT_INSECURE)help
--profile HMAC_KEYHMAC key to use for encrypting context data for performance profiling of operation.help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.