ptk cluster stop

ptk cluster stop stops a database cluster or instance.

Syntax

ptk cluster stop [flags]

Example

# Stop all instances of the specified cluster.
ptk cluster -n <CLUSTER_NAME> stop

# Stop a specific instance of a specified cluster.
ptk cluster -n <CLUSTER_NAME> stop -H <IP>
ptk cluster -n <CLUSTER_NAME> stop -i <ID>

# [! Danger] Stop all clusters managed by PTK.
ptk cluster stop --all

Option

-a, --all

• Description: stops all clusters.
• Data type: boolean
• Default value: false

-H, --host string

• Description: specifies the IP address of a database instance.
• Data type: string
• Default value: ""

-i, --id int

• Description: specifies the ID of a database instance.
• Data type: int
• Default value: 0

-m, --mode string

• Description: specifies the stopping mode. The value can be fast or immediate.
• Data type: string
• Default value: fast

--time-out duration

• Description: specifies the execution timeout duration.
• Data type: duration
• Default value: 10m

Option Inherited from the Parent Command

--disable-color

• Description: Disable color logs.
• Data type: bool
• Default value: false

--disable-debug-log

• Description: not generate debug log files.
• Data type: bool
• Default value: false

--disable-progressbar

• Description: No progress bar globally.
• Data type: bool
• Default value: false

-h, --help

• Description: outputs the help information.
• Data type: boolean
• Default value: false

--log-file string

• Description: specifies the file path to which the run log is stored.
• Data type: string
• Default value: ""

--log-format string

• Description: specifies the output format of a run log. The value can be text and json.
• Data type: string
• Default value: text

--log-level string

• Description: specifies the run log level. The value can be debug, info, warning, error, and panic.
• Data type: string
• Default value: info

-n, --name string

• Description: specifies the cluster name.
• Data type: string
• Default value: ""

--silence

• Description: Logs are not printed to standard output.
• Data type: bool
• Default value: false

--skip-fix-ssh

• Description: skips SSH connection fixing through interaction.

• Data type: boolean

• Default value: false

Added Version

v0.1

More Command

• ptk cluster - Manages a cluster.