as of Version | Command | Description | |
---|---|---|---|
Administrative Commands | |||
admin-clear | Clear all caches. |
Lt. Commander>help admin-clear
NAME |
Clear all caches. SYNOPSYS | |
admin-config |
Retrieve configurations of specific instances. |
Lt. Commander>help admin-config
NAME |
Get configurations of specific instances. SYNOPSYS OPTIONS |
of which configurations to be retrieved. | ||
admin-instance | Retrieve all service instances or get a specific service instance by ID |
. |
NAME |
Retrieve all instances or get a specific service instance by |
ID. SYNOPSYS OPTIONS |
to |
be retrieved. | |
admin-logger |
Retrieve or set log levels for specific instances and/or |
loggers. | NAME |
Retrieve or set log levels for specific instances and/or loggers. SYNOPSYS OPTIONS |
ID of the instance for which log levels to be retrieved/set. --logger string |
Name of logger within the specified instance for which log levels to be retrieved/set. --level string |
Logger level to be set. | |
admin-metrics |
Retrieve metric information for specific instances |
. |
NAME |
Retrieve metric information for specific instances. SYNOPSYS OPTIONS |
ID of the instance for which metrics are to be retrieved. --metric-name string |
to |
be retrieved. | |||
Audit Commands | |||
audit-cleanup |
Clean up audit entries based on the 'cleanupConfiguration.json' configuration |
. |
NAME |
Clean up audit entries based on the 'cleanupConfiguration.json' configuration. SYNOPSYS OPTIONS |
[Mandatory
Tenant for which audit entries are to be cleaned up. | |||
Database Commands | |||
dbs-audit |
Retrieve audit entries |
. |
NAME |
Retrieve audit entries. SYNOPSYS OPTIONS |
Tenant for which audit entries are to be retrieved. -s or --start-date string |
Start date |
, e.g.: -s 2019-01-21 -e or --end-date string |
End date |
, e.g.: --end-date=2020-01-21 -tr or --trace-id string |
TraceId that has to match the traceIds of the audit entries to be retrieved. -a or --action string |
Action that has to match the actions of the audit entries to be retrieved, e.g., --action=200 for DELETE audit-entry. | |
dbs-configure |
Configure timeouts |
. |
NAME |
Configure timeouts. SYNOPSYS OPTIONS |
Simulation mode turned on/off. -c or --cockroach |
Cockroach-db turned on/off. If cockroach-db is turned 'on', |
the 'dbs-rename' command will |
perform updates on database without 'SELECT FOR UPDATE'. -f or --fulltext |
Full-text index turned on/off. | |
dbs-reindex |
Reindex all |
DMS objects from database |
. |
NAME |
Reindex all |
DMS objects from database. SYNOPSYS OPTIONS |
Tenant for which DMS objects are to be reindexed. -s or --start-date string |
Start date |
, e.g.: -s 2019-01-21 -e or --end-date string |
End date |
, e.g.: --end-date=2020-01-21 | |
dbs-rename |
Rename enaio: to system: in database |
. |
NAME |
Rename enaio: to system: in database. SYNOPSYS OPTIONS |
Tenant for which renaming is to be performed. -s or --start-date string |
Start date |
, e.g.: -s 2019-01-21 -e or --end-date string |
End date |
, e.g.: --end-date=2020-01-21 | ||
dbs-stat | stat of dmsobjects in table |
NAME SYNOPSYS OPTIONS -s or --start-date string |
, e.g.: -s 2019-01-21 -e or --end-date string |
, e.g.: --end-date=2020-01-21 | ||
dbs-storage | Retrieve storage statistics of |
DMS objects in database |
. |
NAME |
DMS objects in database. SYNOPSYS OPTIONS |
Tenant for which storage statistics are to be retrieved. -s or --start-date string |
Start date |
, e.g.: -s 2019-01-21 -e or --end-date string |
End date |
, e.g.: --end-date=2020-01-21 | |||
Elasticsearch Commands | |||
ela-find |
Find objects by |
ID. | NAME |
Find objects by |
ID. SYNOPSYS OPTIONS |
ID to be searched for, e.g.: -i f38d7049-6555-468d-b724-8d4fcc6b16e1 | |||
Maintenance Commands | |||
maintain-compare | Determine differences between Elasticsearch index and database in a more complex way than 'count' |
. |
NAME |
. SYNOPSYS OPTIONS |
Tenant for which the comparison should be performed. -s or --start-date date-time |
Start date |
, e.g.: -s 2019-01-21 -e or --end-date date-time |
End date |
, e.g.: --end-date=2020-01-21 -m or --mode comparison-mode |
Comparison mode |
to be used. Available values are 'COUNT', 'BASIC' and 'ADVANCED'. -c or --useCreationDate |
Creation date used instead of modification date (if 'true'). | |
maintain-count |
Compare the number of objects in |
Elasticsearch index and database |
via a simple check. | NAME |
Compare the number of objects in |
Elasticsearch index and database via a simple check. SYNOPSYS OPTIONS |
Tenant for which the comparison should be performed. -s or --start-date date-time |
Start date |
, e.g.: -s 2019-01-21 -e or --end-date date-time |
End date |
, e.g.: --end-date=2020-01-21 -c or --useCreationDate |
Creation date used instead of modification date (if 'true'). | |
maintain-export |
Exports all objects of a |
specific tenant. For every object a folder is created, containing the |
object's metadata in JSON format and its content file if available. |
Lt. Commander>help maintain-export
NAME |
Exports all objects of a |
specific tenant. For every object a folder is created, containing the |
object's metadata in JSON format and its content file if available. SYNOPSYS OPTIONS |
Tenant for which all objects should be exported. --fetch-size int |
Fetch size for database requests. --folder-size int |
Maximum number of items per folder to prevent performance issues when browsing folders. --target-directory file |
Target directory for exported items. --start-date date-time |
Start date. Every item which was created since this date will be exported (e.g., 2018-03-13) |
. If not specified, the first |
creation date will be used. --end-date date-time |
End date. Every item which was created until this date will be exported (e.g. 2021-03-13) |
. If not specified, the end date is today. | |
maintain-repository |
Find files in an |
S3 storage and detect unreferenced files (check for reference in either database dmsobject or dmsobject_oldversions) |
. |
NAME |
Find files in an |
S3 storage and detect unreferenced files (check for reference in either database dmsobject or dmsobject_oldversions). SYNOPSYS OPTIONS |
IDs of repositories |
to be analyzed. -i or --input file |
Name of a file to be used as alternative input. |