В данном разделе описываются команды активации прикладного сервиса CSTA.

clean

Командой /api/csta/clean удаляются значения определенных параметров сервиса CSTA.

Путь команды:

/api/csta/clean

Синтаксис:

clean [<FIELD>] [--force]

Параметры:

<FIELD> - название параметра, значение которого нужно установить по умолчанию. Описание параметров и их значения приведены в таблице 1.

--force - выполнение команды без запроса подтвеждения

Таблица 1 - Описание параметров интерфейса CSTA

ПараметрОписаниеЗначение по умолчанию
authПараметры авторизации(пары {Домен, Пароль}) в CSTA для указанных доменов. Те домены, для которых не указаны параметры авторизации - не поддерживают CSTA API[]
enabledВключить (true), выключить (false) поддержку CSTA протокола.false
ssl_ipIP, на котором подсистема CSTA принимает подключения поверх SSL.0.0.0.0
ssl_portНомер порта на котором подсистема CSTA принимает подключения поверх SSL.4722
tcp_ipIP, на котором подсистема CSTA принимает подключения поверх TCP.0.0.0.0
tcp_portНомер порта на котором подсистема CSTA принимает подключения поверх SSL.4721
use_sslВключена/выключена подсистема CSTA поверх SSL соединение.true
use_tcpВключена/выключена подсистема CSTA поверх TCP соединение.true

Пример:

admin@[mycelium1@ecss1]:/$ api/csta/clean 
[clean] You are going to clean all customized properties.
Are you sure?: yes/no ?> yes
Properties values successfully restored

info

Командой /api/csta/info просматривается информация о настройках API CSTA.

Путь команды:

/api/csta/info

Синтаксис:

info [<FIELD>]

Параметры:

<FIELD> - название параметра, значение которого нужно просмотреть. В случае, если поле не задано - показывает все настройки CSTA.

Если в профиле безопасности (/system/security/profile/) параметр show_password_at_cli = off, то в выводе пароль скрывается, и вместо него показываются ********

Описание параметров и их значения приведены в таблице 1.

Пример:

admin@mycelium1@ecss1:/$ api/csta/info                                                      
┌────────┬─────────────────────┐
│Property│        Value        │
├────────┼─────────────────────┤
│auth    │biysk.local: ********│
│enabled │true                 │
│ssl_ip  │0.0.0.0              │
│ssl_port│4722                 │
│tcp_ip  │0.0.0.0              │
│tcp_port│4721                 │
│use_ssl │true                 │
│use_tcp │true                 │
└────────┴─────────────────────┘

[exec at: 19.06.2020 00:31:22, exec time: 22ms, nodes: core1@ecss1]

set

Командой /api/csta/set задается значение свойства API CSTA.

Путь команды:

/api/csta/set

Синтаксис:

set <PROPERTY> <VALUE>

set <FIELD> <VALUE>

Параметры:

<FIELD> - название параметра, значение которого нужно изменить. Описание параметров и их значения приведены в таблице 1.
<VALUE> - значение свойства.

Пароль проверяется на соответствие требованиям, установленным в профиле безопасности (/system/security/profile/), параметр restrictions.

Пример:

admin@[ds1@ecss1]:/$ api/csta/set enabled true 
Property "enabled" successfully changed from: 
false
   to
true