Skip to main content

5.1.5.3. Useful Commands

To use the executable on the master, we will use the etcdctl alias; to use etcdctl inside a container, use the ectl, nectl aliases.

etcdctl
ectl
nectl
kectl

Commands	Description
`etcdctl --endpoints=$(etcdctlMembers) member list -w table`	List ETCD cluster nodes from one of the nodes in table format
`etcdctl --endpoints=$(etcdctlMembers) endpoint status -w table`	Display ETCD cluster node status in table format
`etcdctl --endpoints=$(etcdctlMembers) get / --prefix`	List all keys and values whose key matches the given prefix.
`etcdctl --endpoints=$(etcdctlMembers) get / --prefix --keys-only`	List all keys whose key matches the given prefix.
`etcdctl --endpoints=$(etcdctlMembers) snapshot save PATH_TO_SAVE.db`	Create a snapshot of the ETCD database state
`etcdctl --endpoints=$(etcdctlMembers) defrag --cluster`	Defragment the DB files. (When the cluster is stopped, use with the --data-dir flag specifying the file path)
`etcdctl --endpoints=$(etcdctlMembers) compaction ${INDEX}`	Compact the data and assign a revision number

Commands	Description
`ectl --endpoints=$(ectlMembers) member list -w table`	List ETCD cluster nodes from one of the nodes in table format
`ectl --endpoints=$(ectlMembers) endpoint status -w table`	Display ETCD cluster node status in table format
`ectl --endpoints=$(ectlMembers) get / --prefix`	List all keys and values whose key matches the given prefix.
`ectl --endpoints=$(ectlMembers) get / --prefix --keys-only`	List all keys whose key matches the given prefix.
`ectl --endpoints=$(ectlMembers) snapshot save PATH_TO_SAVE.db`	Create a snapshot of the ETCD database state
`ectl --endpoints=$(ectlMembers) defrag --cluster`	Defragment the DB files. (When the cluster is stopped, use with the --data-dir flag specifying the file path)
`ectl --endpoints=$(ectlMembers) compaction ${INDEX}`	Compact the data and assign a revision number

Commands	Description
`nectl --endpoints=$(nectlMembers) member list -w table`	List ETCD cluster nodes from one of the nodes in table format
`nectl --endpoints=$(nectlMembers) endpoint status -w table`	Display ETCD cluster node status in table format
`nectl --endpoints=$(nectlMembers) get / --prefix`	List all keys and values whose key matches the given prefix.
`nectl --endpoints=$(nectlMembers) get / --prefix --keys-only`	List all keys whose key matches the given prefix.
`nectl --endpoints=$(nectlMembers) snapshot save PATH_TO_SAVE.db`	Create a snapshot of the ETCD database state
`nectl --endpoints=$(nectlMembers) defrag --cluster`	Defragment the DB files. (When the cluster is stopped, use with the --data-dir flag specifying the file path)
`nectl --endpoints=$(nectlMembers) compaction ${INDEX}`	Compact the data and assign a revision number

Commands	Description
`kectl --endpoints=$(kectlMembers) member list -w table`	List ETCD cluster nodes from one of the nodes in table format
`kectl --endpoints=$(kectlMembers) endpoint status -w table`	Display ETCD cluster node status in table format
`kectl --endpoints=$(kectlMembers) get / --prefix`	List all keys and values whose key matches the given prefix.
`kectl --endpoints=$(kectlMembers) get / --prefix --keys-only`	List all keys whose key matches the given prefix.
`kectl --endpoints=$(kectlMembers) snapshot save PATH_TO_SAVE.db`	Create a snapshot of the ETCD database state
`kectl --endpoints=$(kectlMembers) defrag --cluster`	Defragment the DB files. (When the cluster is stopped, use with the --data-dir flag specifying the file path)
`kectl --endpoints=$(kectlMembers) compaction ${INDEX}`	Compact the data and assign a revision number