st2
CLI for StackStorm event-driven automation platform
Subcommands
| Name | Description |
|---|---|
run | Invoke an action manually |
action | An activity that happens as a response to the external event |
action-alias | Action aliases |
auth | Authenticate user and acquire access token |
login | Authenticate user, acquire access token, and update CLI config directory |
whoami | Display the currently authenticated user |
apikey | API Keys |
execution | An invocation of an action |
inquiry | Inquiries provide an opportunity to ask a question and wait for a response in a workflow |
key | Key value pair is used to store commonly used configuration for reuse in sensors, actions, and rules |
pack | A group of related integration resources: actions, rules, and sensors |
policy | Policy that is enforced on a resource |
policy-type | Type of policy that can be applied to the resources |
rule | A specification to invoke an 'action' on a 'trigger' selectively based on some criteria' |
webhook | Webhooks |
timer | Timers |
runner | Runner is a type of handler for a specific class of actions |
sensor | An adapter which allows you to integrate StackStorm with external system |
trace | A group of executions, rules and triggerinstances that are related |
trigger | An external event that is mapped to a st2 input. It is the st2 invocation point |
trigger-instance | Actual instances of triggers received by st2 |
rule-enforcement | Models that represent enforcement of rules |
workflow | An adapter which allows you to integrate StackStorm with external system |
service-registry | Service registry group and membership related commands |
role | RBAC roles |
role-assignment | RBAC role assignments |
Options
| Name | Description |
|---|---|
--help, -h | Show this help message and exit |
--version | Show program's version number and exit |
--url <BASE_URL> | Base URL for the API servers. Assumes all servers use the same base URL and default ports are used. Get ST2_BASE_URL from the environment variables by default |
--auth-url <AUTH_URL> | URL for the authentication service. Get ST2_AUTH_URL from the environment variables by default |
--api-url <API_URL> | URL for the API server. Get ST2_API_URL from the environment variables by default |
--stream-url <ST2_STREAM_URL> | URL for the stream endpoint. Get ST2_STREAM_URLfrom the environment variables by default |
--api-version <API_VERSION> | API version to use. Get ST2_API_VERSION from the environment variables by default |
--cacert <CACERT> | Path to the CA cert bundle for the SSL endpoints. Get ST2_CACERT from the environment variables by default. If this is not provided, then SSL cert will not be verified |
--config-file <CONFIG_FILE> | Path to the CLI config file |
--print-config | Parse the config file and print the values |
--skip-config | Don't parse and use the CLI config file |
--debug | Enable debug mode |