tctl v1.17 cluster command reference

The tctl cluster command enables Temporal ClusterWhat is a Temporal Cluster?

A Temporal Cluster is the Temporal Server paired with persistence.

Learn more operations.

• tctl cluster healthtctl cluster health
  
  How to check the health of the Frontend Service using tctl.
  
  Learn more
• tctl cluster get-search-attributestctl cluster get-search-attributes
  
  How to list all Search Attributes using tctl.
  
  Learn more

get-search-attributes

The tctl cluster get-search-attributes command lists all Search AttributesWhat 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.

Learn more that can be used in the --query modifier of the tctl workflow listtctl workflow list

How to list open or closed Workflow Executions using tctl.

Learn more command and the --search_attr_key and --search_attr_value modifiers of the tctl workflow runtctl workflow run

How to start a new Workflow Execution and get Workflow progress using tctl.

Learn more and tctl workflow starttctl workflow start

How to start a new Workflow Execution using tctl.

Learn more 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 ServiceWhat is a Temporal Cluster?

A Temporal Cluster is the Temporal Server paired with persistence.

Learn more.

tctl cluster health

The command has no modifiers.