ecctool is a command line utility used to perform operations toward a local ecChronos instance. Run ‘ecctool <subcommand> –help’ to get more information about each subcommand.
usage: ecctool [-h] {rejections,repair-info,repairs,run-repair,running-job,schedules,start,status,stop} ...show this help message and exit
Manage ecchronos rejections. Use ‘ecctool rejections <action> –help’ for action information.
usage: ecctool rejections [-h] [-u URL] [-c COLUMNS] [-o OUTPUT] {create,delete,get,update} ...show this help message and exit
ecchronos host URL (format: http://<host>:<port>)
table columns to display (format: 0,1,2,…,N)
output formats: json, table (default)
usage: ecctool rejections create [-h] -k KEYSPACE -t TABLE -sh START_HOUR -sm START_MINUTE -eh END_HOUR -em END_MINUTE -dcs DC_EXCLUSIONS [DC_EXCLUSIONS ...] [-u URL]show this help message and exit
keyspace
table
start hour
start minute
end hour
end minute
datacenters to exclude (format: <dc1> <dc2> … <dcN>)
ecchronos host URL (format: http://<host>:<port>)
usage: ecctool rejections delete [-h] [-a ALL] [-k KEYSPACE] [-t TABLE] [-sh START_HOUR] [-sm START_MINUTE] [-dcs DC_EXCLUSIONS [DC_EXCLUSIONS ...]] [-u URL]show this help message and exit
delete all
keyspace
table
start hour
start minute
datacenters to exclude (format: <dc1> <dc2> … <dcN>)
ecchronos host URL (format: http://<host>:<port>)
usage: ecctool rejections get [-h] [-k KEYSPACE] [-t TABLE] [-u URL]show this help message and exit
keyspace
table
ecchronos host URL (format: http://<host>:<port>)
usage: ecctool rejections update [-h] -k KEYSPACE -t TABLE -sh START_HOUR -sm START_MINUTE [-dcs DC_EXCLUSIONS [DC_EXCLUSIONS ...]] [-u URL]show this help message and exit
keyspace
table
start hour
start minute
datacenters to exclude (format: <dc1> <dc2> … <dcN>)
ecchronos host URL (format: http://<host>:<port>)
Get information about repairs for tables. The repair information is based on repair history, meaning both manual and scheduled repairs will be a part of the repair information. This subcommand requires the user to provide either –since or –duration if –keyspace and –table is not provided. If repair info is fetched for a specific table using –keyspace and –table, the duration will default to the table’s GC_GRACE_SECONDS.
usage: ecctool repair-info [-h] [-c COLUMNS] [-k KEYSPACE] [-t TABLE] [-s SINCE] [-d DURATION] [--local] [-u URL] [-l LIMIT] [-o OUTPUT]show this help message and exit
table columns to display (format: 0,1,2,…,N)
keyspace
table
repair information from specified date (ISO8601 format) to now (required unless using –duration or –keyspace/–table)
repair information for specified duration (ISO8601 or simple format: 5s, 5m, 5h, 5d) from now-duration to now (required unless using –since or –keyspace/–table)
local node only
ecchronos host URL (format: http://<host>:<port>)
limit output rows (use -1 for no limit)
output formats: json, table (default)
Show the status of all manual repairs.
usage: ecctool repairs [-h] [-c COLUMNS] [-k KEYSPACE] [-t TABLE] [-u URL] [-i ID] [-l LIMIT] [-o OUTPUT] [--hostid HOSTID]show this help message and exit
table columns to display (format: 0,1,2,…,N)
keyspace (mutually exclusive with -i/–id)
table (requires -k/–keyspace and is mutually exclusive with -i/–id)
ecchronos host URL (format: http://<host>:<port>)
only matching id (mutually exclusive with -k/–keyspace and -t/–table)
limit output rows (use -1 for no limit)
output formats: json, table (default)
show repairs for specified cassandra instance host id
Triggers a manual repair in ecChronos. This will be done through the Cassandra JMX interface.
usage: ecctool run-repair [-h] [-c COLUMNS] [-u URL] [--local] [-o OUTPUT] [-r REPAIR_TYPE] [-k KEYSPACE] [-t TABLE]show this help message and exit
table columns to display (format: 0,1,2,…,N)
ecchronos host URL (format: http://<host>:<port>)
local node only
output formats: json, table (default)
type of repair (accepted values: vnode, parallel_vnode and incremental)
keyspace (applies to all tables within the keyspace with a replication factor greater than 1)
table (requires -k/–keyspace)
Show which (if any) job is currently running.
usage: ecctool running-job [-h] [-o OUTPUT] [-u URL]show this help message and exit
output formats: json (defaults to no format)
ecchronos host URL (format: http://<host>:<port>)
Show the status of schedules.
usage: ecctool schedules [-h] [-c COLUMNS] [-f] [-i ID] [-k KEYSPACE] [-l LIMIT] [-o OUTPUT] [-t TABLE] [-u URL]show this help message and exit
table columns to display (format: 0,1,2,…,N)
show full schedules with configuration and vnode state (requires -i/–id)
only matching id (mutually exclusive with -k/–keyspace and -t/–table)
keyspace (mutually exclusive with -i/–id)
limit output rows (use -1 for no limit)
output formats: json, table (default)
table (requires -k/–keyspace and is mutually exclusive with -i/–id)
ecchronos host URL (format: http://<host>:<port>)
Start the ecChronos service.
usage: ecctool start [-h] [-f] [-o OUTPUT] [-p PIDFILE]show this help message and exit
run in foreground (executes in current terminal and logs to stdout)
output formats: json (defaults to no format)
file for storing process id
View status of the ecChronos instance.
usage: ecctool status [-h] [-u URL] [-o OUTPUT]show this help message and exit
ecchronos host URL (format: http://<host>:<port>)
output formats: json (defaults to no format)
Stop the ecChronos service (sends SIGTERM to the process).
usage: ecctool stop [-h] [-o OUTPUT] [-p PIDFILE]show this help message and exit
output formats: json (defaults to no format)
file containing process id
For example usage and explanation about output refer to ECCTOOL_EXAMPLES.md