SNMP variable object

An SNMP variable object represents an SNMP variable or a PLC or service object in the SNMP library. The SNMP variable or the service object is determined by the connection name of the variable object. Case sensitive. All names are predefined in the SNMP library, and can be listed using the respective PVI list services (Type of access POBJ_ACC_LIST_EXTERN or POBJ_ACC_LIST_PVAR).

The data format of most variables is assigned by the SNMP line and cannot be influenced by the user (exceptions listed in the table of predefined variable names).

Syntax of connection description:

Single and array variables:

/RO=<VariableName>

If the variable name is defined as the /RO parameter, the connection description must always be specified in quotation marks ("...") in the object description.

Connection description examples:

CD="/RO=serialNumber"
CD=serialNumber

Predefined variable names

The SNMP line supports the following SNMP variables:

The I/O column shows the permitted type of access (R ... read, W ... write). The MAC column shows whether or not the variable requires a MAC address. Variables without a MAC address are labeled as global SNMP variables, and must be arranged as variable objects below the SNMP device object. Variables with a MAC address are labeled as local SNMP variables, and must be arranged below an SNMP station object.

Variable name	Data format	I/O	MAC	Description
MAC addresses	*)	R	No	List of MAC addresses for all B&R PLCs with SNMP support that can be reached on the network. Entries are separated by a tab character (0x09). Each entry is 18 characters long (including tab character). Each read access is not ended until the response timeout (/RT parameter) configured for the device object has expired. During this time, response data is gathered from the individual PLCs.
snmpMode	VT=i32	R	Yes	0 ... SNMP not enabled, 1 ... SNMP read-only, 2 ... SNMP enabled
targetTypeDescription	VT=string VL=32	R	Yes	Description of the CPU (e.g. 3CP360.60-1).
serialNumber	VT=string VL=32	R	Yes	PLC serial number.
cfSerialNumber	VT=string VL=32	R	Yes	CompactFlash serial number
arVersion	VT=string VL=8	R	Yes	AR version (e.g. N3.00)
arVersionNorm	VT=string VL=32	R	Yes	Standardized AR version (e.g. 3.00.14)
arState	VT=i32	R	Yes	AR status: -1 ... Undefined, 1 ... Boot, 2 ... Diagnose, 3 ... Service, 4 ... Run
arBootPhase	VT=i32	R	Yes	Boot phase: -1 ... Undefined, 10 ... Boot, 20 ... Hardware init / Firmware update, 30 ... Initialization subroutine, 40 ... AR ready
deviceName	VT=string VL=32	R	Yes	Ethernet device name (e.g. SS1.IF2)
macAddress	VT=string VL=20	R	Yes	MAC address (e.g. 00-60-ef-01-15-5a)
baudrate	VT=i32	RW	Yes	Ethernet baud rate: 0 ... Auto, 10 ... 10 MBit HD (half-duplex), 11 ... 10MBit FD (full-duplex), 12 ... 10 MBit Auto, 100 ... 100 MBit HD, 101 ... 100 MBit FD, 102 ... 100 MBit Auto
ipAddress	VT=string VL=16	RW	Yes	IP address
subnetMask	VT=string VL=16	RW	Yes	Subnet mask (e.g. 255.255.255.0)
ipMethod	VT=i32	RW	Yes	0 ... Static IP, 1 ... DHCP client
nodeNumber	VT=i32	R	Yes	Hardware node number.
inaNodeNumber	VT=i32	RW	Yes	INA node number.
inaActivated	VT=i32	R	Yes	0 ... INA not enabled, 1 ... INA enabled
inaPortNumber	VT=i32	RW	Yes	INA port number.
hostName	VT=string VL=32	RW	Yes	Hostname (e.g. BR_HOST)
defaultGateway	VT=string VL=16	RW	Yes	Default gateway.
dnsActivated	VT=i32	RW	Yes	0 ... INA not enabled, 1 ... INA enabled
dnsFromDhcp	VT=i32	RW	Yes	Get DNS parameters from DHCP: 0 ... Not enabled, 1 ... Enabled
dnsServer1	VT=string VL=16	RW	Yes	DNS server 1
dnsServer2	VT=string VL=16	RW	Yes	DNS server 2
dnsServer3	VT=string VL=16	RW	Yes	DNS server 3

*)	The user must define the data format of the variable object (process object). The variable type must be STRING (VT=string). The length of the string (VL parameter) should be set to the maximum possible length. If the length is smaller than the actual string length, the string will be cut off.