tctl v1.17 cluster command reference
The What is a Temporal Cluster? A Temporal Cluster is the Temporal Server paired with persistence.tctl cluster command enables Temporal Cluster
get-search-attributes
The 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. tctl workflow run How to start a new Workflow Execution and get Workflow progress using tctl.tctl cluster get-search-attributes command lists all Search Attributes--query modifier of the tctl workflow list command and the --search_attr_key and --search_attr_value modifiers of the tctl workflow runtctl workflow start 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 What is a Temporal Cluster? A Temporal Cluster is the Temporal Server paired with persistence.tctl cluster health command checks the health of the Frontend Service
tctl cluster health
The command has no modifiers.