API

Description

GetInterfacesByIP(ip_address, interface_type)

Return an interfaces object according to an IP address and interface type. The returned object type is list.

▪IP_ address — the input IP address.

▪interface_type — see Interface Type for more details.

GetDevicesByIP(ip_address)

Return devices according to the specified IP address. The returned object type is list.

HasIPAddress(obj, ip_address)

Judge whether an object contains the specified IP address. The returned data type is bool (True or False).

GetNeighborInterfaceByIP(device_name, neighbor_ip_address[, interface_name , interface_type])

Return the neighbor interface object of a device in ipIntfs type.

▪device_name — the hostname of the specified device.

▪interface_name — the name of the specified device interface. This parameter can be null.

▪interface_type — see Interface Type for more details. This parameter can be null.

▪neighbor_IP_ address — the neighbor IP address.

GetLocalIPInterfaceByNeighborIP(device_name, neighbor_ip_address, device_interface_name)

Return the local interface object of a device by its neighbor IP in ipIntfs type.

▪device_name — the hostname of the device.

▪neighbor_ip_address — the IP address of the neighbor device.

▪device_interface_name — the name of the interface.

GetLocalIPInterfaceByIP(device_name, ip_address, device_interface_name)

Return the local interface object of a device in ipIntfs type.

▪device_name — the hostname of the device.

▪ip_address — the IP address of the device.

▪device_interface_name — the name of the interface.

GetIPsOfInterface(interface)

Return the corresponding IP addresses of an interface object. The returned object type is list.

GetInterfacesByMAC(mac_address)

Return the corresponding interface object by a MAC address. The returned object type is list.

▪mac_address — the MAC address.

GetDeviceBySerialNumber(serial_number)

Return a device object by its serial number.

▪serial_number — the serial number of the device.