Skip to main content
Version: june-2022

tctl namespace register

The tctl namespace register command registers a Namespace.

tctl namespace register

The following modifiers control the behavior of the command.

--active-cluster

Specify the name of the active Temporal Cluster when registering a Namespace. This value changes for Global Namespaces when a failover occurs.

Alias: --ac

Example

tctl namespace register --active-cluster <name>

--clusters

Specify a list of Temporal Clusters when registering a Namespace.

The list contains the names of Clusters (separated by spaces) to which the Namespace can fail over. Make sure to include to the currently active Cluster. This is a read-only setting and cannot be changed.

This modifier is valid only when the --global-namespace modifier is set to true.

Alias --cl

Example

tctl namespace register --clusters <names>

--description

Specify a description when registering a Namespace.

Alias --desc

Example

tctl namespace register --description <value>

--global-namespace

Specifies whether a Namespace is a Global Namespace. When enabled, it controls the creation of replication tasks on updates allowing the state to be replicated across Clusters. This is a read-only setting and cannot be changed.

Alias --gd

Example

tctl namespace register --global-namespace <boolean>

--history-archival-state

Set the state of Archival. Valid values are disabled and enabled.

Alias --has

Example

tctl namespace register --history-archival-state <value>

--history-uri

Specify the URI for Archival. The URI cannot be changed after Archival is first enabled.

Alias --huri

Example

tctl namespace register --history-uri <uri>

--namespace-data

Specify data for a Namespace in the form of key-value pairs (such as k1:v1,k2:v2,k3:v3).

Alias --dmd

Example

tctl namespace register --namespace-data <data>

--owner-email

Specify the email address of the Namespace owner.

Alias --oe

Example

tctl namespace register --owner-email <value>

--retention

Set the Retention Period for the Namespace.

The Retention Period applies to Closed Workflow Executions.

Alias --rd

Example

tctl namespace register --retention <value>

--visibility-archival-state

Set the visibility state for Archival. Valid values are disabled and enabled.

Alias --vas

Example

tctl namespace register --visibility-archival-state <value>

--visibility-uri

Specify the visibility URI for Archival. The URI cannot be changed after Archival is first enabled.

Alias --vuri

Example

tctl namespace register --visibility-uri <uri>