etcdctl - A simple command line client for etcd.
Set environment variable ETCDCTL_API=3 to use v3 API or
ETCDCTL_API=2 to use v2 API.
etcdctl [options] command [command options] [arguments...]
- alarm disarm
- Disarms all alarms
- alarm list
- Lists all alarms
- auth disable
- Disables authentication
- auth enable
- Enables authentication
- check datascale
- Check the memory usage of holding data for different workloads on a given
server endpoint.
- check perf
- Check the performance of the etcd cluster
- compaction
- Compacts the event history in etcd
- completion
bash
- Generate the autocompletion script for bash
- completion
fish
- Generate the autocompletion script for fish
- completion
powershell
- Generate the autocompletion script for powershell
- completion
zsh
- Generate the autocompletion script for zsh
- defrag
- Defragments the storage of the etcd members with given endpoints
- del
- Removes the specified key or range of keys [key, range_end)
- elect
- Observes and participates in leader election
- endpoint
hashkv
- Prints the KV history hash for each endpoint in --endpoints
- endpoint
health
- Checks the healthiness of endpoints specified in `--endpoints` flag
- endpoint
status
- Prints out the status of endpoints specified in `--endpoints` flag
- get
- Gets the key or a range of keys
- help
- Help about any command
- lease grant
- Creates leases
- lease
keep-alive
- Keeps leases alive (renew)
- lease list
- List all active leases
- lease revoke
- Revokes leases
- lease
timetolive
- Get lease information
- lock
- Acquires a named lock
- make-mirror
- Makes a mirror at the destination etcd cluster
- member add
- Adds a member into the cluster
- member list
- Lists all members in the cluster
- member promote
- Promotes a non-voting member in the cluster
- member remove
- Removes a member from the cluster
- member update
- Updates a member in the cluster
- migrate
- Migrates keys in a v2 store to a mvcc store
- move-leader
- Transfers leadership to another etcd cluster member.
- put
- Puts the given key into the store
- role add
- Adds a new role
- role delete
- Deletes a role
- role get
- Gets detailed information of a role
- role grant-permission
- Grants a key to a role
- role list
- Lists all roles
- role revoke-permission
- Revokes a key from a role
- snapshot
restore
- Restores an etcd member snapshot to an etcd directory
- snapshot
save
- Stores an etcd node backend snapshot to a given file
- snapshot
status
- Gets backend snapshot status of a given file
- txn
- Txn processes all the requests in one transaction
- user add
- Adds a new user
- user delete
- Deletes a user
- user get
- Gets detailed information of a user
- user grant-role
- Grants a role to a user
- user list
- Lists all users
- user passwd
- Changes password of user
- user revoke-role
- Revokes a role from a user
- version
- Prints the version of etcdctl
- watch
- Watches events stream on keys or prefixes
- backup
- backup an etcd directory
- cluster-health
- check the health of the etcd cluster
- mk
- make a new key with a given value
- mkdir
- make a new directory
- rm
- remove a key or a directory
- rmdir
- removes the key if it is an empty directory or a key-value pair
- get
- retrieve the value of a key
- ls
- retrieve a directory
- set
- set the value of a key
- setdir
- create a new directory or update an existing directory TTL
- update
- update an existing key with a given value
- updatedir
- update an existing directory
- watch
- watch a key for changes
- exec-watch
- watch a key for changes and exec an executable
- member
- member add, remove and list subcommands
- user
- user add, grant and revoke subcommands
- role
- role add, grant and revoke subcommands
- auth
- overall auth controls
- help, h
- Shows a list of commands or help for one command