Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


as of VersionCommandDescription

Administrative Commands


admin-clearClear all caches.

Lt. Commander>help admin-clear


NAME
admin-clear - clear all caches

SYNOPSYS
admin-clear


admin-configGet configurations of specific instances.

Lt. Commander>help admin-config


NAME
admin-config - get configurations of specific instances

SYNOPSYS
admin-config [--instance] hel-application-instance

OPTIONS
--instance hel-application-instance
instance id to fetch
[Mandatory]


admin-instanceRetrieve all instances or get a specific service instance by ID.

Lt. Commander>help admin-instance


NAME
admin-instance - retrieve all instances or get a specific service instance by id

SYNOPSYS
admin-instance [[--instance] string]

OPTIONS
--instance string
instance id to fetch
[Optional, default = ]


admin-loggerget or set log levels for specific instances and/or logger s

Lt. Commander>help admin-logger


NAME
admin-logger - get or set log levels for specific instances and/or loggers

SYNOPSYS
admin-logger [--instance] hel-application-instance [[--logger] string] [[--level] string]

OPTIONS
--instance hel-application-instance
instance id to fetch
[Mandatory]

--logger string
logger name to fetch
[Optional, default = ]

--level string
logger level to set
[Optional, default = ]


admin-metricsget metric information for specific instances

Lt. Commander>help admin-metrics


NAME
admin-metrics - get metric information for specific instances

SYNOPSYS
admin-metrics [--instance] hel-application-instance [--metric-name] string

OPTIONS
--instance hel-application-instance
instance id to fetch
[Mandatory]

--metric-name string
metric name to fetch
[Mandatory]


Audit Commands


audit-cleanupcleanup audit entries based on 'cleanupConfiguration.json ' configuration

Lt. Commander>help audit-cleanup


NAME
audit-cleanup - cleanup audit entries based on 'cleanupConfiguration.json' configuration

SYNOPSYS
audit-cleanup [-t] string

OPTIONS
-t or --tenant string
specify tenant
[Mandatory]


Database Commands


dbs-auditget audit entries

Lt. Commander>help dbs-audit


NAME
dbs-audit - get audit entries

SYNOPSYS
dbs-audit [[-t] string] [[-s] string] [[-e] string] [[-tr] string] [[-a] string]

OPTIONS
-t or --tenant string
specify tenant
[Optional, default = ]

-s or --start-date string
Set start date. e.g.: -s 2019-01-21
[Optional, default = ]

-e or --end-date string
Set end date. e.g.: --end-date=2020-01-21
[Optional, default = ]

-tr or --trace-id string
set specific traceid
[Optional, default = ]

-a or --action string
set action. eg. --action=200 for DELETE audit-entry.
[Optional, default = ]


dbs-configureconfigure timeouts

Lt. Commander>help dbs-configure


NAME
dbs-configure - configure timeouts

SYNOPSYS
dbs-configure [-s] [-c] [-f]

OPTIONS
-s or --simulation
turn simulation mode on/off
[Optional, default = false]

-c or --cockroach
Sturn cockroach-db on/off. If cockroach-db is turned 'on', command 'rename' will do updates on database without 'SELECT FOR UPDATE'
[Optional, default = false]

-f or --fulltext
turn fulltext index on/off.
[Optional, default = false]


dbs-reindexreindex all dmsObject from database

Lt. Commander>help dbs-reindex


NAME
dbs-reindex - reindex all dmsObject from database

SYNOPSYS
dbs-reindex [[-t] string] [[-s] string] [[-e] string]

OPTIONS
-t or --tenant string
specify tenant
[Optional, default = ]

-s or --start-date string
Set start date. e.g.: -s 2019-01-21
[Optional, default = ]

-e or --end-date string
Set end date. e.g.: --end-date=2020-01-21
[Optional, default = ]


dbs-renamerename enaio: to system: in database

Lt. Commander>help dbs-rename


NAME
dbs-rename - rename enaio: to system: in database

SYNOPSYS
dbs-rename [[-t] string] [[-s] string] [[-e] string]

OPTIONS
-t or --tenant string
specify tenant
[Optional, default = ]

-s or --start-date string
Set start date. e.g.: -s 2019-01-21
[Optional, default = ]

-e or --end-date string
Set end date. e.g.: --end-date=2020-01-21
[Optional, default = ]


dbs-statstat of dmsobjects in table

Lt. Commander>help dbs-stat


NAME
dbs-stat - stat of dmsobjects in table

SYNOPSYS
dbs-stat [[-t] string] [[-s] string] [[-e] string]

OPTIONS
-t or --tenant string
specify tenant
[Optional, default = ]

-s or --start-date string
Set start date. e.g.: -s 2019-01-21
[Optional, default = ]

-e or --end-date string
Set end date. e.g.: --end-date=2020-01-21
[Optional, default = ]


dbs-storagestorage statistics of dmsobjects in database

Lt. Commander>help dbs-storage


NAME
dbs-storage - storage statistics of dmsobjects in database

SYNOPSYS
dbs-storage [[-t] string] [[-s] string] [[-e] string]

OPTIONS
-t or --tenant string
specify tenant
[Optional, default = ]

-s or --start-date string
Set start date. e.g.: -s 2019-01-21
[Optional, default = ]

-e or --end-date string
Set end date. e.g.: --end-date=2020-01-21
[Optional, default = ]


Elasticsearch Commands


ela-findfind objects by id

Lt. Commander>help ela-find


NAME
ela-find - find objects by id

SYNOPSYS
ela-find [-i] string

OPTIONS
-i or --id string
specify id to find. e.g. -i f38d7049-6555-468d-b724-8d4fcc6b16e1
[Mandatory]


Maintenance Commands


maintain-comparea more complex way than 'count' to determine differences between elasticsearch and database.

Lt. Commander>help maintain-compare


NAME
maintain-compare - a more complex way than 'count' to determine differences between elasticsearch and database.

SYNOPSYS
maintain-compare [[-t] string] [[-s] date-time] [[-e] date-time] [[-m] comparison-mode] [-c]

OPTIONS
-t or --tenant string
specify tenant
[Optional, default = ]

-s or --start-date date-time
Set start date. e.g.: -s 2019-01-21
[Optional, default = firstobjectcreation]

-e or --end-date date-time
Set end date. e.g.: --end-date=2020-01-21
[Optional, default = today]

-m or --mode comparison-mode
Define which comparison mode should be used
[Optional, default = ADVANCED]

-c or --useCreationDate
Use creation date instead of modification date
[Optional, default = false]


maintain-countsimple check to compare the amount of objects in elasticsearch and database

Lt. Commander>help maintain-count


NAME
maintain-count - simple check to compare the amount of objects in elasticsearch and database

SYNOPSYS
maintain-count [[-t] string] [[-s] date-time] [[-e] date-time] [-c]

OPTIONS
-t or --tenant string
specify tenant
[Optional, default = ]

-s or --start-date date-time
Set start date. e.g.: -s 2019-01-21
[Optional, default = firstobjectcreation]

-e or --end-date date-time
Set end date. e.g.: --end-date=2020-01-21
[Optional, default = today]

-c or --useCreationDate
Use creation date instead of modification date
[Optional, default = false]


maintain-exportThis command exports all objects of a chosen tenant. For every object a folder is created, containing the objects metadata as json and content file.

Lt. Commander>help maintain-export


NAME
maintain-export - This command exports all objects of a chosen tenant. For every object a folder is created, containing the objects metadata as json and content file.

SYNOPSYS
maintain-export [--tenant] string [[--fetch-size] int] [[--folder-size] int] [[--target-directory] file] [[--start-date] date-time] [[--end-date] date-time]

OPTIONS
--tenant string
specify the tenant to export
[Mandatory]

--fetch-size int
specify fetch size for database requests
[Optional, default = 1000]
[fetch size must be at least 1]
[fetch size must not be bigger than 100000]

--folder-size int
specify the maximum items per folder to prevent performance issues when browsing folders
[Optional, default = 5000]
[folder size must not be bigger than 10000]
[folder size must be at least 1]

--target-directory file
specify target directory for exported items
[Optional, default = .]

--start-date date-time
specify start date, every item which was created since this date will be exported (e.g. 2018-03-13), if nothing is specified the first creationdate will be used
[Optional, default = firstobjectcreation]

--end-date date-time
specify end date, every item which was created until this date will be exported (e.g. 2021-03-13), if nothing is specified the end date is today
[Optional, default = today]


maintain-repositoryCommand to find files in an s3 storage and detect unreferenced files (check for reference in either database dmsobject or dmsobject_oldversions)

Lt. Commander>help maintain-repository


NAME
maintain-repository - Command to find files in an s3 storage and detect unreferenced files (check for reference in either database dmsobject or dmsobject_oldversions)

SYNOPSYS
maintain-repository [-r] set [[-i] file]

OPTIONS
-r or --repositoryId set
Which repositories should be analyzed.
[Mandatory]

-i or --input file
Use this file as alternative input.
[Optional, default = ]