Perl API reference

Read about the Perl API provided with Network Manager.

Overview of the Perl API
The Perl API provides developers with the functionality to write discovery agents and other client/server applications. These applications can perform such tasks as accessing and modifying records in Network Manager databases, and retrieving SNMP information from a network device. Developers can also integrate third-party products using the Perl API as a tool to interface with Network Manager.
Writing discovery agents
Discovery agents retrieve information about devices in the network. They also report on new devices by finding new connections when investigating device connectivity. Discovery agents are used for specialized tasks. For example, the ARP Cache discovery agent populates the Helper Server database with IP address-to-MAC address mappings. You can use the Perl API to write custom discovery agents that perform a variety of useful and specialized tasks, including retrieving information about the connectivity of network entities.
Accessing component databases
Network Manager provides component databases that store specific categories of information. Each component schema can consist of one or more databases and each database one or more tables. For example, the ncp_class database consists of one database and three tables. You use the RIV::OQL Perl API module to access or modify records in these component databases.
Performing SNMP queries
The RIV::SnmpAccess module allows client/server scripts that use the Perl API to retrieve SNMP information from a network device through the SNMP helper.
Writing and integrating Perl applications with third-party products
The Perl API allows you to write Perl applications (for example, Listeners) that you can then integrate with third-party products.
RIV Modules Reference
Each RIV module provides constructors and methods used in the Perl scripts that you implement to create custom discovery agent and other client/server applications.
NCP Modules Reference
Each NCP module provides constructors and methods used in the Perl scripts that you implement to perform operations on NCIM topology databases and NCIM domains.

Parent topic: Reference