Temporal CLI batch command reference
Batch commands change multiple Workflow Executions
What 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 by providing a List FilterWhat 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 and the type of Batch Job to execute.
The List Filter identifies the Workflow Executions in the Batch Job; the Batch type determines what will happen to the Workflow Executions.
There are three types of Batch Jobs:
- Signal: sends a SignalWhat is a Signal?
A Signal is an asynchronous request to a Workflow Execution.
Learn more to the Workflow Executions specified by the List Filter. - Cancel: cancels the Workflow Executions specified by the List Filter.
- Terminate: terminates the Workflow Executions specified by the List Filter.
A successfully started Batch job will return a Job ID. Use this Job ID to execute other actions on the Batch job.
list
The temporal batch list command returns all Batch jobs.
Batch Jobs can be returned for an entire Cluster or a single Namespace.
temporal batch list --namespace=MyNamespace
Use the following options to change the behavior of this command.
- --addresstemporal address
The host and port for the Temporal Frontend Service.
Learn more - --codec-authtemporal codec-auth
Sets the authorization header on requests to the Codec Server.
Learn more - --codec-endpointtemporal codec-endpoint
Endpoint for a remote Codec Server.
Learn more - --colortemporal color
Color options for the CLI.
Learn more - --context-timeouttemporal context-timeout
An optional timeout for the context of an RPC call.
Learn more - --envtemporal env
Name of the environment to read environmental variables from.
Learn more - --fieldstemporal fields
Customize fields to print.
Learn more - --grpc-metatemporal grpc-meta
Contains gRPC metadata to send with requests.
Learn more - --limittemporal limit
Number of items to print.
Learn more - --namespacetemporal namespace
Identifies a Namespace in the Temporal Workflow.
Learn more - --no-pagertemporal no-pager
Disables the interactive pager.
Learn more - --outputtemporal output
Output format.
Learn more - --pagertemporal pager
Sets the pager for Temporal CLI to use.
Learn more - --time-formattemporal time-format
Format time as either relative, iso, raw.
Learn more - --tlstemporal tls
Enable TLS encryption without additional options such as mTLS or client certificates
Learn more - --tls-ca-pathtemporal tls-ca-path
Path to server CA certificate.
Learn more - --tls-cert-pathtemporal tls-cert-path
Path to x509 certificate.
Learn more - --tls-disable-host-verificationtemporal tls-disable-host-verification
Disables TLS host name verification if already enabled.
Learn more - --tls-key-pathtemporal tls-key-path
Path to private certificate key.
Learn more - --tls-server-nametemporal tls-server-name
Overrides the target TLS server name.
Learn more
describe
The temporal batch describe command shows the progress of an ongoing Batch job.
Pass a valid Job ID to return a Batch Job's information.
temporal batch describe --jobid=MyJobId
Use the following options to change the behavior of this command.
- --addresstemporal address
The host and port for the Temporal Frontend Service.
Learn more - --codec-authtemporal codec-auth
Sets the authorization header on requests to the Codec Server.
Learn more - --codec-endpointtemporal codec-endpoint
Endpoint for a remote Codec Server.
Learn more - --colortemporal color
Color options for the CLI.
Learn more - --context-timeouttemporal context-timeout
An optional timeout for the context of an RPC call.
Learn more - --envtemporal env
Name of the environment to read environmental variables from.
Learn more - --fieldstemporal fields
Customize fields to print.
Learn more - --grpc-metatemporal grpc-meta
Contains gRPC metadata to send with requests.
Learn more - --job-idtemporal job-id
Batch Job Id
Learn more - --namespacetemporal namespace
Identifies a Namespace in the Temporal Workflow.
Learn more - --outputtemporal output
Output format.
Learn more - --time-formattemporal time-format
Format time as either relative, iso, raw.
Learn more - --tlstemporal tls
Enable TLS encryption without additional options such as mTLS or client certificates
Learn more - --tls-ca-pathtemporal tls-ca-path
Path to server CA certificate.
Learn more - --tls-cert-pathtemporal tls-cert-path
Path to x509 certificate.
Learn more - --tls-disable-host-verificationtemporal tls-disable-host-verification
Disables TLS host name verification if already enabled.
Learn more - --tls-key-pathtemporal tls-key-path
Path to private certificate key.
Learn more - --tls-server-nametemporal tls-server-name
Overrides the target TLS server name.
Learn more
terminate
The temporal batch terminate command terminates a Batch job with the provided Job ID.
For future reference, provide a reason for terminating the Batch Job.
temporal batch terminate --job-id=MyJobId --reason=JobReason
Use the following options to change the behavior of this command.
- --addresstemporal address
The host and port for the Temporal Frontend Service.
Learn more - --codec-authtemporal codec-auth
Sets the authorization header on requests to the Codec Server.
Learn more - --codec-endpointtemporal codec-endpoint
Endpoint for a remote Codec Server.
Learn more - --colortemporal color
Color options for the CLI.
Learn more - --context-timeouttemporal context-timeout
An optional timeout for the context of an RPC call.
Learn more - --envtemporal env
Name of the environment to read environmental variables from.
Learn more - --grpc-metatemporal grpc-meta
Contains gRPC metadata to send with requests.
Learn more - --job-idtemporal job-id
Batch Job Id
Learn more - --namespacetemporal namespace
Identifies a Namespace in the Temporal Workflow.
Learn more - --reasontemporal reason
Reason for the operation
Learn more - --tlstemporal tls
Enable TLS encryption without additional options such as mTLS or client certificates
Learn more - --tls-ca-pathtemporal tls-ca-path
Path to server CA certificate.
Learn more - --tls-cert-pathtemporal tls-cert-path
Path to x509 certificate.
Learn more - --tls-disable-host-verificationtemporal tls-disable-host-verification
Disables TLS host name verification if already enabled.
Learn more - --tls-key-pathtemporal tls-key-path
Path to private certificate key.
Learn more - --tls-server-nametemporal tls-server-name
Overrides the target TLS server name.
Learn more