API device UK
Розділ API ERP "UserSide"
Призначення: Обладнання
Додаткові параметри: action - підкатегорія запиту (можливе значення: див. нижче)
Підкатегорії
add_mark
Змінено у 3.19beta1 (параметр object_type виключено)
Опис: Додавання мітки Обов'язкові параметри: object_type - Тип пристрою [switch] (до версії 3.19beta1) object_id - id пристрою mark_id - ID мітки
get_connected_ont_information
Додано у: 3.14.13
Опис: Отримання інформації про підключені ONU до OLT (збережена інформація з бази. Пряме опитування не виконується) Необов'язкові параметри: device_id - ID OLT (можна через кому) level_onu_rx_min - мінімальний вхідний рівень сигналу на ONU (вибрати записи з рівнем менше ніж...) level_onu_rx_max - максимальний вхідний рівень сигналу на ONU (вибрати записи з рівнем вище ніж...)
get_current_ont_data
Додано з: 3.16dev4
Опис: Отримання деякої поточної інформації про ONU з OLT Обов'язкові параметри: id - id пристрою (ONU)
get_device_id
Змінено у 3.19beta1 (параметр object_type виключено)
Доопрацьовано у: 3.13.63 (в data_typer додано можливе значення serial_number)
Доопрацьовано у: 3.12.95 (в data_typer додано можливе значення mac)
Опис: Отримання ID пристрою за вхідними даними Обов'язкові параметри: object_type - тип пристрою [switch] (до версії 3.19beta1) data_typer - тип даних, які перевіряємо (можливі значення: ip, mac, inventory_number, serial_number, additional_field_XXX) data_value - значення
get_data
Доопрацьовано у 3.20.2 (додано параметр is_with_ip)
Доопрацьовано у 3.19.15 (додано параметр customer_id)
Доопрацьовано у 3.19beta1 (додано параметр dataset)
Доопрацьовано у: 3.18.4 (додано параметр is_hide_access_data)
Доопрацьовано у: 3.17beta1 (додано параметр node_id)
Доопрацьовано у: 3.15.18 (додано object_type=olt)
Доопрацьовано у: 3.14.14 (додано параметр is_hide_ifaces_data)
Доопрацьовано у: 3.12.38 (додано object_type=all)
Опис: Отримання інформації про пристрої Обов'язкові параметри: object_type - Тип пристрою [switch|onu|olt|radio|all] Необов'язкові параметри: customer_id - id абонента (можна через кому) dataset - список полів, які виводити у видачі (через кому) is_online - прапорець - вибирати тільки активні пристрої (1 - активні, -1 - неактивні) is_hide_ifaces_data - прапорець - приховувати розгорнуту інформацію за інтерфейсами обладнання is_hide_access_data - прапорець - приховувати інформацію за параметрами доступу до обладнання is_with_ip - прапорець - тільки з IP-адресами node_id - id об'єкта інфраструктури (можна через кому) object_id - id об'єкта для вибірки
get_iface_info
Додано з: 3.17dev1
Опис: Отримання поточної інформації за інтерфейсами (безпосередньо з пристрою) Обов'язкові параметри: id - id пристрою
get_iface_mac
Змінено у 3.19beta1 (параметр object_type виключено)
Додано з: 3.12beta25
Опис: Список інтерфейсів з MAC-адресами на пристрої Обов'язкові параметри: object_type - Тип пристрою [switch] (до версії 3.19beta1) object_id - id пристрою для вибірки
get_mac_list
Змінено у 3.19beta1 (параметр object_type виключено, список object_id зроблено необов'язковим)
Опис: Отримання списку MAC-адрес, які були знайдені на пристрої Обов'язкові параметри: object_type - Тип пристрою [switch] (до версії 3.19beta1) Необов'язкові параметри: interface_list - Номер інтерфейсу, за яким виводити список (можна через кому) object_id - id пристрою для вибірки
get_ont_data
Доопрацьовано у: 3.16dev4 (додано параметр device_id)
Додано з: 3.12.81
Опис: Отримання останньої інформації про ONU Обов'язкові параметри: id - MAC-адрес або серійний номер (id) або device_id - id пристрою (ONU)
get_pon_level_history
Доопрацьовано у: 3.16.19 (додано параметр onu_device_id)
Доопрацьовано у: 3.16dev4 (додано параметр device_id)
Доопрацьовано у: 3.12.60 (додано параметри limit, order_by, is_desc)
Додано з: 3.12.53
Опис: Отримання історії PON-рівнів сигналів за ONU Обов'язкові параметри: onu_name - MAC-адреса або серійний номер ONU (без розділювачів) або device_id - id пристрою (OLT) або onu_device_id - id пристрою (ONU) Необов'язкові параметри: limit - обмеження списку даних, що виводяться order_by - поле сортування даних is_desc - прапорець - сортування у зворотному порядку
get_relation_customers
Додано у: 3.19.45
Опис: Отримання інформації про залежних абонентів Обов'язкові параметри: device_id - id пристрою Необов'язкові параметри: port_start - початковий номер порту port_finish - кінцевий номер порту
delete_mark
Змінено у 3.19beta1 (параметр object_type виключено)
Опис: Зняття мітки Обов'язкові параметри: object_type - Тип пристрою [switch] (до версії 3.19beta1) object_id - id пристрою mark_id - ID мітки
read_fdb
Додано з: 3.15.7
Опис: Читання FDB-таблиці з пристрою (може виконуватися тривалий час) Обов'язкові параметри: device_id - id пристрою
set_data
Змінено у 3.19beta1 (параметр object_type виключено)
Доопрацьовано у 3.17dev1 (до параметра param додано можливе значення date_last_activity)
Доопрацьовано у 3.14.53 (до параметра param додано можливе значення downlink_port, uplink_port)
Доопрацьовано у 3.13.61 (до параметра param додано можливе значення iface_count)
Доопрацьовано у 3.12.74 (до параметра param додано можливе значення comment)
Опис: Зміна інформації про пристрій Обов'язкові параметри: object_type - Тип пристрою [switch] (до версії 3.19beta1) object_id - id пристрою param - тип параметра для зміни [ip|mac|comment|iface_count|downlink_port|uplink_port|date_last_activity] value - дані (може бути порожнім)
set_iface_state
Додано з: 3.15beta3
Опис: Зміна стану інтерфейсу на пристрої Обов'язкові параметри: device_id - id пристрою iface - номер інтерфейсу state - стан [1|0]
find_mac
Додано з: 3.12beta25
Опис: Пошук MAC-адреси в історії опитування обладнання Обов'язкові параметри: mac - MAC-адреса (верхній регістр без розділювачів)