SNMP

See also

Communication control the SNMP Manager driver.

WebVue support - Yes.

Mode	Mnemonic	Syntax
1	START	1
2	STOP	1
3	REFRESH	2, 3
4	CONFIG	4, 5

Syntax 1

IntVal = SNMP(Mode, CommObject[, Resultvar]);

Return type: INTEGER.

Argument	Meaning
CommObject	Either the network name (example "Network01"), or the network and device name separated by a full stop (example "Network01.Device01"). Type STR.
ResultVar	The name of a register variable in which the result of the instruction will be placed. Type STR.
	-1 - Network not found. -2 - Device not found. 1 - Action in progress. 2 - Action completed OK.

Execution

Mode	Mnemonic	Action
1	START	Start the network or device.
2	STOP	Stop the network or device.
		Return: 0 = Command sent, -1 = Unknown mode, -2 = CommObject format incorrect (empty or too many fields), -3 = Item CommObject not found, -4 = Variable ResultVar not found.

Syntax 2

IntVal = SNMP(Mode, CommObject, SubMode[, ResultVar]);

Return type: INTEGER

Argument	Meaning
CommObject	The network and device name separated by a full stop. Example "Network01.Device01". Type STR.
SubMode	See below. Type STR.
ResultVar	The name of a register variable in which the result of the instruction will be placed. Type STR.
	-1 - Network not found. -2 - Device not found. -3 - Polling group not found. 1 - Action in progress. 2 - Action completed OK.

Execution

Mode	Mnemonic	Action
3	REFRESH	Sub mode "ALL". Refresh the value of all variables mapped to the device.
3	REFRESH	Sub mode "SYNCHRO". Refresh only the variables updated by (trap and ad-hoc synchronization).
		Return: 0 = Command sent, -1 = Unknown mode, -2 = CommObject format incorrect (either empty or more than two fields), -3 = CommObject not found, -4 = Unknown sub-mode.

Syntax 3

IntVal = SNMP(Mode, CommObject, SubMode, PollingGroup[, ResultVar]);

Return type: INTEGER

Argument	Meaning
CommObject	The network and device name separated by a full stop. (example "Network01.Device01"). Type STR.
SubMode	See below. Type STR.
PollingGroup	The name of a polling group. Type STR.
ResultVar	The name of a register variable in which the result of the instruction will be placed. Type STR.
	-1 - Network not found. -2 - Device not found. -3 - Polling group not found. 1 - Action in progress. 2 - Action completed OK.

Execution

Mode	Mnemonic	Action
3	REFRESH	Sub mode "POLLINGGROUP". Refresh the value of all variables of the specified device and attached to the specified polling group. Return: 0 = Command sent, -1 = Unknown mode, -2 = CommObject format incorrect (either empty or more than two fields), -3 = PollingMode format incorrect (empty), -4 = Unknown sub-mode.

Syntax 4

IntVal = SNMP(Mode, CommObject, "HOSTNAME", HostName[, ResultVar]);

Return type: INTEGER

Argument	Meaning
CommObject	The network and device name separated by a full stop. (example "Network01.Device01"). Type STR.
HostName	The new name for the device. Type STR.
ResultVar	The name of a register variable in which the result of the instruction will be placed. Type STR.
	-1 - Network not found. -2 - Device not found. 1 - Action completed OK.

Execution

Mode	Mnemonic	Action
4	CONFIG	Change the configuration of the device CommObject so that it is addresses HostName. Return: 0 = Command sent, -1 = Unknown mode, -2 = Device name not specified, -3 = Unknown sub-mode, -5 = Empty HostName.

Syntax 5

IntVal = SNMP(Mode, CommObject, "IPADDRESS", IPaddress[, ResultVar]);

Return type: INTEGER

Argument	Meaning
CommObject	The network and device name separated by a full stop. (example "Network01.Device01"). Type STR.
IPaddress	The new IP address for the device in the format xxx.xxx.xxx.xxx. Type STR.
ResultVar	The name of a register variable in which the result of the instruction will be placed. Type Str.
	-1 - Network not found. -2 - Device not found. 1 - Action completed OK.

Execution

Mode	Mnemonic	Action
4	CONFIG	Change the configuration of the device CommObject so that it addresses IPaddress. Return: 0 = Command sent, -1 = Unknown mode, -2 = Device name not specified, -3 = Unknown sub-mode, -5 = Empty IPaddress.