Forrest logo
tool overview
On this page you find all important commands for the CLI tool etcdctl. If the command you are looking for is missing please ask our AI.

etcdctl

etcdctl is a command-line tool that is used for interacting with the etcd distributed key-value store. etcd is a highly available and distributed key-value store that provides reliable storage for critical data in distributed systems. It is often used as a foundation for building distributed systems, service discovery, and coordination.

etcdctl allows you to interact with the etcd cluster by executing various commands such as setting, getting, and deleting keys, as well as performing more advanced operations like atomic compare-and-swap (CAS) and watching for changes in the key-value store. It provides a simple and efficient way to manage and manipulate data stored in the etcd cluster through the command line.

Using etcdctl, you can connect to an etcd cluster, specify the target server and port, and execute commands against it. It supports several authentication methods and can be configured with the appropriate credentials for secure communication with the etcd cluster.

etcdctl is a powerful tool for developers, system administrators, and operators who work with etcd clusters. It enables them to manage and query data in the etcd key-value store conveniently from the command line interface, allowing for greater flexibility and automation in managing the distributed system's configuration and coordination.

List of commands for etcdctl:

  • etcdctl:tldr:272d3 etcdctl: Delete a key-value pair.
    $ etcdctl del ${my-key}
    try on your machine
    explain this command
  • etcdctl:tldr:3807f etcdctl: Save a snapshot of the etcd keystore.
    $ etcdctl snapshot save ${path-to-snapshot-db}
    try on your machine
    explain this command
  • etcdctl:tldr:3e6ee etcdctl: Store a key-value pair, reading the value from a file.
    $ etcdctl put ${my-file} < ${filename-txt}
    try on your machine
    explain this command
  • etcdctl:tldr:4afd4 etcdctl: Watch a key for changes.
    $ etcdctl watch ${my-key}
    try on your machine
    explain this command
  • etcdctl:tldr:7fc73 etcdctl: Add a user.
    $ etcdctl user add ${my_user}
    try on your machine
    explain this command
  • etcdctl:tldr:87fb5 etcdctl: Restore a snapshot of an etcd keystore (restart the etcd server afterwards).
    $ etcdctl snapshot restore ${path-to-snapshot-db}
    try on your machine
    explain this command
  • etcdctl:tldr:a6167 etcdctl: Display the value associated with a specified key.
    $ etcdctl get ${my-key}
    try on your machine
    explain this command
  • etcdctl:tldr:e9100 etcdctl: Store a key-value pair.
    $ etcdctl put ${my-key} ${my_value}
    try on your machine
    explain this command
tool overview