show groups
Данной командой осуществляется вывод информации о служебных группах IP-правил, существующих на Offline ELM.
Синтаксис
show groups
Параметры
Команда не содержит параметров.
Раздел интерфейса командной строки
iprules
Пример:
elmi-iprules> show groups 1. IP group: elm Mode: deny 2. IP group: web Mode: trust elmi-iprules>
show iprules
Данной командой осуществляется вывод информации о всех IP-правилах, существующих в рамках определенной служебной группы IP-правил.
Синтаксис
show iprules {–group <GROUP>} [–ip <IP>] [–limit <LIMIT>] [–mode <MODE>] [–order <ORDER>] [–skip <SKIP>] [–sort <SORT>] [–status <STATUS>]
Параметры
--group <GROUP> — указание служебной группы IP-правил, для которой необходимо вывести существующие в ней IP-правила, где <GROUP> может принимать следующие значения:
- elm — группа IP-правил, ограничивающая доступ к Offline ELM со стороны клиентских устройств;
- web — группа IP-правил, ограничивающая доступ к Offline ELM со стороны web-интерфейса.
--ip <IP> — указание IP-адреса (прямое или по wildmask), для которого требуется осуществить выборку IP-правил. <IP> задается в виде AAA.BBB.CCC.DDD, где каждая часть принимает значения от 0 до 255, а любая цифра может быть заменена "*";
--limit <LIMIT> — указание количества отображаемых в выводе команды записей, где <LIMIT> — число в диапазоне от 10 до 200, значение по умолчанию — 10;
--mode <MODE> — указание типа отображаемых пользователей, где <MODE> может принимать следующие значения:
- all — все IP-правила, существующие в группе;
- actual — все действующие IP-правила в группе;
- expired — все правила в IP-группе, чей срок действия истек.
Значение по умолчанию — all.
--order <ORDER> — указание порядка вывода записи, где <ORDER> может принимать следующие значения:
- asc — вывод данных от начала списка;
- desc — вывод данных с конца списка.
Значение по умолчанию — asc.
--skip <SKIP> — указание числа записей, которые будут пропущены от начала списка при выводе, где <SKIP> — положительное число в диапазоне от 0 до 100000, значение по умолчанию — 0.
--sort <SORT> — указание типа сортировки записей в выводе команды, где <SORT> может принимать следующие значения:
- ip — сортировка по IP-адресу;
- tool — сортировка по инструменту создания правила;
- status — сортировка по статусу правила;
- registered — сортировка по дате создания правила;
- updated — сортировка по дате изменения правила;
- expiry — сортировка по дате истечения срока действия правила.
Значение по умолчанию — ip.
--status <STATUS> — указание статуса IP-правила, где <STATUS> может принимать следующие значения:
- allow — разрешающие IP-правила;
- block — блокирующие IP-правила.
Раздел интерфейса командной строки
iprules
Пример:
elmi-iprules> show iprules --group elm IP group: elm Mode: deny 1. Group: elm IP: 18.35.132.131 Status: allow Info: Whitelisted host from DDoS rule 18.35.132.128/29 02/07/21 19:45 Mode: static (cli) Registered: 1723171919 (2024-08-09 09:51:59) Updated: 1723171919 (2024-08-09 09:51:59) 2. Group: elm IP: 97.11.2.182 Status: block Info: API Brutforce 25/06/21 10:15 Counter: 0 Mode: static (cli) Registered: 1723171930 (2024-08-09 09:52:10) Updated: 1723171930 (2024-08-09 09:52:10) End of list elmi-iprules>
add iprule
Данной командой осуществляется добавление блокирующего IP-правила для указанной группы служебных правил Offline ELM.
Синтаксис
add iprule {–group <GROUP>}{–ip }{–action <ACTION>} [–info <INFO>]
Параметры
--group <GROUP> — указание служебной группы IP-правил, в которую будет добавлено создаваемое IP-правило, где <GROUP> может принимать следующие значения:
- elm — группа IP-правил, ограничивающая доступ к Offline ELM со стороны клиентских устройств;
- web — группа IP-правил, ограничивающая доступ к Offline ELM со стороны web-интерфейса.
--ip <IP> — указание IP-адреса, для которого требуется создать IP-правило, где <IP> задается в виде AAA.BBB.CCC.DDD/EE, где части AAA, BBB, CCC и DDD принимают значения от 0 до 255, а часть EE принимает значения от 0 до 32. Указание маски IP-подсети не является обязательным, можно просто указать IP-адрес хоста. При указании IP-адреса с 32 маской он автоматически будет сконвертирован в адрес хоста;
--action <ACTION> — указание типа правила, где <ACTION> может принимать следующие значения:
- allow — разрешающее правило;
- block — запрещающее правило.
--info <INFO> — указание информации об IP-правиле, где <INFO> — строка длиной до 255 символов, при необходимости использования нескольких слов, разделенных пробелами, строка должна быть заключена в двойные кавычки;
--instance — указание ноды, на которую будет распространяться IP-правило.
Раздел интерфейса командной строки
iprules
Пример:
elmi-iprules> add iprule --group elm --ip 18.35.132.131 --action allow --info Whitelisted host from DDoS rule 18.35.132.128/29 02/07/21 19:45 OK elmi-iprules>
elmi-iprules> add iprule --group elm --ip 97.11.2.182 --action block --info API Brutforce 25/06/21 10:15 OK elmi-iprules>
elmi-iprules> add iprule --group elm --ip 97.11.2.0/24 --action block --info API Brutforce 25/06/21 10:15 OK elmi-iprules>
edit iprule
Данной командой осуществляется редактирование существующего на Offline ELM IP-правила.
Синтаксис
edit iprule {–group <GROUP>}{–ip <IP>} [–info <INFO>] [--new-ip <IP OR SUBNET>][--action ALLOW|BLOCK][--unexpired]
Параметры
--group <GROUP> — указание служебной группы IP-правил, в которой находится редактируемое IP-правило, где <GROUP> может принимать следующие значения:
- elm — группа IP-правил, ограничивающая доступ к Offline ELM со стороны клиентских устройств;
- web — группа IP-правил, ограничивающая доступ к Offline ELM со стороны web-интерфейса.
--ip <IP> — указание IP-адреса редактируемого IP-правила, где <IP> задается в виде AAA.BBB.CCC.DDD, где каждая часть принимает значения от 0 до 255;
--info <INFO> — указание информации о редактируемом IP-правиле, где <INFO> — строка длиной до 255 символов;
--action <ACTION> — указание типа правила, где <ACTION> может принимать следующие значения:
- allow — разрешающее правило;
- block — запрещающее правило.
--unexpired — указание флага, при наличии которого правило с ограниченным сроком действия становится бессрочным;
--instance — указание ноды, на которую будет распространяться IP-правило.
Раздел интерфейса командной строки
iprules
Пример:
elmi-iprules> edit iprule --group elm --ip 18.35.132.131 --info Whitelisted host from DDoS rule OK elmi-iprules>
delete iprule
Данной командой осуществляется удаление существующего на Offline ELM IP-правила.
Синтаксис
delete iprule {–group <GROUP>} {–ip <IP>}
Параметры
--group <GROUP> — указание служебной группы IP-правил, в которой находится удаляемое IP-правило, где <GROUP> может принимать следующие значения:
- elm — группа IP-правил, ограничивающая доступ к Offline ELM со стороны клиентских устройств;
- web — группа IP-правил, ограничивающая доступ к Offline ELM со стороны web-интерфейса.
--ip <IP> — указание IP-адреса удаляемого IP-правила, где <IP> задается в виде AAA.BBB.CCC.DDD, где каждая часть принимает значения от 0 до 255.
Раздел интерфейса командной строки
iprules
Пример:
elmi-iprules> delete iprule --group elm --ip 10.11.12.13 You will delete rule for IP 10.11.12.13. Are you sure? (y/N) y OK elmi-iprules>
check ip
Данной командой осуществляется проверка доступа указанного IP-адреса до Offline ELM в рамках конкретной служебной группы IP-правил.
Синтаксис
check ip {–group <GROUP>} {–ip <IP>}
Параметры
--group <GROUP> — указание служебной группы IP-правил, для которой необходимо вывести проверку указанного IP-адреса, где <GROUP> может принимать следующие значения:
- elm — группа IP-правил, ограничивающая доступ к Offline ELM со стороны клиентских устройств;
- web — группа IP-правил, ограничивающая доступ к Offline ELM со стороны web-интерфейса.
--ip <IP> — указание IP-адреса, для которого требуется осуществить проверку доступа, где <IP> задается в виде AAA.BBB.CCC.DDD, где каждая часть принимает значения от 0 до 255.
Раздел интерфейса командной строки
iprules
Пример:
elmi-iprules> check ip --group elm --ip 18.35.132.131
OK: Access is allowed for IP 18.35.132.131 by IP-rule : ElmIpRule={Group=elm, IP=18.35.132.131, Status=allow, Info=Whitelisted host from DDoS rule 18.35.132.128/29 02/07/21 19:45, Mode=static (cli), Registered=1723171919 (2024-08-09 09:51:59), Updated=1723171919 (2024-08-09 09:51:59)}
elmi-iprules>
check serial
Данной командой осуществляется проверка наличия устройства по серийному номеру, если находит, то берет его IP-адрес (если есть) и проверяет его доступность по IP-правилам группы elm.
Синтаксис
check serial --serial <serial number>
Параметры
--serial <serial> — указание серийного номера или ProductID.
Раздел интерфейса командной строки
iprules
Пример:
elmi-iprules> check serial --serial ECMC0000001 OK: No blocked rules for IP 172.25.0.1 in group elm elmi-iprules>
elmi-iprules> check serial --serial ECMC0000001
ERROR Access denied: Access is blocked for IP 172.25.0.1 by IP-rule: ElmIpRule={Group=elm, IP=172.25.0.1, Status=block, Counter=0, Mode=static (cli), Registered=1723172282 (2024-08-09 09:58:02), Updated=1723172282 (2024-08-09 09:58:02)}
elmi-iprules>
reset counter
Данной командой осуществляется очистка счетчиков IP-правил.
Синтаксис
reset iprule {–group <GROUP>} [–ip <IP>]
Параметры
--group <GROUP> — указание служебной группы IP-правил, в которой находится удаляемое IP-правило, где <GROUP> может принимать следующие значения:
- elm — группа IP-правил, ограничивающая доступ к Offline ELM со стороны клиентских устройств;
- web — группа IP-правил, ограничивающая доступ к Offline ELM со стороны web-интерфейса.
--ip <IP> — указание IP-адреса IP-правила, счётчики которого необходимо очистить, где <IP> задается в виде AAA.BBB.CCC.DDD, где каждая часть принимает значения от 0 до 255.
Раздел интерфейса командной строки
iprules
Пример:
elmi-iprules> reset counter --group elm --ip 192.168.35.82 OK: Reset counter for rule with IP: 192.168.35.82 elmi-iprules>
help
Данной командой выводится список доступных команд для текущего раздела и их параметры.
Синтаксис
help
Параметры
Команда не содержит параметров.
Раздел интерфейса командной строки
iprules
Пример:
elmi-iprules> 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
edit
Usage: edit [command] [command options]
Commands:
iprule Edit IP rule
Usage: iprule [options]
Options:
--action
Block or allow action
* --group
Group of IP-rules
Default: elm
--info
Rule info
--instance
Instance ID
* --ip
Current IP address or IP wildcard
Default: 18.35.132.131
--unexpired
Set IP rule as unexpired
Default: false
add
Usage: add [command] [command options]
Commands:
iprule Create new IP rule
Usage: iprule [options]
Options:
* --action
Block or allow action
Default: block
* --group
Group of IP-rules
Default: elm
--info
Rule info
--instance
Instance ID
* --ip
IP address
Default: 172.25.0.1
delete
Usage: delete [command] [command options]
Commands:
iprule Delete IP rule
Usage: iprule [options]
Options:
* --group
Group of IP-rules
--instance
Instance ID
* --ip
IP address or IP wildcard
check
Usage: check [command] [command options]
Commands:
ip Check IP availability
Usage: ip [options]
Options:
* --group
Group of IP-rules
Default: elm
--instance
Instance ID
* --ip
IP address
Default: 18.35.132.131
serial Check device IP availability
Usage: serial [options]
Options:
* --serial
Serial number
Default: ECMC0000001
show
Usage: show [command] [command options]
Commands:
iprules Show IP rules
Usage: iprules [options]
Options:
* --group
Group of IP-rules
Default: elm
--instance
Instance ID
--ip
IP address or IP wildcard
--limit
Limit of count rules
Default: 10
--mode
Show mode
Default: actual
--order
Order
Default: asc
--skip
Count of rules to skip
Default: 0
--sort
Field to sort
Default: ip
--source
IP-rule source
Default: all
--status
IP rule status
groups Show IP groups
Usage: groups
reset
Usage: reset [command] [command options]
Commands:
counter Reset counter for blocked IP rules
Usage: counter [options]
Options:
* --group
Group of IP-rules
--instance
Instance ID
--ip
IP address or IP wildcard
elmi-iprules>