Temporal CLI operator command reference
Operator commands enable actions on Namespaces, Search Attributes, and Temporal Clusters. These actions are performed through subcommands.
To run an Operator command, run temporal operator [command] [subcommand] [command options].
cluster
Cluster commands enable actions on Temporal Clusters.
Cluster commands follow this syntax:
temporal operator [command] [subcommand] [command options].
describe
The temporal operator cluster describe command shows information about the Cluster.
This information can include information about other connected services, such as a remote Codec Server.
Use the following options to change the output of this command.
health
The temporal operator cluster health command checks the health of the Frontend Service.
A successful execution returns a list of Cluster metrics.
Use the following options to change the behavior and output of this command.
list
The temporal operator cluster list command prints a list of all remote Clusters on the system.
temporal operator cluster list
Use the following options to change the command's behavior.
remove
The temporal operator cluster remove command removes a remote Cluster from the system.
temporal operator cluster remove --name=SomeCluster
Use the following options to change the command's behavior.
system
The temporal operator cluster system command provides information about the system the Cluster is running on.
This information can be used to diagnose problems occurring in the Temporal Server.
temporal operator cluster system
Use the following options to change this command's behavior.
upsert
The temporal operator cluster upsert command allows the user to add or update a remote Cluster.
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 following options to change the behavior of this command.
namespace
Namespace commands perform operations on Namespaces contained in the Temporal Cluster.
Namespace commands follow this syntax:
temporal operator namespace COMMAND [ARGS].
create
The temporal operator namespace create command creates a new Namespace.
The Namespace can be created on the active Cluster, 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 retention and Visibility Archival State, 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 Namespace from the system.
The command follow the syntax temporal operator namespace delete <namespace>
Use the following options to change the behavior of this command.
describe
The temporal operator namespace describe command provides a description of a Namespace.
Namespaces are identified by Namespace ID.
temporal operator namespace describe --namespace-id=meaningful-business-id
Use the following options to change the behavior of this command.
list
The temporal operator namespace list command lists all Namespaces on the Server.
temporal operator namespace list
Use the following options to change this command's behavior.
update
The temporal operator namespace update command updates a Namespace.
Namespaces can be assigned a different active Cluster.
temporal operator namespace update --active-cluster=NewActiveCluster
Namespaces can also be promoted to global Namespaces.
temporal operator namespace --promote-global=true
Any Archives 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"
The Namespace needs to be the last argument passed in your command.
For example, temporal operator namespace update --retention 180 your_namespace.
Use the options listed below to change the command's behavior.
nexus
Nexus commands enable managing Nexus resources.
Nexus commands follow this syntax:
temporal operator nexus [command] [command] [command options]
endpoint
Endpoint commands enable managing Nexus Endpoints.
Endpoint commands follow this syntax:
temporal operator nexus endpoint [command] [command options]
create
Create a new Nexus Endpoint on the Server.
An endpoint name is used in workflow code to invoke Nexus operations. The
endpoint target may either be a worker, in which case --target-namespace and
--target-task-queue must both be provided, or an external URL, in which case
--target-url must be provided.
This command will fail if an endpoint with the same name is already registered.
temporal operator nexus endpoint create \
--name your-endpoint \
--target-namespace your-namespace \
--target-task-queue your-task-queue \
--description-file DESCRIPTION.md
Use the following options to change the behavior of this command.
delete
Delete a Nexus Endpoint configuration from the Server.
temporal operator nexus endpoint delete --name your-endpoint
Use the following options to change the behavior of this command.
get
Get a Nexus Endpoint configuration by name from the Server.
temporal operator nexus endpoint get --name your-endpoint
Use the following options to change the behavior of this command.
list
List all Nexus Endpoint configurations on the Server.
temporal operator nexus endpoint list
Use the following options to change the behavior of this command.
update
Update an existing Nexus Endpoint on the Server.
An endpoint name is used in workflow code to invoke Nexus operations. The
endpoint target may either be a worker, in which case --target-namespace and
--target-task-queue must both be provided, or an external URL, in which case
--target-url must be provided.
The endpoint is patched; existing fields for which flags are not provided are left as they were.
Update only the target task queue:
temporal operator nexus endpoint update \
--name your-endpoint \
--target-task-queue your-other-queue
Update only the description:
temporal operator nexus endpoint update \
--name your-endpoint \
--description-file DESCRIPTION.md
Use the following options to change the behavior of this command.
search-attribute
Search Attribute commands enable operations for the creation, listing, and removal of Search Attributes.
Search Attribute commands follow this syntax:
temporal operator search-attribute COMMAND [ARGS].
create
The temporal operator search-attribute create command adds one or more custom Search Attributes.
These Search Attributes can be used to filter a list of Workflow Executions that contain the given Search Attributes in their metadata.
Use the following options to change this command's behavior.
list
The temporal operator search-attribute list command displays a list of all Search Attributes that can be used in Queries.
temporal workflow list --query.
Use the following options to change this command's behavior.
remove
The temporal operator search-attribute remove command removes custom Search Attribute metadata.
This command does not remove custom Search Attributes from Elasticsearch or change the index schema.
Use the following options to change this command's behavior.