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

Clear all caches.

SYNOPSYS
admin-clear


admin-config
Get
Retrieve configurations of specific instances.

Lt. Commander>help admin-config

NAME
admin-config -

get

Get configurations of specific instances.

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

OPTIONS
--instance hel-application-instance
ID of instance

id to fetch

of which configurations to be retrieved.
[Mandatory]


admin-instanceRetrieve all service instances or get a specific service instance by ID
.Lt
.
Commander>help admin-instance

NAME
admin-instance -

retrieve

Retrieve all instances or get a specific service instance by

id

ID.

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

OPTIONS
--instance string
ID of instance

id

to

fetch

be retrieved.
[Optional, default = ]


admin-logger
get
Retrieve or set log levels for specific instances and/or
logger sLt. Commander>help admin-logger
loggers.

NAME
admin-logger -

get

Retrieve 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

ID of the instance for which log levels to be retrieved/set.
[Mandatory]

--logger string

logger name to fetch

Name of logger within the specified instance for which log levels to be retrieved/set.
[Optional, default = ]

--level string

logger

Logger level to be set.
[Optional, default = ]


admin-metrics
get
Retrieve metric information for specific instances
Lt
.
Commander>help admin-metrics

NAME
admin-metrics -

get

Retrieve metric information for specific instances.

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

OPTIONS
--instance hel-application-instance

instance id to fetch

ID of the instance for which metrics are to be retrieved.
[Mandatory]

--metric-name string
Name of the metric

name

to

fetch

be retrieved.
[Mandatory]


Audit Commands


audit-cleanup
cleanup
Clean up audit entries based on the 'cleanupConfiguration.json' configuration
Lt
.
Commander>help audit-cleanup

NAME
audit-cleanup -

cleanup

Clean up audit entries based on the 'cleanupConfiguration.json' configuration.

SYNOPSYS
audit-cleanup [-t] string

OPTIONS
-t or --tenant string

specify tenant
[Mandatory

Tenant for which audit entries are to be cleaned up.
[Optional, default = ]


Database Commands


dbs-audit
get
Retrieve audit entries
Lt
.
Commander>help dbs-audit

NAME
dbs-audit -

get

Retrieve audit entries.

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

OPTIONS
-t or --tenant string

specify tenant

Tenant for which audit entries are to be retrieved.
[Optional, default = ]

-s or --start-date string

Set start

Start date

.

, e.g.: -s 2019-01-21
[Optional, default = ]

-e or --end-date string

Set end

End date

.

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

-tr or --trace-id string

set specific traceid

TraceId that has to match the traceIds of the audit entries to be retrieved.
[Optional, default = ]

-a or --action string

set action. eg.

Action that has to match the actions of the audit entries to be retrieved, e.g., --action=200 for DELETE audit-entry.
[Optional, default = ]


dbs-configure
configure
Configure timeouts
Lt
.
Commander>help dbs-configure

NAME
dbs-configure -

configure

Configure timeouts.

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

OPTIONS
-s or --simulation

turn simulation

Simulation mode turned on/off.
[Optional, default = false]

-c or --cockroach

Sturn cockroach

Cockroach-db turned on/off. If cockroach-db is turned 'on',

command

the 'dbs-rename' command will

do

perform updates on database without 'SELECT FOR UPDATE'.
[Optional, default = false]

-f or --fulltext

turn fulltext

Full-text index turned on/off.
[Optional, default = false]


dbs-reindex
reindex
Reindex all
dmsObject
DMS objects from database
Lt
.
Commander>help dbs-reindex

NAME
dbs-reindex -

reindex

 Reindex all

dmsObject

DMS objects from database.

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

OPTIONS
-t or --tenant string

specify tenant

Tenant for which DMS objects are to be reindexed.
[Optional, default = ]

-s or --start-date string

Set start

Start date

.

, e.g.: -s 2019-01-21
[Optional, default = ]

-e or --end-date string

Set end

End date

.

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


dbs-rename
rename
Rename enaio: to system: in database
Lt
.
Commander>help dbs-rename

NAME
dbs-rename -

rename

Rename enaio: to system: in database.

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

OPTIONS
-t or --tenant string

specify tenant

Tenant for which renaming is to be performed.
[Optional, default = ]

-s or --start-date string

Set start

Start date

.

, e.g.: -s 2019-01-21
[Optional, default = ]

-e or --end-date string

Set end

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-storageRetrieve storage statistics of
dmsobjects
DMS objects in database
Lt
.
Commander>help dbs-storage

NAME
dbs-storage - Retrieve storage statistics of

dmsobjects

DMS objects in database.

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

OPTIONS
-t or --tenant string

specify tenant

Tenant for which storage statistics are to be retrieved.
[Optional, default = ]

-s or --start-date string

Set start

Start date

.

, e.g.: -s 2019-01-21
[Optional, default = ]

-e or --end-date string

Set end

End date

.

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


Elasticsearch Commands


ela-find
find
Find objects by
idLt. Commander>help ela-find
ID.

NAME
ela-find -

find

Find objects by

id

ID.

SYNOPSYS
ela-find [-i] string

OPTIONS
-i or --id string

specify id to find.

ID to be searched for, e.g.: -i f38d7049-6555-468d-b724-8d4fcc6b16e1
[Mandatory]


Maintenance Commands


maintain-compareDetermine differences between Elasticsearch index and database in a more complex way than 'count'
to determine differences between elasticsearch and database
.
Lt. Commander>help maintain-compare

NAME
maintain-compare - Determine differences between Elasticsearch index and database in 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

Tenant for which the comparison should be performed.
[Optional, default = ]

-s or --start-date date-time

Set start

Start date

.

, e.g.: -s 2019-01-21
[Optional, default = firstobjectcreation]

-e or --end-date date-time

Set end

End date

.

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

-m or --mode comparison-mode

Define which comparison

Comparison mode

should

to be used. Available values are 'COUNT', 'BASIC' and 'ADVANCED'.
[Optional, default = ADVANCED]

-c or --useCreationDate

Use creation

Creation date used instead of modification date (if 'true').
[Optional, default = false]


maintain-count
simple check to compare the amount
Compare the number of objects in
elasticsearch
Elasticsearch index and database
Lt. Commander>help maintain-count
via a simple check.

NAME
maintain-count -

simple check to compare the amount

 Compare the number of objects in

elasticsearch

Elasticsearch index and database via a simple check.

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

OPTIONS
-t or --tenant string

specify tenant

Tenant for which the comparison should be performed.
[Optional, default = ]

-s or --start-date date-time

Set start

Start date

.

, e.g.: -s 2019-01-21
[Optional, default = firstobjectcreation]

-e or --end-date date-time

Set end

End date

.

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

-c or --useCreationDate

Use creation

Creation date used instead of modification date (if 'true').
[Optional, default = false]


maintain-export
This command exports
Exports all objects of a
chosen
specific tenant. For every object a folder is created, containing the
objects metadata as json and
object's metadata in JSON format and its content file if available.

Lt. Commander>help maintain-export

NAME
maintain-export -

This command exports

 Exports all objects of a

chosen

specific tenant. For every object a folder is created, containing the

objects metadata as json and

object's metadata in JSON format and its content file if available.

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

Tenant for which all objects should be exported.
[Mandatory]

--fetch-size int

specify fetch

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

Maximum number of 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

Target directory for exported items.
[Optional, default = .]

--start-date date-time

specify start date, every

Start date. Every item which was created since this date will be exported (e.g., 2018-03-13)

, if nothing is specified

. If not specified, the first

creationdate

creation date will be used.
[Optional, default = firstobjectcreation]

--end-date date-time

specify end date, every

End date. Every item which was created until this date will be exported (e.g. 2021-03-13)

, if nothing is specified

. If not specified, the end date is today.
[Optional, default = today]


maintain-repository
Command to find
Find files in an
s3
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

 Find files in an

s3

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

IDs of repositories

should

to be analyzed.
[Mandatory]

-i or --input file

Use this file

Name of a file to be used as alternative input.
[Optional, default = ]