add
Данной командой осуществляется добавление нового пользователя.
Синтаксис
add {–login <LOGIN>} [–name <NAME>] {–role <ROLE>} [–surname <SURNAME>]Параметры
–login <LOGIN> — указание логина создаваемого пользователя, где <LOGIN> — строка длиной до 128 символов, которая не может содержать пробелы;
--name <NAME> — указание имени создаваемого пользователя, которое будет видно в профиле пользователя, где <NAME> — строка длиной до 128 символов, которая не может содержать пробелы;
--role <ROLE> — указание роли создаваемого пользователя, где <ROLE> может принимать следующие значения:
- watcher — пользователь, у которого есть права только на просмотр информации Offline ELM;
- manager — пользователь с правами на просмотр и управление всеми процессами Offline ELM за исключением управления пользователями;
- admin — пользователь с полными правами на просмотр и управление всеми процессами Offline ELM.
--surname <SURNAME> — указание фамилии создаваемого пользователя, которое будет видно в профиле пользователя, где <SURNAME> — строка длиной до 128 символов, которая не может содержать пробелы.
Раздел интерфейса командной строки
users
Пример:
elmi-users> add --login user --name Tester --role admin --surname User Enter new password (Ctrl+C to cancel): ******** Repeat new password (Ctrl+C to cancel): ******** User created: Login: user Name: Tester Surname: User Registered: 1723171258 (2024-08-09 09:40:58) Permissions: license-view license-manage license-get files-view files-get users-view users-manage hosts-view hosts-manage settings-view settings-manage Password changed: 1723171258 (2024-08-09 09:40:58) Status info: Status: initialize Changed: 1723171258 (2024-08-09 09:40:58) Info: New user Stats: Strikes: 0 OK elmi-users>
delete
Данной командой осуществляется удаление существующего пользователя.
Синтаксис
delete {–login <LOGIN>}
Параметры
–login <LOGIN> — указание логина удаляемого пользователя, где <LOGIN> — служебное имя существующего на Offline ELM пользователя.
Раздел интерфейса командной строки
users
Пример:
elmi-users> delete --login user You will delete user 'user'. Are you sure? (y/N) y OK elmi-users>
show user
Данной командой осуществляется вывод информации о пользователе с указанным логином.
Синтаксис
show user {--login <LOGIN>}
Параметры
–login <LOGIN> — указание логина пользователя, для которого будет отображена подробная информация, где <LOGIN> — служебное имя существующего на Offline ELM пользователя.
Раздел интерфейса командной строки
users
Пример:
elmi-users> show user --login admin Login: admin Permissions: admin Password changed: 1723103929 (2024-08-08 14:58:49) Status info: Status: valid Changed: 1723103929 (2024-08-08 14:58:49) Stats: Last logged in: 1723103922 (2024-08-08 14:58:42) Last try login: 1723103922 (2024-08-08 14:58:42) Strikes: 0 elmi-users>
show users
Данной командой осуществляется вывод информации о всех зарегистрированных в Offline ELM пользователях.
Синтаксис
show users [–limit <LIMIT>] [–mode <MODE>] [–order <ORDER>] [–skip <SKIP>] [–sort <SORT>]
Параметры
--limit <LIMIT> — указание количества отображаемых в выводе команды записей, где <LIMIT> — число в диапазоне от 10 до 200, значение по умолчанию — 10;
--mode <MODE> — указание типа отображаемых пользователей, где <MODE> может принимать следующие значения:
- all — все зарегистрированные на Offline ELM пользователи;
- valid — все действующие пользователи Offline ELM;
- blocked — все заблокированные пользователи Offline ELM.
Значение по умолчанию — all.
--order <ORDER> — указание порядка вывода записи, где <ORDER> может принимать следующие значения:
- asc — вывод данных от начала списка;
- desc — вывод данных с конца списка.
Значение по умолчанию — asc.
--skip <SKIP> — указание числа записей, которые будут пропущены от начала списка при выводе, где <SKIP> — положительное число в диапазоне от 0 до 100000, значение по умолчанию — 0.
--sort <SORT> — указание типа сортировки записей в выводе команды, где <SORT> может принимать следующие значения:
- login — сортировка по логину пользователя;
- name — сортировка по имени пользователя;
- surname — сортировка по фамилии пользователя;
- register — сортировка по дате регистрации пользователя;
- status — сортировка по статусу пользователя.
Значение по умолчанию — login.
Раздел интерфейса командной строки
users
Пример:
elmi-users> show users 1. Login: admin Permissions: admin Status: valid End of list elmi-users>
set password
Данной командой осуществляется смена пароля указанного пользователя.
Синтаксис
set password {–login <LOGIN>}
Параметры
–login <LOGIN> — указание логина пользователя, чей пароль будет изменен, где <LOGIN> — служебное имя существующего на Offline ELM пользователя.
Раздел интерфейса командной строки
users
Пример:
elmi-users> set password --login admin Enter new password (Ctrl+C to cancel): ******** Repeat new password (Ctrl+C to cancel): ******** Password has been successfully changed OK elmi-users>
edit
Данной командой осуществляется редактирование профиля существующего на Offline ELM пользователя.
Синтаксис
edit {–login <LOGIN>} [–name <NAME>] [–role <ROLE>] [–surname <SURNAME>] [–status <STATUS> --info <INFO> | --status blocked --info <INFO> [–expiry <EXPIRY>]]
Параметры
–login <LOGIN> — указание логина редактируемого пользователя, где <LOGIN> — служебное имя существующего на Offline ELM пользователя;
--name <NAME> — указание имени редактируемого пользователя, которое будет видно в профиле пользователя, где <NAME> — строка длиной до 128 символов, которая не может содержать пробелы;
--role <ROLE> — указание роли редактируемого пользователя, где <ROLE> может принимать следующие значения:
- watcher — пользователь, у которого есть права только на просмотр информации Offline ELM;
- manager — пользователь с правами на просмотр и управление всеми процессами Offline ELM за исключением управления пользователями;
- admin — пользователь с полными правами на просмотр и управление всеми процессами Offline ELM.
--surname <SURNAME> — указание фамилии редактируемого пользователя, которое будет видно в профиле пользователя, где <SURNAME> — строка длиной до 128 символов, которая не может содержать пробелы;
–status <STATUS> — указание статуса редактируемого пользователя, где <STATUS> может принимать следующие значения:
- valid — активный, неограниченный пользователь;
- suspect — пользователь, у которого нет ограничений после успешной авторизации, однако будет выдано предупреждение о подозрительной активности с аккаунтом и предложение сменить пароль;
- initialize — пользователь, которому для получение доступа к функционалу Offline ELM необходимо будет сменить пароль в обязательном порядке;
- blocked — заблокированный пользователь, которому запрещена авторизация в Offline ELM до истечения срока действия блокировки.
--info <INFO> — указание информации о причине смены статуса пользователя, где <INFO> — строка длиной до 256 символов. Данный флаг можно использовать только при указании флага --status;
--expiry <EXPIRY> — указание даты окончания блокировки пользователя, где <EXPIRY> задается в виде DD/MM/YYYY, DD.MM.YYYY или DD-MM-YYYY где DD — число, MM — месяц, YYYY — год. Данный флаг можно использовать только при указании флага --status со значением blocked.
Раздел интерфейса командной строки
users
Пример:
elmi-users> edit --login user --role watcher --info new role OK elmi-users>
help
Данной командой выводится список доступных команд для текущего раздела и их параметры.
Синтаксис
help
Параметры
Команда не содержит параметров.
Раздел интерфейса командной строки
users
Пример:
elmi-users> help
Usage: <main class> [command] [command options]
Commands:
main Select Main menu
Usage: main
menu Display CLI menu
Usage: menu
help Display this help
Usage: help
exit Exit from CLI
Usage: exit
q Exit from CLI
Usage: q
quit Exit from CLI
Usage: quit
license Select License menu
Usage: license
settings Settings management
Usage: settings
users Users management
Usage: users
iprules Select IP rules menu
Usage: iprules
set
Usage: set [command] [command options]
Commands:
password Change user password
Usage: password [options]
Options:
* --login
User login
Default: admin
edit Edit user data
Usage: edit [options]
Options:
--expiry
Status expiry date (DD/MM/YYYY or DD.MM.YYYY or DD-MM-YYYY)
--info
User info
--login
User login
--name
User name
--role
User role
--status
User status
--surname
User surname
show
Usage: show [command] [command options]
Commands:
users Show users list
Usage: users [options]
Options:
--limit
Limit of count devices
Default: 10
--mode
Show mode
Default: all
--order
Order
Default: asc
--skip
Count of devices to skip
Default: 0
--sort
Field to sort
Default: login
user Show user info
Usage: user [options]
Options:
* --login
User login
Default: admin
delete Delete user data
Usage: delete [options]
Options:
* --login
User login
Default: user
add Add new user
Usage: add [options]
Options:
* --login
User login
Default: user
--name
User name
* --role
User role
Default: admin
--surname
User surname
elmi-users>