ecctool is a command line utility which can be used to perform actions towards a local ecChronos instance. The actions are implemented in form of subcommands with arguments. All visualization is displayed in form of human-readable tables.
usage: ecctool [-h]
{repairs,schedules,run-repair,repair-info,start,stop,status}
...show this help message and exit
Get information about repairs for tables. The repair information is based on repair history, meaning that both manual repairs and schedules will contribute to 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] [-k KEYSPACE] [-t TABLE] [-s SINCE]
[-d DURATION] [--local] [-u URL] [-l LIMIT]show this help message and exit
Show repair information for all tables in the specified keyspace.
Show repair information for the specified table. Keyspace argument -k or –keyspace becomes mandatory if using this argument.
Show repair information since the specified date to now. Date must be specified in ISO8601 format. The time-window will be since to now. Mandatory if –duration or –keyspace and –table is not specified.
Show repair information for the duration. Duration can be specified as ISO8601 format or as simple format in form: 5s, 5m, 5h, 5d. The time-window will be now-duration to now. Mandatory if –since or –keyspace and –table is not specified.
Show repair information only for the local node.
The ecChronos host to connect to, specified in the format http://<host>:<port>.
Limits the number of rows printed in the output. Specified as a number, -1 to disable limit.
Show the status of all manual repairs. This subcommand has no mandatory parameters.
usage: ecctool repairs [-h] [-k KEYSPACE] [-t TABLE] [-u URL] [-i ID]
[-l LIMIT] [--hostid HOSTID]show this help message and exit
Show repairs for the specified keyspace. This argument is mutually exclusive with -i and –id.
Show repairs for the specified table. Keyspace argument -k or –keyspace becomes mandatory if using this argument. This argument is mutually exclusive with -i and –id.
The ecChronos host to connect to, specified in the format http://<host>:<port>.
Show repairs matching the specified ID. This argument is mutually exclusive with -k, –keyspace, -t and –table.
Limits the number of rows printed in the output. Specified as a number, -1 to disable limit.
Show repairs for the specified host id. The host id corresponds to the Cassandra instance ecChronos is connected to.
Run a manual repair. The manual repair will be triggered in ecChronos. EcChronos will perform repair through Cassandra JMX interface. This subcommand has no mandatory parameters.
usage: ecctool run-repair [-h] [-u URL] [--local] [-r REPAIR_TYPE]
[-k KEYSPACE] [-t TABLE]show this help message and exit
The ecChronos host to connect to, specified in the format http://<host>:<port>.
Run repair for the local node only, i.e repair will only be performed for the ranges that the local node is a replica for.
The type of the repair, possible values are ‘vnode’, ‘parallel_vnode’, ‘incremental’
Run repair for the specified keyspace. Repair will be run for all tables within the keyspace with replication factor higher than 1.
Run repair for the specified table. Keyspace argument -k or –keyspace becomes mandatory if using this argument.
Show the status of schedules. This subcommand has no mandatory parameters.
usage: ecctool schedules [-h] [-k KEYSPACE] [-t TABLE] [-u URL] [-i ID] [-f]
[-l LIMIT]show this help message and exit
Show schedules for the specified keyspace. This argument is mutually exclusive with -i and –id.
Show schedules for the specified table. Keyspace argument -k or –keyspace becomes mandatory if using this argument. This argument is mutually exclusive with -i and –id.
The ecChronos host to connect to, specified in the format http://<host>:<port>.
Show schedules matching the specified ID. This argument is mutually exclusive with -k, –keyspace, -t and –table.
Show full schedules, can only be used with -i or –id. Full schedules include schedule configuration and repair state per vnode.
Limits the number of rows printed in the output. Specified as a number, -1 to disable limit.
Start the ecChronos service. This subcommand has no mandatory parameters.
usage: ecctool start [-h] [-f] [-p PIDFILE]show this help message and exit
Start the ecChronos instance in foreground mode (exec in current terminal and log to stdout)
Start the ecChronos instance and store the pid in the specified pid file.
View status of ecChronos instance. This subcommand has no mandatory parameters.
usage: ecctool status [-h] [-u URL]show this help message and exit
The ecChronos host to connect to, specified in the format http://<host>:<port>.
Stop the ecChronos instance. Stopping of ecChronos is done by using kill with SIGTERM signal (same as kill in shell) for the pid. This subcommand has no mandatory parameters.
usage: ecctool stop [-h] [-p PIDFILE]show this help message and exit
Stops the ecChronos instance by pid fetched from the specified pid file.
For example usage and explanation about output refer to ECCTOOL_EXAMPLES.md
Show which (if any) job that is currently running.
usage: ecctool running-job [-h] [-u URL]
Show which (if any) job is currently running
optional arguments:
-h, --help show this help message and exit
-u URL, --url URL The ecChronos host to connect to, specified in the format http://<host>:<port>.show this help message and exit
The ecChronos host to connect to, specified in the format http://<host>:<port>.