API device EN: различия между версиями
Нет описания правки |
|||
| Строка 2: | Строка 2: | ||
Section '''[[API_EN|API]]''' ERP "UserSide" | Section '''[[API_EN|API]]''' ERP "UserSide" | ||
Purpose: Equipment | |||
Additional parameters: | |||
action - request subcategory ''(possible value: see below)'' | |||
== Subcategories == | |||
==== get_connected_ont_information ==== | |||
''Added in: 3.14.13'' | |||
Description: Obtain information about connected ONUs/ONTs to OLT ''(stored information from the database. Direct polling is not performed)'' | |||
Optional parameters: | |||
device_id - OLT ID ''(can be comma separated)'' | |||
level_onu_rx_min - minimum incoming signal level on ONU/ONT ''(select records with level less than...)'' | |||
level_onu_rx_max - maximum incoming signal level on ONU/ONT ''(select records with level higher than...)'' | |||
==== get_current_ont_data ==== | |||
''Added with: 3.16dev4'' | |||
Description: Get some current information on ONT/ONU ''(directly from OLT)'' | |||
Required parameters: | |||
id - device id ''(ONU/ONT)'' | |||
==== get_device_id ==== | |||
''Modified in: 3.13.63 (added possible serial_number value to data_typer)'' | |||
''Modified in: 3.12.95 (added possible mac value to data_typer)'' | |||
Description: Retrieve device ID from incoming data | |||
Required parameters: | |||
object_type - device type [switch] | |||
data_typer - type of data to be checked ''(possible values: ip, mac, inventory_number, serial_number, additional_field_XXX)'' | |||
data_value - value | |||
Версия от 14:27, 7 августа 2023
Section API ERP "UserSide"
Purpose: Equipment
Additional parameters: action - request subcategory (possible value: see below)
Subcategories
get_connected_ont_information
Added in: 3.14.13
Description: Obtain information about connected ONUs/ONTs to OLT (stored information from the database. Direct polling is not performed) Optional parameters: device_id - OLT ID (can be comma separated) level_onu_rx_min - minimum incoming signal level on ONU/ONT (select records with level less than...) level_onu_rx_max - maximum incoming signal level on ONU/ONT (select records with level higher than...)
get_current_ont_data
Added with: 3.16dev4
Description: Get some current information on ONT/ONU (directly from OLT) Required parameters: id - device id (ONU/ONT)
get_device_id
Modified in: 3.13.63 (added possible serial_number value to data_typer)
Modified in: 3.12.95 (added possible mac value to data_typer)
Description: Retrieve device ID from incoming data Required parameters: object_type - device type [switch] data_typer - type of data to be checked (possible values: ip, mac, inventory_number, serial_number, additional_field_XXX) data_value - value