Справка по CLI

Справка по CLI

В данном документе описаны команды, которые возможно выполнить в CLI. Для перехода в CLI, необходимо иметь права Администратора Платформы и перейти по данному пути: NetworkingEdge CPEsИмя_CPE → вкладка General → кнопка Console.

Если вы забыли пароль, то посмотреть его возможно следующим путем: NetworkingEdge CPEsИмя_CPE → вкладка General → блок Security → кнопка .

configure clock

Описание команды

Установка новой даты и времени (UTC). Ввод даты и времени выполняется по следующему принципу: год-месяц-день часы:минуты:секунды

Синтаксис

configure clock

Дополнительные параметры

Нет

Пример

username# configure clock
Enter new date:2023-01-19 14:14:14
2023-01-19 14:14:14 (UTC)

configure password

Описание команды

Установка нового пароля CPE для доступа к CLI

Синтаксис

configure password

Дополнительные параметры

Нет

Пример

username # configure password
Enter new password: new_password
Confirm new password: new_password
Password changed

exit | quit

Описание команды

Завершение работы консоли

Синтаксис

exit или quit

Основные параметры

Нет

Дополнительные параметры

Нет

Пример

username # exit
*совершен выход из консоли*

help

Описание команды

Вывод всех доступных команд

Синтаксис

help

Дополнительные параметры

Нет

Пример

username # help
configure clock Установка текущей даты и времени (формат аналогичен команде show clock)
configure password Установка пароля администратора
...
show log messages Показать основной файл журнала

ping

Описание команды

Проверка доступности узла или хоста в сети и измерение времени отклика (задержки) между отправкой запроса и получением ответа, путем отправки ICMP-запросов на указанный IP-адрес. Без указания дополнительных параметров, отправляет ICMP-запросы во внутреннюю сеть (LAN)

Синтаксис

ping

Дополнительные параметры

- lan – Отправка ICMP-запросов во внутреннюю сеть (LAN)\

  • wan1 – Отправка ICMP-запросов во внешнюю сеть через первый WAN-порт\

  • wan2 – Отправка ICMP-запросов во внешнюю сеть через второй WAN-порт

Пример

username # ping lan
Destination IP: 172.16.82.1
Source IP (optional):
Count (default 5): 4
Size (default 56): 24
PING 172.16.82.1 (172.16.82.1) 24(52) bytes of data.
32 bytes from 172.16.82.1: icmp_seq=1 ttl=64 time=0.043 ms
...
--- 172.16.82.1 ping statistics ---
4 packets transmitted, 4 received, 0% packet loss, time 619ms
rtt min/avg/max/mdev = 0.029/0.033/0.043/0.005 ms

request activation

Описание команды

Активация CPE через CLI

Синтаксис

request activation

Дополнительные параметры

Нет

Пример

username # request activation
Enter CPE keygen link: CPE keygen link

request certs

Описание команды

Ввод сертификатов CPE через CLI

Синтаксис

request certs

Дополнительные параметры

Нет

Пример

username # request certs
Enter CPE certs: Certs link

request factory-reset

Описание команды

Неполный сброс CPE до заводских настроек (без сертификатов и ключей)

Синтаксис

request factory-reset

Дополнительные параметры

Нет

Пример

username # request factory-reset
Are you sure you want to reset CPE configuration? (y/n): y
Please reboot to complete factory reset

request factory-reset wipe-certs

Описание команды

Полный сброс CPE до заводских настроек (вместе с установленными сертификатами и ключами)

Синтаксис

request factory-reset wipe-certs

Дополнительные параметры

Нет

Пример

username # request factory-reset wipe-certs
Are you sure you want to reset CPE configuration? (y/n): y
Please reboot to complete factory reset

request poweroff

Описание команды

Программное выключение CPE

Синтаксис

request poweroff

Дополнительные параметры

Нет

Пример

username # poweroff
Are you sure you want to shut down CPE? (y/n): n
Cancelled

request reboot

Описание команды

Перезагрузка CPE

Синтаксис

request reboot

Дополнительные параметры

Нет

Пример

username # request reboot
Are you sure you want to reboot CPE? (y/n): y
Broadcast message from root@cpe_id-39D19134FE81610C (Wed May 10 13:32:33 2023):
The system will reboot now

show arp

Описание команды

Вывод содержимого ARP-таблицы CPE. Она отображает список IP-адресов и соответствующих им MAC-адресов, полученных из ARP-кэша. Без указания дополнительных параметров, выводит содержимое ARP-таблицы CPE внутренней сети (LAN)

Синтаксис

show arp

Дополнительные параметры

- lan – вывод содержимого ARP-таблицы CPE внутренней сети (LAN) \

  • wan1 – вывод содержимого ARP-таблицы CPE внешней сети (WAN1)\

  • wan2 – вывод содержимого ARP-таблицы CPE внешней сети (WAN2)

Пример

username # show arp
169.254.254.3 dev wgd lladdr 00:10:aa:bb:cc:dd PERMANENT
169.254.254.1 dev dia lladdr 00:10:aa:bb:cc:dd PERMANENT
192.168.82.10 dev 9CE4134FE8160F1 lladdr fe:54:00:3e:0c:cc DELAY
169.254.254.5 dev wgra lladdr 00:10:aa:bb:cc:dd PERMANENT

show clock

Описание команды

Вывод времени на CPE

Синтаксис

show clock

Дополнительные параметры

- all – вывод времени и информации об NTP-сервере

Пример

username # show clock
2023-01-19 09:34:08 (UTC)

username # show clock all
Current CPE SW time:
2023-01-19 09:34:01 (UTC)

Current CPE HW time:
Thu Jan 19 09:34:00 2023 0.000000 seconds

NTP status:
remote refid st t when poll reach delay offset jitter
==========================================================
*172.31.254.19 LOCAL(1) 10 u 303 512 377 20.520 -2.139 0.790

show cpe certs

Описание команды

Вывод информации о сертификатах CPE

Синтаксис

show cpe certs

Дополнительные параметры

Нет

Пример

username # show cpe certs
CPE Provision certificate on Partition0:
subject=OU = CSP, O = BiZone LLC, C = RU, CN = test.bi.zone, emailAddress = test@bi.zone
notAfter=Jun 6 11:43:15 2046 GMT

show cpe firmware

Описание команды

Вывод информации об основной, резервной прошивки, а также версии VNF

Синтаксис

show cpe firmware

Дополнительные параметры

Нет

Пример

username # show cpe firmware
CPE firmware version on current partition:
1.X.X-YY-ZZZZZZZZZZZ

CPE firmware version on secondary partition:
1.X.X-YY-ZZZZZZZZZZZ

VNF Firewall version:
1.X.X-YY-ZZZZZZZZZZZ

show cpe model

Описание команды

Вывод модели CPE

Синтаксис

show cpe model

Дополнительные параметры

Нет

Пример

username # show cpe model
'CyberEdge_110'

show cpe ovfenv

Описание команды

Вывод информации о переменном окружении CPE. Данная команда работает в случае, если CPE выполнено в качестве виртуальной машины

Синтаксис

show cpe ovfenv

Дополнительные параметры

Нет

Пример

username # show cpe ovfenv
<?xml version="1.0" encoding="UTF-8"?>
<PlatformSection>
<Kind>VMware ESXi</Kind>
<Version>7.0.2</Version>
<Vendor>VMware, Inc.</Vendor>
<Locale>en</Locale>
</PlatformSection>

show cpe serial

Описание команды

Вывод серийного номера CPE

Синтаксис

show cpe serial

Дополнительные параметры

Нет

Пример

username # show cpe serial
CPE serial number: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXX

show cpe state

Описание команды

Вывод информации о статусе CPE

Синтаксис

show cpe state

Дополнительные параметры

Нет

Пример

username# show cpe state
2023-2-15 11:33:18: [CRT_KEY_PATH_INIT] finished successfully, next step [START_ENV_PROVISION]
2023-2-15 11:33:19: [START_ENV_PROVISION] finished successfully, next step [START_HTTP_PROVISION]
2023-2-15 11:34:20: [START_HTTP_PROVISION] finished successfully, next step [START_UPDATE_SUBSYSTEM]

Состояния выводятся сверху вниз по мере их выполнения. Формат следующий: дата и название текущего состояния, после выводится либо следующее в очереди состояние, либо ошибка выполнения текущего состояния. Ниже приведена таблица с состояниями, их описанием и описанием ошибок, в случае их возникновения:

Имя состояния

Описание состояния

Описание ошибки

CHECK_WG_BZ_EXTENSION_ABILITY

Процесс проверки совместимости модуля ядра WG

Процесс завершился неудачно из-за несовместимости модуля ядра WG с текущей реализацией VISOR (виртуализированного образа)

REMAP_ETH_PORTS

Процесс переназначения портов Ethernet

Процесс переназначения портов Ethernet завершился с ошибкой: [описание ошибки]

UCI_INITIAL_CONF

Настройка флага исходной конфигурации UCI

Нет

FACTORY_SERVICES_UNIT

Запуск служб инициализации

Ошибка при выполнении инициализации системы: [описание ошибки]

FACTORY_NETWORK_INIT

Инициализация сети

Ошибка при выполнении начальной конфигурации сети: [описание ошибки]

CRT_KEY_PATH_INIT

Инициализация путей CRT/Keys

Ошибка при открытии контейнеров LUKS: [описание ошибки]
Ошибка при инициализации путей CRT/Keys: [описание ошибки]

Запуск процесса начальной настройки через ENV-переменную

Ошибка при обновлении сертификатов и ключей через ENV: [описание ошибки]
Ошибка при выполнении начальной настройки через ENV: [описание ошибки]

START_ENV_PROVISION

Выполнение начальной настройки через ENV-переменную. В ENV-переменной может быть 2 токена: токен с сертификатами (применяется только для CPE, использующих стандартные алгоритмы шифрования) и токен для Provision

Нет

START_HTTP_PROVISION

Выполнение начальной настройки через HTTP и обработка возможной ошибки

Процесс начальной настройки через HTTP завершился с ошибкой: [описание ошибки]

START_UPDATE_SUBSYSTEM

Переход в режим ожидания конфигурации от AC

Нет

show cpe uptime

Описание команды

Вывод информации о времени безотказной работы CPE

Синтаксис

show cpe uptime

Дополнительные параметры

Нет

Пример

username# show cpe uptime
11:51:43 up 0:19, 1 user, load average: 0.19, 0.00, 0.20

show dataplane service-route

Описание команды

Вывод всех сервисных маршрутов CPE

Синтаксис

show dataplane service-route

Дополнительные параметры

Нет

Пример

username # show dataplane service-route
Network Cluster Network Nexthop
192.168.159.0/24 false remote-cpe-id: 1, src-port: 1

show dataplane transport-route

Описание команды

Вывод всех транспортных маршрутов CPE

Синтаксис

show dataplane transport-route

Дополнительные параметры

Нет

Пример

username # show dataplane transport-route
Remote-CPE-ID Cluster Neighbour CPE-ID WG-Port-Id WG-Peer-Idx Priority
0 N/A 1 10 7680

show dataplane version

Описание команды

Вывод информации о Data Plane

Синтаксис

show dataplane version

Дополнительные параметры

Нет

Пример

username # show dataplane version
Version: 1.X.X-YY-ZZZZZZZZZZZ
currentCPEID: 3
GOST WG supported: 0
1Gb hugepages: 0
2Mb hugepages: 608
LPM entries: 131072
Flow cache entries: 524288
Current CPU profile STANDARD_PROFILE
Supported profiles STANDARD_PROFILE;

show dataplane workers

Описание команды

Вывод информации о воркерах CPE

Синтаксис

show dataplane workers

Дополнительные параметры

Нет

Пример

username # show dataplane workers
Task Name LCORE ID Invoke frequency Percents
pipelineControlWorker 0 23499 0

show ip address

Описание команды

Вывод информации о сетевых адресах на CPE. Позволяет получить список IP-адресов, назначенных сетевым интерфейсам CPE. Без указания дополнительных параметров, выводит IP-адреса внутренней сети (LAN)

Синтаксис

show ip address

Дополнительные параметры

lan – IP-адреса внутренней сети (LAN)
wan1 – IP-адреса внешней сети (WAN1)
wan2 – IP-адреса внешней сети (WAN2)

Пример

username # show ip address wan1
1: lo: &lt;LOOPBACK,UP,LOWER_UP&gt; mtu 65536 qdisc noqueue state UNKNOWN group default qlen 1000
link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00
inet 127.0.0.1/8 scope host lo
valid_lft forever preferred_lft forever
34: dp_wan: &lt;BROADCAST,MULTICAST,UP,LOWER_UP&gt; mtu 1500 qdisc mq state UNKNOWN group default qlen 1000
link/ether 00:10:aa:bb:cc:ee brd ff:ff:ff:ff:ff:ff
inet 169.254.254.6/31 scope global dp_wan
valid_lft forever preferred_lft forever

show ip route

Описание команды

Вывод информации о маршрутах доступных на CPE, а также, какой следующий узел в сети будет использоваться для доставки IP-пакетов к определенным сетям или хостам

Синтаксис

show ip route

Дополнительные параметры

lan – вывод информации о маршрутах внутренней сети (LAN)
wan1 – вывод информации о маршрутах внешней сети (WAN1)
wan2 – вывод информации о маршрутах внешней сети (WAN2)

Пример

username # show ip route
default via 169.254.254.1 dev dia proto static metric 100
169.254.254.0/31 dev dia proto kernel scope link src 169.254.254.0
169.254.254.2/31 dev wgd proto kernel scope link src 169.254.254.2
169.254.254.4/31 dev wgra proto kernel scope link src 169.254.254.4
172.16.0.0/24 via 169.254.254.3 dev wgd proto static metric 100
172.16.2.0/24 via 169.254.254.3 dev wgd proto static metric 20
172.16.2.0/24 via 169.254.254.3 dev wgd proto static metric 100

show log dataplane

Описание команды

Вывод системного журнала, связанного с пакетной обработкой (Data Plane) на CPE

Синтаксис

show log dataplane

Дополнительные параметры

Нет

Пример

username # show log dataplane
Tc: 0, App SLA: N/A
Init subsys: wg_device: Current timestamp: 1676470430, offset 1676470249
Update WG dev with clusterBackupRole 0
Init subsys: wg_device: Current timestamp: 1676470431, offset 1676470248
Update WG dev with clusterBackupRole 0
Update WG dev with clusterBackupRole 0
Svc route entry 192.168.170.0/24 add with NHs: RemoteCPE_ID: 1, metric: 100;     (FILE: /home/gitlab-runner/builds/bP2g2vm4/0/MSS/secure-sd-wan/cpe/buildroot/output/build/bz-cpp-dataplane-1.0/src/ctl_ip_svc_routes.cpp, FUNC: resourcesSvcRouteTableModify)

show log dataplane error

Описание команды

Вывод системного журнала, связанного с ошибками пакетной обработки (Data Plane) на CPE

Синтаксис

show log dataplane error

Дополнительные параметры

Нет

Пример

username # show log dataplane error
Broken pipe
Operation canceled
The WebSocket stream was gracefully closed at both endpoints
The WebSocket stream was gracefully closed at both endpoints

show log dmesg

Описание команды

Вывод системного журнала сообщений (dmesg) на CPE

Синтаксис

show log dmesg

Дополнительные параметры

Нет

Пример

username # show log dmesg
[0.568714] pci 0000:00:01.1: [8086:7010] type 00 class 0x010180<br>[0.575099] pci 0000:00:01.1: reg 0x20: [io 0xc120-0xc12f]

show log messages

Описание команды

Вывод системного журнала сообщений (messages log) на CPE

Синтаксис

show log messages

Дополнительные параметры

Нет

Пример

username # show log messages
2023-02-16T08:43:38.222328+00:00 cpe_id-39CBB134FE8160AE supervise-daemon[2565]: running health check for factory-daemon
2023-02-16T08:43:38.364698+00:00 cpe_id-39CBB134FE8160AE supervise-daemon[2505]: running health check for bzcppvisor
2023-02-16T08:43:38.367010+00:00 cpe_id-39CBB134FE8160AE supervise-daemon[5178]: running health check for ws-client

show mac-address-table

Описание команды

Вывод таблицы MAC-адресов

Синтаксис

show mac-address-table

Дополнительные параметры

Нет

Пример

username # show mac-address-table
fb:13:11:12:04:fa dev eth0 vlan 1 master brwan1