API device EN - История изменений

N.Skrypnik в 21:48, 26 апреля 2024

2024-04-26T21:48:53Z

← Предыдущая версия		Версия от 21:48, 26 апреля 2024
Строка 150:		Строка 150:

	==== set_data ====		==== set_data ====

			''Modified in 3.19beta1 (object_type parameter removed)''

	''Modified in 3.17dev1 (added possible value of date_last_activity to param)''		''Modified in 3.17dev1 (added possible value of date_last_activity to param)''

Строка 159:		Строка 162:
	Description: Change device information		Description: Change device information
	Obligatory parameters:		Obligatory parameters:
	object_type - Device type [switch]		object_type - Device type [switch] ''(before version 3.19beta1)''
	object_id - device id		object_id - device id
	param - type of parameter to change [ip\|mac\|comment\|iface_count\|downlink_port\|uplink_port\|date_last_activity]		param - type of parameter to change [ip\|mac\|comment\|iface_count\|downlink_port\|uplink_port\|date_last_activity]

N.Skrypnik в 21:46, 26 апреля 2024

2024-04-26T21:46:40Z

← Предыдущая версия		Версия от 21:46, 26 апреля 2024
Строка 134:		Строка 134:

	==== delete_mark ====		==== delete_mark ====

			''Modified in 3.19beta1 (object_type parameter removed)''

	Description: Mark removal		Description: Mark removal
	Obligatory parameters:		Obligatory parameters:
	object_type - Device type [switch]		object_type - Device type [switch] ''(before version 3.19beta1)''
	object_id - device id		object_id - device id
	mark_id - mark ID		mark_id - mark ID

N.Skrypnik в 21:44, 26 апреля 2024

2024-04-26T21:44:02Z

← Предыдущая версия		Версия от 21:44, 26 апреля 2024
Строка 81:		Строка 81:

	==== get_iface_mac ====		==== get_iface_mac ====
			''Modified in 3.19beta1 (object_type parameter removed)''

	''Added with: 3.12beta25''		''Added with: 3.12beta25''

	Description: List of interfaces with MAC addresses on the device		Description: List of interfaces with MAC addresses on the device
	Required parameters:		Required parameters:
	object_type - Device type [switch]		object_type - Device type [switch] ''(before version 3.19beta1)''
	object_id - id of the device to be sampled		object_id - id of the device to be sampled

N.Skrypnik в 21:41, 26 апреля 2024

2024-04-26T21:41:31Z

← Предыдущая версия		Версия от 21:41, 26 апреля 2024
Строка 88:		Строка 88:

	==== get_mac_list ====		==== get_mac_list ====

			''Modified in 3.19beta1 (object_type parameter removed, object_id list made optional)''

	Description: Get a list of MAC addresses that were found on the device		Description: Get a list of MAC addresses that were found on the device
	Obligatory parameters:		Obligatory parameters:
	object_type - Device type [switch]		object_type - Device type [switch] ''(before version 3.19beta1)''
	~~object_id - id of the device to be sampled~~
	Optional parameters:		Optional parameters:
	interface_list - Interface number for which to output the list (can be comma separated)		interface_list - Interface number for which to output the list (can be comma separated)
			object_id - id of the device to be sampled

	==== get_ont_data ====		==== get_ont_data ====

N.Skrypnik в 21:37, 26 апреля 2024

2024-04-26T21:37:49Z

← Предыдущая версия		Версия от 21:37, 26 апреля 2024
Строка 38:		Строка 38:

	==== get_device_id ====		==== get_device_id ====
			''Modified in 3.19beta1 (object_type parameter removed)''

	''Modified in: 3.13.63 (added possible serial_number value to data_typer)''		''Modified in: 3.13.63 (added possible serial_number value to data_typer)''

Строка 43:		Строка 45:
	Description: Retrieve device ID from incoming data		Description: Retrieve device ID from incoming data
	Required parameters:		Required parameters:
	object_type - device type [switch]		object_type - device type [switch] ''(before version 3.19beta1)''
	data_typer - type of data to be checked ''(possible values: ip, mac, inventory_number, serial_number, additional_field_XXX)''		data_typer - type of data to be checked ''(possible values: ip, mac, inventory_number, serial_number, additional_field_XXX)''
	data_value - value		data_value - value

N.Skrypnik в 21:35, 26 апреля 2024

2024-04-26T21:35:15Z

← Предыдущая версия		Версия от 21:35, 26 апреля 2024
Строка 48:		Строка 48:

	==== get_data ====		==== get_data ====
			''Modified in 3.19beta1 (added dataset parameter)''

	''Modified in: 3.18.4 (added is_hide_access_data parameter)''		''Modified in: 3.18.4 (added is_hide_access_data parameter)''

Строка 61:		Строка 63:
	object_type - Device type [switch\|onu\|olt\|radio\|all]		object_type - Device type [switch\|onu\|olt\|radio\|all]
	Optional parameters:		Optional parameters:
	~~node_id~~ - id of ~~the communication facility~~ ''(~~can be~~ comma separated)''		dataset - list of fields to output ''(comma separated)''
	~~object_id - id of the object to be selected~~
	is_online - flag - select only active devices ''(1 - active, -1 - inactive)''		is_online - flag - select only active devices ''(1 - active, -1 - inactive)''
	is_hide_ifaces_data - flag - hide detailed information on equipment interfaces		is_hide_ifaces_data - flag - hide detailed information on equipment interfaces
	is_hide_access_data - flag - hide information on equipment access parameters		is_hide_access_data - flag - hide information on equipment access parameters
			node_id - id of the communication facility ''(can be comma separated)''
			object_id - id of the object to be selected

	==== get_iface_info ====		==== get_iface_info ====

N.Skrypnik в 20:52, 25 апреля 2024

2024-04-25T20:52:35Z

← Предыдущая версия		Версия от 20:52, 25 апреля 2024
Строка 121:		Строка 121:
	order_by - data sorting field		order_by - data sorting field
	is_desc - flag - sorting in reverse order		is_desc - flag - sorting in reverse order

	~~==== add_mark ====~~
	~~Description: Adding a mark~~
	~~Obligatory parameters:~~
	~~object_type - Device type [switch]~~
	~~object_id - device id~~
	~~mark_id - mark ID~~

	==== delete_mark ====		==== delete_mark ====

N.Skrypnik в 20:51, 25 апреля 2024

2024-04-25T20:51:21Z

← Предыдущая версия		Версия от 20:51, 25 апреля 2024
Строка 9:		Строка 9:

	== Subcategories ==		== Subcategories ==

			==== add_mark ====

			''Modified in 3.19beta1 (object_type parameter removed)''

			Description: Adding a mark
			Obligatory parameters:
			object_type - Device type [switch] ''(before version 3.19beta1)''
			object_id - device id
			mark_id - mark ID

	==== get_connected_ont_information ====		==== get_connected_ont_information ====

N.Skrypnik в 18:12, 22 декабря 2023

2023-12-22T18:12:21Z

← Предыдущая версия		Версия от 18:12, 22 декабря 2023
Строка 13:		Строка 13:
	''Added in: 3.14.13''		''Added in: 3.14.13''

	Description: Obtain information about connected ONUs~~/ONTs~~ to OLT ''(stored information from the database. Direct polling is not performed)''		Description: Obtain information about connected ONUs to OLT ''(stored information from the database. Direct polling is not performed)''
	Optional parameters:		Optional parameters:
	device_id - OLT ID ''(can be comma separated)''		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_min - minimum incoming signal level on ONU ''(select records with level less than...)''
	level_onu_rx_max - maximum incoming signal level on ONU~~/ONT~~ ''(select records with level higher than...)''		level_onu_rx_max - maximum incoming signal level on ONU ''(select records with level higher than...)''

	==== get_current_ont_data ====		==== get_current_ont_data ====
Строка 23:		Строка 23:
	''Added with: 3.16dev4''		''Added with: 3.16dev4''

	Description: Get some current information on ~~ONT/~~ONU ''(directly from OLT)''		Description: Get some current information on ONU ''(directly from OLT)''
	Required parameters:		Required parameters:
	id - device id ''(ONU~~/ONT~~)''		id - device id ''(ONU)''

	==== get_device_id ====		==== get_device_id ====
Строка 85:		Строка 85:
	''Added from: 3.12.81''		''Added from: 3.12.81''

	Description: Get the latest information on ~~ONT/~~ONU		Description: Get the latest information on ONU
	Obligatory parameters:		Obligatory parameters:
	id - MAC address or serial number ''(id)''		id - MAC address or serial number ''(id)''
	or		or
	device_id - device id ''(ONU~~/ONT~~)''		device_id - device id ''(ONU)''

	==== get_pon_level_history ====		==== get_pon_level_history ====
Строка 100:		Строка 100:
	''Added from: 3.12.53''		''Added from: 3.12.53''

	Description: Obtain history of PON signal levels by ONU~~/ONT~~		Description: Obtain history of PON signal levels by ONU
	Obligatory parameters:		Obligatory parameters:
	onu_name - MAC address or serial number of ONU~~/ONT~~ ''(without separators)''		onu_name - MAC address or serial number of ONU ''(without separators)''
	or		or
	device_id - device id ''(OLT)''		device_id - device id ''(OLT)''

N.Skrypnik в 15:02, 7 августа 2023

2023-08-07T15:02:12Z

← Предыдущая версия		Версия от 15:02, 7 августа 2023
Строка 36:		Строка 36:
	data_typer - type of data to be checked ''(possible values: ip, mac, inventory_number, serial_number, additional_field_XXX)''		data_typer - type of data to be checked ''(possible values: ip, mac, inventory_number, serial_number, additional_field_XXX)''
	data_value - value		data_value - value

			==== get_data ====
			''Modified in: 3.18.4 (added is_hide_access_data parameter)''

			''Modified in: 3.17beta1 (added node_id parameter)''

			''Modified in: 3.15.18 (added object_type=olt)''

			''Modified in: 3.14.14 (added is_hide_ifaces_data parameter)''

			''Modified in: 3.12.38 (added object_type=all)''
			Description: Retrieve device information
			Obligatory parameters:
			object_type - Device type [switch\|onu\|olt\|radio\|all]
			Optional parameters:
			node_id - id of the communication facility ''(can be comma separated)''
			object_id - id of the object to be selected
			is_online - flag - select only active devices ''(1 - active, -1 - inactive)''
			is_hide_ifaces_data - flag - hide detailed information on equipment interfaces
			is_hide_access_data - flag - hide information on equipment access parameters

			==== get_iface_info ====

			''Added with: 3.17dev1''

			Description: Get current information on interfaces ''(directly from the device)''
			Required parameters:
			id - device id

			==== get_iface_mac ====
			''Added with: 3.12beta25''
			Description: List of interfaces with MAC addresses on the device
			Required parameters:
			object_type - Device type [switch]
			object_id - id of the device to be sampled

			==== get_mac_list ====
			Description: Get a list of MAC addresses that were found on the device
			Obligatory parameters:
			object_type - Device type [switch]
			object_id - id of the device to be sampled
			Optional parameters:
			interface_list - Interface number for which to output the list (can be comma separated)

			==== get_ont_data ====
			''Modified in: 3.16dev4 (added device_id parameter)''

			''Added from: 3.12.81''

			Description: Get the latest information on ONT/ONU
			Obligatory parameters:
			id - MAC address or serial number ''(id)''
			or
			device_id - device id ''(ONU/ONT)''

			==== get_pon_level_history ====
			''Modified in: 3.16.19 (added onu_device_id parameter)''

			''Modified in: 3.16dev4 (added device_id parameter)''

			''Modified in: 3.12.60 (added parameters limit, order_by, is_desc)''

			''Added from: 3.12.53''

			Description: Obtain history of PON signal levels by ONU/ONT
			Obligatory parameters:
			onu_name - MAC address or serial number of ONU/ONT ''(without separators)''
			or
			device_id - device id ''(OLT)''
			or
			onu_device_id - device id ''(ONU)''
			Optional parameters:
			limit - limit of the list of output data
			order_by - data sorting field
			is_desc - flag - sorting in reverse order

			==== add_mark ====
			Description: Adding a mark
			Obligatory parameters:
			object_type - Device type [switch]
			object_id - device id
			mark_id - mark ID

			==== delete_mark ====
			Description: Mark removal
			Obligatory parameters:
			object_type - Device type [switch]
			object_id - device id
			mark_id - mark ID

			==== read_fdb ====
			''Added in: 3.15.7''
			Description: Read FDB-table from device ''(may run for a long time)''
			Required parameters:
			device_id - device id

			==== set_data ====
			''Modified in 3.17dev1 (added possible value of date_last_activity to param)''

			''Modified in 3.14.53 (added possible value of downlink_port, uplink_port to param)''

			''Modified in 3.13.61 (added possible value of iface_count to param)''

			''Modified in 3.12.74 (added possible value of comment to param)''
			Description: Change device information
			Obligatory parameters:
			object_type - Device type [switch]
			object_id - device id
			param - type of parameter to change [ip\|mac\|comment\|iface_count\|downlink_port\|uplink_port\|date_last_activity]
			value - data ''(may be empty)''

			==== set_iface_state ====

			''Added with: 3.15beta3''
			Description: Changes the state of the interface on the device
			Obligatory parameters:
			device_id - device id
			iface - interface number
			state - state [1\|0]

			==== find_mac ====
			''Added in: 3.12beta25''
			Description: Search for MAC address in the polling history by hardware
			Required parameters:
			mac - MAC address ''(upper case without separators)''