Network Management

Network Management (netmanagement) is a system context that provides access to data related to the overall operation of Network Management extensions. It is not shown in the visible context tree.

Network Management plugin exploits SNMP, WMI, and Network Host device drivers as a basis for network communications.

Advanced Information

Context Information

Context Type: networkManagement

Context Name: netmanagement

Context Description: Network Management

Context Path: netmanagement

Context Mask: netmanagement

Context Permissions

[?]

Level	Description
None	No access allowed.
Observer	Network topology discovery.
Operator	Same as Observer.
Manager	SNMP trap sending. Syslog message sending. Wake-on-LAN requests sending. Services status browsing.
Engineer	Same as Manager.
Administrator	Same as Manager.

Public Variables (Properties)

[?]

This context has no public variables (properties).

Public Functions

[?]

Send SNMP Trap

Generates SNMP notifications (traps and informs) as described in Sending SNMP Traps and Informs.

Function Name:	sendSnmpTrap
Permissions:	Accessible at Manager permission level
Input Records:	1
Input Format:	see Sending SNMP Traps and Informs
Output Records:	0 (for Traps) or 1 (for Informs)
Output Format:	see Sending SNMP Traps and Informs

Send Syslog Message

Sends Syslog message as described in Syslog Messages Sending section.

Function Name:	sendSyslogMessage
Permissions:	Accessible at Manager permission level
Input Records:	1
Input Format:	see Syslog Messages Sending
Output Records:	0
Output Format:	None

Wake-on-Lan

Awakes a computer by sending a special message. See Wake-on-LAN.

Function Name:	executeWakeOnLAN
Permissions:	Accessible at Manager permission level
Input Records:	1
Input Format:	see Wake-on-LAN
Output Records:	0
Output Format:	None

Get Process Information

Utility function used by process-monitoring tools to retrieve details (parameters or path string) of specific processes.

	Name	Type	Description
Function Name:	getProcessInfo
Permissions:	Accessible at Manager permission level
Input Records:	1
Input Format:
	contextName	String	Name of device context.
	processName	String	Process name.
	requestType	Integer	`0` to get paths of processes with the specified name filtered by parameters; `1` to get parameters of processes with the specified name filtered by path.
	processFilter	String	Filter string to be applied to parameters or path, depending on the specified requestType.
Output Records:	0...unlimited
Output Format:
	Name	Type	Description
	value	String	Name of device context.
	description	String	Process path or parameters string.

Services Status

An utility function used by service-monitoring tools to retrieve status information from all services registered for all devices.

Function Name:	servicesStatus
Permissions:	Accessible at Manager permission level
Input Records:	0
Input Format:	None
Output Records:	0...unlimited
Output Format:	Dynamic format with the following fields: a String field named "device" (containing context path) one Color field for every registered service denoting its status

Get SNMP Value

The "Get SNMP Value" (snmpGet) function fetches a single "raw" value from an SNMP Device. The function sends a single SNMP GET request for the OID specified in input parameters and treats SNMP agent response as a separate value converting it to String.

Note that the OID are requested "as is". Thus the function produces a 'No such name' error if there's no exact match with one of device OIDs. It means that scalar values must be requested by OID ended with ".0", while tables can be read only cell-by-cell and every request must include full index of a particular cell.

Note the following Example below

Examples:

Executing SNMP Get with OID=1.3.6.1.2.1.1.1.0 gives a System Description (sysDescr).

Executing SNMP Get with OID=1.3.6.1.2.1.1.1 produces a 'No such name' error due to incomplete OID (missing the '.0' suffix).

Executing SNMP Get with OID=1.3.6.1.2.1.2.2 produces a 'No such name' error due to incomplete OID referring a whole table (ifTable) instead of a cell.

Executing SNMP Get with OID=1.3.6.1.2.1.2.2.1.2.1 gives a description (ifDescr, 1.3.6.1.2.1.2.2.1.2) of the 1-st (.1) network interface from the ifTable.

	Name	Type	Description
Function Name:	snmpGet
Permissions:	Accessible at Manager permission level
Input Records:	1
Input Format:
	oid	String	An OIDs to query.
	settings	Table	SNMP Settings used to communicate with SNMP device. See SNMP Pollling Settings for details.
Output Records:	0...unlimited
Output Format:
	Name	Type	Description
	name	String	Name of SNMP variable requested (including its OID).
	value	String	Obtained value converted to String.

Get Several SNMP Values

The "Get Several SNMP Values" (snmpGetMulti) function fetches several "raw" values from an SNMP Device. The function sends a single SNMP GET request for every OID specified in input parameters and treats each response as a separate value converting it to String. See also comments and examples for the snmpGet function.

	Name	Type	Description
Function Name:	snmpGetMulti
Permissions:	Accessible at Manager permission level
Input Records:	1
Input Format:
	oids	Table	A table of OIDs to query. Each row should present an OID to request in the 1-st column (named 'oid' by default).
	settings	Table	SNMP Settings used to communicate with SNMP device. See SNMP Pollling Settings for details.
Output Records:	0...unlimited
Output Format:
	Name	Type	Description
	name	String	Name of SNMP variable requested (including its OID).
	value	String	Obtained value converted to String.

SNMP Read

Fetches "full-fledged" SNMP variables from an SNMP device. Unlike SNMP Get, this function invokes SNMP Walk to fetch all values within the bounds of the specified OIDs and processes the results along with metadata from the MIB Files Directory to produce complete tables.

Example: Executing SNMP Read with OID=1.3.6.1.2.1.2.2 gives complete ifTable contents.

	Name	Type	Description
Function Name:	snmpRead
Permissions:	Accessible at Manager permission level
Input Records:	1
Input Format:
	oids	Table	A table where each row is an OID to query, and the column or columns to retrieve from the object defined by the OID. The table fields are: oid - String - OID of the resource to retrieve. columnOids - DataTable - Data table with a single field `oid` and any number of rows indicating the OIDs of the columns which should be retrieved from the resource.
	settings	Table	SNMP Settings used to communicate with SNMP device. See SNMP Pollling Settings for details.
Output Records:	0...unlimited
Output Format:
	Name	Type	Description
	name	String	Name of an SNMP variable obtained (including its OID).
	value	Table	Value of the SNMP variable as a table.

Ping

Sends a ping request to the specified host.

	Name	Type	Description
Function Name:	ping
Permissions:	Accessible at Manager permission level
Input Records:	1
Input Format:
	address	String	IP Address or Host Name to ping.
	packetDataSize	Integer	Size of ICMP packet data (excluding headers).
	pingCount	Integer	Number of ping requests to send during every device synchronization (polling cycle).
	storageSize	Integer	Number of packets used for Packet Loss Rate calculation. For its calculation, the server takes the latest ping results specified by this setting.
	offlineCriterion	Integer	Number of consecutive failed ping attempts that will change connection status of network host to Offline.
	timeout	Long	If no reply is received within this time period, ping attempt is considered as failed.
Output Records:	1
Output Format:	see Ping Monitoring Results

Network Topology Discovery

Discover network connections between devices.

Function Name:	discoverTopology
Permissions:	Accessible at Manager permission level
Input Records:	1
Input Format:	Name	Type	Description
	discoverTopologyMode	String	Full Discovery (default), Discover New Links, Update Existing Links
	discoverContextMask	String	Device Context mask indicating which devices to include in discovery.
	arpEnabled	Boolean	Use ARP algorithm
	stpEnabled	Boolean	Use STP algorithm
	cdpEnabled	Boolean	Use CDP algorithm
	aftEnabled	Boolean	Use AFT algorithm
	lldpEnabled	Boolean	Use LLDP algorithm
	serverContext	String	Root Server Node Context Path
Output Records:	0...unlimited
Output Format:	Name	Type	Description
	discoveryStatus	String	Status of the discovered link. Added Updated Removed
	status	String	Indicates link status. Auto-discovered status are links created during topology discovery and will be automatically edited and deleted during subsequent discovery cycles. User-defined links are visible on the topology map, but are never edited or deleted during the discovery process. Deleted links are neither shown on the topology map, nor edited or deleted during topology discovery. This allows links to be hidden and protected from automated changes.
	type	string	Generic networks types include OSI Level 2 or OSI Level 3 links. Custom link type is used in the case of a non-standard topology.
	source	string	The source context (device or group) of the link.
	target	string	The context (device or group) being linked to.
	sourceInterface	Integer	The unique network interface index (Interface Index for SNMP devices) of the source context.
	sourceInterfaceId	String	L3 link identifier of the source context (device or group)
	targetInterfaceId	String	L3 link identifier of the target context (device or group)
	sourceType	String	The source context (device or group) type, which will define the context icon on the topology map, for example router, server, printer, etc.
	targetType	String	The target context (device or group) type, which will define the context icon on the topology map, for example router, server, printer, etc.
	sourceDescription	String	Custom L3 link description of the source context.
	targetDescription	String	Custom L3 Link description of the target context.
	description	String	Link Description.
	linkId	String	Link Id.

Public Events

[?]

This context has no public events.

DPF_EXPORT_V5.8.8 / TIME_1743710556 / 2025-04-03 20:02:36 / STRLEN_29919 / STRLEN_HTML_32061

{VERSION}

Was this page helpful?