Skip to main content

tctl v1.17 cluster command reference

Temporal CLI is now available!

The new Temporal CLI is available for use.

tctl v1.17 can still be used with Temporal Server version 1.20 and is expected to be compatible with Temporal Server version 1.21.

tctl is expected to be fully deprecated by Temporal Server version 1.22

The tctl cluster command enables Temporal Cluster 🔗

Link preview
What is a Temporal Cluster?
A Temporal Cluster is a Temporal Server paired with Persistence and Visibility stores.
term explanation
operations.

  • tctl cluster health 🔗
    Link preview
    tctl cluster health
    How to check the health of the Frontend Service using tctl.
    tctl cli reference
  • tctl cluster get-search-attributes 🔗
    Link preview
    tctl cluster get-search-attributes
    How to list all Search Attributes using tctl.
    tctl cli reference

get-search-attributes​

The tctl cluster get-search-attributes command lists all Search Attributes 🔗

Link preview
What is a Search Attribute?
A Search Attribute is an indexed name used in List Filters to filter a list of Workflow Executions that have the Search Attribute in their metadata.
term explanation filtered-lists visibility
that can be used in the --query modifier of the tctl workflow list 🔗
Link preview
tctl workflow list
How to list open or closed Workflow Executions using tctl.
tctl cli reference
command and the --search_attr_key and --search_attr_value modifiers of the tctl workflow run 🔗
Link preview
tctl workflow run
How to start a new Workflow Execution and get Workflow progress using tctl.
tctl cli reference
and tctl workflow start 🔗
Link preview
tctl workflow start
How to start a new Workflow Execution using tctl.
tctl cli reference
commands.

Example:

tctl cluster get-search-attributes

The command has no modifiers.

Example output:

+-----------------------+----------+
|         NAME          |   TYPE   |
+-----------------------+----------+
| BinaryChecksums       | Keyword  |
| CloseTime             | Int      |
| CustomBoolField       | Bool     |
| CustomDatetimeField   | Datetime |
| CustomDoubleField     | Double   |
| CustomIntField        | Int      |
| CustomKeywordField    | Keyword  |
| CustomNamespace       | Keyword  |
| CustomStringField     | String   |
| ExecutionStatus       | Int      |
| ExecutionTime         | Int      |
| Operator              | Keyword  |
| RunId                 | Keyword  |
| StartTime             | Int      |
| TaskQueue             | Keyword  |
| TemporalChangeVersion | Keyword  |
| WorkflowId            | Keyword  |
| WorkflowType          | Keyword  |
+-----------------------+----------+

The admin version of this command displays default and custom Search Attributes separately, and also shows the underlying Elasticsearch index schema and system Workflow status.

health​

The tctl cluster health command checks the health of the Frontend Service 🔗

Link preview
What is a Temporal Cluster?
A Temporal Cluster is a Temporal Server paired with Persistence and Visibility stores.
term explanation
.

tctl cluster health

The command has no modifiers.