Temporal CLI operator command reference

Operator commands enable actions on NamespacesWhat is a Namespace?

A Namespace is a unit of isolation within the Temporal Platform

Learn more, 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, and Temporal ClustersWhat is a Temporal Cluster?

A Temporal Cluster is a Temporal Server paired with Persistence and Visibility stores.

Learn more. These actions are performed through subcommands.

To run an Operator command, run temporal operator [command] [subcommand] [command options].

cluster

To run an Operator command, run temporal operator [command] [subcommand] [command options].

describe

The temporal operator cluster describe command shows information about the ClusterWhat is a Temporal Cluster?

A Temporal Cluster is a Temporal Server paired with Persistence and Visibility stores.

Learn more. This information can include information about other connected services, such as a remote Codec ServerWhat is a Codec Server?

A Codec Server is an HTTP server that uses your custom Payload Codec to encode and decode your data remotely through endpoints.

Learn more.

Use the options listed below to change the output of this command.

health

The temporal operator cluster health command checks the health of the Frontend ServiceWhat is a Frontend Service?

The Frontend Service is a stateless gateway service that exposes a strongly typed Proto API. The Frontend Service is responsible for rate limiting, authorizing, validating, and routing all inbound calls.

Learn more. A successful execution returns a list of ClusterWhat is a Temporal Cluster?

A Temporal Cluster is a Temporal Server paired with Persistence and Visibility stores.

Learn more metrics.

Use the options listed below to change the behavior and output of this command.

list

The temporal operator cluster list command prints a list of all remote ClustersWhat is a Temporal Cluster?

A Temporal Cluster is a Temporal Server paired with Persistence and Visibility stores.

Learn more on the system.

temporal operator cluster list

Use the options listed below to change the command's behavior.

remove

The temporal operator cluster remove command removes a remote ClusterWhat is a Temporal Cluster?

A Temporal Cluster is a Temporal Server paired with Persistence and Visibility stores.

Learn more from the system.

temporal operator cluster remove --name=SomeCluster

Use the options listed below to change the command's behavior.

system

The temporal operator cluster system command provides information about the system the ClusterWhat is a Temporal Cluster?

A Temporal Cluster is a Temporal Server paired with Persistence and Visibility stores.

Learn more is running on. This information can be used to diagnose problems occurring in the Temporal ServerWhat is the Temporal Server?

The Temporal Server is a grouping of four horizontally scalable services.

Learn more.

temporal operator cluster system

Use the options listed below to change this command's output.

upsert

The temporal operator cluster upsert command allows the user to add or update a remote ClusterWhat is a Temporal Cluster?

A Temporal Cluster is a Temporal Server paired with Persistence and Visibility stores.

Learn more. temporal operator cluster upsert --frontend-address="127.0.2.1"

Upserting can also be used to enable or disabled cross-cluster connection. temporal operator cluster upsert --enable-connection=true

Use the options listed below to change the behavior of this command.

namespace

Namespace commands allow NamespaceWhat is a Namespace?

A Namespace is a unit of isolation within the Temporal Platform

Learn more operations to be performed on the Temporal ClusterWhat is a Temporal Cluster?

A Temporal Cluster is a Temporal Server paired with Persistence and Visibility stores.

Learn more.

create

The temporal operator namespace create command creates a new NamespaceWhat is a Namespace?

A Namespace is a unit of isolation within the Temporal Platform

Learn more. The Namespace can be created on the active ClusterWhat is a Temporal Cluster?

A Temporal Cluster is a Temporal Server paired with Persistence and Visibility stores.

Learn more, or any named Cluster within the system. temporal operator namespace --cluster=MyCluster

Global Namespaces can also be created. temporal operator namespace create --global

Other settings, such as retentionWhat is a Retention Period?

A Retention Period is the amount of time a Workflow Execution Event History remains in the Cluster's persistence store.

Learn more and Visibility Archival StateWhat is Visibility?

The term Visibility, within the Temporal Platform, refers to the subsystems and APIs that enable an operator to view Workflow Executions that currently exist within a Cluster.

Learn more, can be configured according to the application's needs. The Visibility Archive can be set on a separate URI. temporal operator namespace create --retention=RetentionMyWorkflow --visibility-archival-state="enabled" --visibility-uri="some-uri"

Use the options listed below to change the command's behavior.

delete

The temporal operator namespace delete command deletes a given NamespaceWhat is a Namespace?

A Namespace is a unit of isolation within the Temporal Platform

Learn more from the system.

Use the options listed below to change the command's behavior.

describe

The temporal operator namespace describe command provides a description of a NamespaceWhat is a Namespace?

A Namespace is a unit of isolation within the Temporal Platform

Learn more. Namespaces are identified by Namespace ID.

temporal operator namespace describe --namespace-id=meaningful-business-id

Use the options listed below to change the command's output.

list

The temporal operator namespace list command lists all Namespaces on the ServerWhat is a Frontend Service?

The Frontend Service is a stateless gateway service that exposes a strongly typed Proto API. The Frontend Service is responsible for rate limiting, authorizing, validating, and routing all inbound calls.

Learn more.

temporal operator namespace list

Use the options listed below to change the command's output.

update

The temporal operator namespace update command updates a given NamespaceWhat is a Namespace?

A Namespace is a unit of isolation within the Temporal Platform

Learn more.

Namespaces can be assigned a different active ClusterWhat is a Temporal Cluster?

A Temporal Cluster is a Temporal Server paired with Persistence and Visibility stores.

Learn more. temporal operator namespace update --active-cluster=NewActiveCluster

Namespaces can also be promoted to global Namespaces. temporal operator namespace --promote-global=true

Any ArchivesWhat is Archival?

Archival is a feature that automatically backs up Event Histories from Temporal Cluster persistence to a custom blob store after the Closed Workflow Execution retention period is reached.

Learn more that were previously enabled or disabled can be changed through this command. However, URI values for archival states cannot be changed after the states are enabled. temporal operator namespace update --history-archival-state="enabled" --visibility-archival-state="disabled"

Use the options listed below to change the command's behavior.

search-attribute

Search Attribute commands enable operations for the creation, listing, and removal of 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.

create

The temporal operator search-attribute create command adds one or more custom 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. These Search Attributes can be used to filter a listWhat is a List Filter?

A List Filter is the SQL-like string that is provided as the parameter to an Advanced Visibility List API.

Learn more of Workflow ExecutionsWhat is a Workflow Execution?

A Temporal Workflow Execution is a durable, scalable, reliable, and reactive function execution. It is the main unit of execution of a Temporal Application.

Learn more that contain the given Search Attributes in their metadata.

Use the options listed below to change the command's behavior.

list

The temporal operator search-attribute list command displays a list of 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 temporal workflow list --query.

Use the options listed below to change the command's behavior.

remove

The temporal operator search-attribute remove command removes custom Search AttributeWhat 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 metadata. This command does not remove custom Search Attributes from Elasticsearch. The index schema is not modified.

Use the options listed below to change the command's behavior.

cluster​

describe​

health​

list​

remove​

system​

upsert​

namespace​

create​

delete​

describe​

list​

update​

search-attribute​

create​

list​

remove​

cluster

describe

health

list

remove

system

upsert

namespace

create

delete

describe

list

update

search-attribute

create

list

remove