SBC SNMP function of Saia PCD® Owner's manual

Document 27-639 │ Edition ENG03 │ 2017-09-14

Manual

SNMP function of Saia PCD

SNMP Manager

Drucker

SNMP agent

PCD data

R/T/F/I/O …

SNMP agent

Router

SNMP agent

Server

5560

Saia PCD3.M

SNMP agent

PCD data

R/T/F/I/O …

Drucker

SNMP agent

Saia-Burgess Controls AG

Manual SNMP │ Document 27-639 – Edition ENG03 │ 2017-09-14

0-1

Content

0 Content

0.1 Document versions ............................................................................... 0-3

0.2 About this manual ................................................................................. 0-3

0.3 Brands and trademarks ........................................................................ 0-3

1 Introduction

1.1 Application possibilities ......................................................................... 1-1

1.2 General Data ......................................................................................... 1-2

2 Description of the MIB-II standard

3 Getting Started with the SNMP function

3.1 Description ............................................................................................ 3-1

3.2 Possible applications ............................................................................. 3-1

3.3 Material required ................................................................................... 3-2

3.4 CongurationandstartwithSNMP ....................................................... 3-2

3.4.1 CongurationPCD ................................................................................ 3-3

3.4.2 UsingtheMIBFileGeneratortohandleprojectsymbols

(requires PG5 2.1 or later) .................................................................... 3-4

3.4.3 PCconguration .................................................................................... 3-7

3.4.4 ExamplesofSnmpgetfunction ............................................................. 3-8

3.4.5 ExamplesofSnmpsetfunction .............................................................. 3-10

3.4.6 SwitchingSymbolsviaSNMP ............................................................... 3-11

3.5 Comment ............................................................................................... 3-13

3.6 UsingSNMPTraps ................................................................................ 3-14

3.6.1 ExamplesoftheSNMPTrapfunction ................................................... 3-14

3.6.2 CreationofuserspecictrapswithF-Boxes ......................................... 3-15

4 Management Information Base MIB

4.1 WorkingwithMIB .................................................................................. 4-1

4.2 MIB-IIStandarddescription ................................................................... 4-1

4.3 Net-SNMPinstallationwiththecommandline ...................................... 4-2

4.4 SaiaPCDMIBlestructure .................................................................. 4-2

4.4.1 saiapcdMIB ........................................................................................... 4-3

4.4.2 pcdProduct ............................................................................................ 4-3

4.4.3 pcdHW .................................................................................................. 4-4

4.4.4 pcdMediaClassic ................................................................................... 4-4

4.4.5 pcdAnyMedia ........................................................................................ 4-7

4.4.6 pcdRtc ................................................................................................... 4-8

4.4.7 pcdState ................................................................................................ 4-9

4.4.8 pcdHistory ............................................................................................. 4-10

Saia-Burgess Controls AG

Manual SNMP │ Document 27-639 – Edition ENG03 │ 2017-09-14

0-2

Content

5 SNMP diagnosis through Web CGI

5.1 Accesssyntax ....................................................................................... 5-1

5.2 SNMPTaglist ........................................................................................ 5-2

6 Special remarks

A Appendix

A.1 Icons ...................................................................................................... A-1

A.2 Contact .................................................................................................. A-1

Saia-Burgess Controls AG

Manual SNMP │ Document 27-639 – Edition ENG03 │ 2017-09-14

0-3

Content

Document versions | Brands and trademarks

0.1 Document versions

Version Changes Published Remarks

EN01 2014-06-13 2014-06-13 Newdocument(fromWordtoInDesign)

ENG02 2017-07-24 2017-07-25 Ch.3.4.2“OID”added

ENG03 2017-09-14 2017-09-14 Ch.3.3ReplacedthewholelistofPCD’s

withtheterm“PCDswithEthernet”

0.2 About this manual

Seethesectionintheappendixinrelationtosomeoftheterms,abbreviationsand

the references used in this manual.

0.3 Brands and trademarks

SaiaPCD

andSaiaPG5

areregisteredtrademarksofSaia-BurgessControlsAG.

Technicalmodicationsarebasedonthecurrentstate-of-the-arttechnology.

Saia-BurgessControlsAG,2017.

Allrightsreserved.

PublishedinSwitzerland

Saia-Burgess Controls AG

Manual SNMP │ Document 27-639 – Edition ENG03 │ 2017-09-14

1-1

Introduction

Application possibilities

1 Introduction

TheSNMPmanagersoftwareusuallyrunsonaserver.Itmonitorsandcontrols

SNMPagents.TheSNMPmanagerreadsandsendsdatafromtheagentusing

SETandGETcommands.TheSNMPagentcanalsosendunrequestedso-called

‘trap’messagestotheSNMPmanager.Thisallows,forexample,thedirectreport-

ingoffaults.

SaiaPCD

-MIBhasbeendenedforSaiaPCD

withSNMPsupport.Withinitall

theresourcesthatcanbequeriedandmodiedwithSNMParerepresented.Basi-

cally,allPCDmediacanbeaccessed(inputs/outputs,registers,ags,DBs,etc.).

IntheMIBle,theprogrammercanrestrictaccesstoselectedareasonly.

1.1 Application possibilities

WithimplementationoftheSNMPprotocolinSaiaPCD,thecustomercannow

monitorallnetwork-enableddevices(routers,serversandSaiaPCD)onthesame

managementplatform.SNMPissupportedbyverymanymoderndevicesandcan

beusedasacommoninterfaceforadministrationandconguration.Themanage-

mentsystemcanlinkupdierentitemsofinformationavailablethroughoutthe

network.WithSNMP,youhaveaccesstoallPCDresources.Parameterscanbe

retrievedandmodied.Usingacongurationle,itispossibletodenewhichre-

sourcescanbereadandwritten.Whenthecontrollerchangesthemodeinwhich

theuserprogramisprocessed(changebetweenRUN/STOP/HALT),thePCD

canautomaticallysendouttraps.Itisalsopossibletodenewhetherameasured

value(e.g.temperature)shouldspringatrapwhenacertainvalueisexceeded.

Saia-Burgess Controls AG

Manual SNMP │ Document 27-639 – Edition ENG03 │ 2017-09-14

1-2

Introduction

General Data

1.2 General Data

General Data

Type Description

SNMPstandard v1,v2c

Port 161,162

RFC SNMPv1,v2: RFC1155,1157,1353,1398,1447

SNMPv2: RFC1573,1757,1902to1908,2011,

 2012,2013,2096,2863

MIBII: RFC1213

Traptextlength 128 characters

Connection to

SNMPManager

OnlydirectviaxedIPaddress

StandardMIBFiles MIB-IIstandard

SpecicMIBFiles SaiaMIB_Classic

Saia-Burgess Controls AG

Manual SNMP │ Document 27-639 – Edition ENG03 │ 2017-09-14

2-1

Description of the MIB-II standard

MIB-IIstandard

2 Description of the MIB-II standard

TheSNMPprotocolisbasedonrequestswhicharesentbyanetworkmanage-

mentstationtoahostandansweredwithareply.AllSNMPrequestsrefertoatree

structureddirectorywhereallnetworksettings,protocolsandstatisticsofadevice

aresavedunderthename«MIB-II»(Managementinformationbase).TheMIB-II

hasastandardisedpartforIP-networks.Inadditionaprivatepartcanbeaddedas

well.Thismakesitpossibletoaddyourowndatawithyourownstructureandto

makethemavailableviaSNMPsetandgetcommands.

Thestructureofthestandard MIBisshownbelow.

2.1:StandardMIBTree

ThisgraphshowsthewaytotheMIB-IIfolderintheStandardMIBtree.Inmost

implementationsallfoldersexcepttheMIB-IIfolderareempty.Furthermore,every

folderhasaspecicnumberwhichallowsthepathtotheMIB-IIfoldertobede-

scribed.Forthisreason,allelementsoftheMIB-IIstartwith:

1.3.6.2.1

2.2:TheMIB-II

Saia-Burgess Controls AG

Manual SNMP │ Document 27-639 – Edition ENG03 │ 2017-09-14

2-2

Description of the MIB-II standard

MIB-IIstandard

TheMIB-IIalreadycontainsalotofinformation.Inthechartonlytherstcategory

isshown.ToseeallthespecicdatayouhavetoloadtheSaiaMIB_ClassicMIB

as described in chapter 3.4.

TheMIB-IItreeisdescribedintheRFC1213andworkswitheverySaiaPCD.The

MIB-IIisusuallyalreadyinstalledwiththeSNMPManagersoftware(iniReasoning

youhavetoloadtheRFC1213MIB).

InadditiontotheMIB-IIyoucanloadaSaiaPCDspecicSaiaMIBClassic.mib

whichislocatedintheprivatefolderandreachablewiththenumber

1.3.6.2.4

ThisMIBcontainsSBCspecicdataandmakesitalsopossibletogetspecic

registersorotherSaiaPCDdata.YoucancustomisethisMIBwiththeSBCMIB

Filegeneratorandaddspecicvariablestoit.Thispowerfuloptionenablesyouto

changeoutputagsdirectlyviaanSNMPcommand,forexample.

3 Getting Started with the SNMP function

3.1 Description

TheSimpleNetworkManagementProtocol(SNMP)wasdevelopedtoallow

networkelementslikerouters,serversandswitchestobemonitoredandcon-

trolledfromacentralstation.TheSNMPmanagerisusuallysoftwarethatrunson

aserver.ItmonitorsandcontrolstheSNMPagents.Theymaybeanychoiceof

devicethatcanbereachedviathenetworkandthatsupportsSNMP.Withthenew

rmware,theSaiaPCDsupportsSNMPagentfunctionality.

ThefollowingSNMPversionsareavailable:v1,v2c,v3(safetymechanismwith

MD5authentication,encryptionwithDES56bits).Thestandardv3hasnotyet

achievedverywidecirculation.Versionv2cis,inprinciple,stillthecurrentstand-

ard.SaiaPCDsupportsversionv1andv2c.

ThefollowingshowsthepossibilitiesofSNMPimplementationinSaiaPCDwith

thehelpofonePCDandaWindowsPCwithaNet-SNMPtool.

Diagram:

   3.1:Gettingstarted:hardwareconguration

3.2 Possible applications

ImplementationoftheSNMPprotocolinSaiaPCDshasenabledcustomersto

monitoralltheirnetworkdevices:(routers,serversandSaiaPCDs)onthesame

managementplatform.SNMPissupportedbymanymoderndevicesandcanbe

usedasacommoninterfaceforadministrationandconguration.Themanage-

mentsystemcanlinkdiversepiecesofinformationavailablethroughoutthenet-

work.

SNMPgivesaccesstoallPCDresources.Parameterscanbepolledandmodied.

Acongurationleisusedtodenewhichresourcescanbereadorwrittento.If

thecontrollerchangesthemodeforprocessingauserprogram(changebetween

RUN/STOP/HALT)thePCDcanautomaticallysendatrap.Itisalsopossible

todenewhetherameasurement(e.g.atemperature)shouldspringatrapifa

certain value is exceeded.

SNMPmanager

IPaddr.:192.168.12.14

IPaddr.:

192.168.120.25

SNMPagent

Saia-Burgess Controls AG

Manual SNMP │ Document 27-639 – Edition ENG03 │ 2017-09-14

3-1

Getting Started with the SNMP function

Description | Possible applications

3.3 Material required

• 1laptop/PCwithPG5utilities

• 1 PCD is required for this application.

Thefollowingtypesmaybeused:

• anyPCDwithEthernetandtheOperatingSystem:SaiaPCD

COSinus

Thefollowingmaterialisusedforthetest:

• PCD3.M5540

• LaptopHPCompaq6715b

• Net-SNMPclientsoftware

3.4 CongurationandstartwithSNMP

Theexamplesalwaysincludealongsequenceofnumbersthatareseparatedby

points:thisnumberalwaysstartsasfollows:1.3.6.1.4.1.31977….Ifyouwantto

usetheSNMPprotocolwithaSaiaPCD,theaddressesmustalwaysstartwith

thesesevennumbers.Therst6numbers(1.3.6.1.4.1)standfor«iso.org.dod.

internet.private.enterprise».

Thenumber31977isthenumberregisteredwithIANAforproductsfromSaia

BurgessControls.

Thisnumberisaxedsettinginrmwareandcannotbemodied.

TheSaiaMIB_Classic.mibletranslatesthishierarchyofnumbers(startingwith

1.3.6.1.4.1.31977)intoastructureoftextdenitions.

Theybeginwith:SaiaPCDClassic:….

Textdenitionsandnumbersmaybemixed.

Saia-Burgess Controls AG

Manual SNMP │ Document 27-639 – Edition ENG03 │ 2017-09-14

3-2

Getting Started with the SNMP function

Materialrequired|CongurationandstartwithSNMP

3.4.1 CongurationPCD

ThefollowingsettingsarerequiredinthePG5DeviceCongurator.

TousePCDasanSNMP

Agent,enablethisfunc-

tionalityrst.

1)EnableSNMP

2)DeneIPaddresses

wheretosendthe

SNMPtraps(inour

caseyourcomputer)

3) Please note that

usuallythesestrings

have to correspond

to the entries in the

SNMPmanager.

4)Memoryallocationfor

data transfer

Onlythedened

areas can be used

forreadorwritedata

transferoverSNMP

(SETandGETcom-

mands)

Thedefaultallvalues

arereadonly.

SupportedMedia:IO,

F,R,T,C,DB

DownloadthecongurationtothePCDafteryouhavemadethechanges.

Saia-Burgess Controls AG

Manual SNMP │ Document 27-639 – Edition ENG03 │ 2017-09-14

3-3

Getting Started with the SNMP function

CongurationandstartwithSNMP

3.4.2 Using the MIB File Generator to handle project symbols

(requires PG5 2.1 or later)

ThistoolallowsadevicespecicMIB(ManagementInformationBase)letobe

created.TheMIBlesarethebasesforSNMPmanagerstoaccessinformationon

SNMPcongureddevices.

ThislecanthenbeusedbyanyMIBbrowsertogetaccessdirectlytothesymbol

name related to the device.

PleaseNote:theprojectsymbolsOID(ObjectIdentier)willnotappearwhen

executingawalkcommandonthedevice.

Generated Symbol Names

TheMIBlesyntax(ASN.1notation)imposessomerestrictionsconcerningthe

names.

Ifthesymbolnamedoesnotcomplywiththissyntax,theMIBgeneratorwilltrans-

formthesymbolnamesintoASN.1compatiblenames.

Thisincludes

• Therstsymbollettershouldbewritteninlowercase

• The‘_’(underscore)isnotallowed

• The‘‘(space)isnotallowed

• Specialcharacters(ä,ö,ü,é,à,è,etc.)arenotallowed

Theloglecontainsallchangesmadetothesymbolnames.

Thetoolhastwomodes:

• MIBleeditor

• MIBlecompiler

ThepurposeofthistoolistocreateanMIBprojectletobeusedbySNMPto

transmitPCDmedia,accordingtotheASN.1standard

HowtohavesymbolsintheMIBlegenerated

Inthedevicesymboleditor,selectasymbolandclickintherelated«tags»column.

Saia-Burgess Controls AG

Manual SNMP │ Document 27-639 – Edition ENG03 │ 2017-09-14

3-4

Getting Started with the SNMP function

CongurationandstartwithSNMP

Inthe«TagEdit»window,selectanexistingtag(newtagscanbeaddedasre-

quired).BestpracticewouldbetoaddanS_SNMPtag.Individualtagscontain

onlyalphanumerics,underscoresandsingledots.

ForallsymbolsthathavetobepresentintheMIBle,assignthetag.Makesure

thatallvariablesfortheSNMParepublic.

Savealllesandcompiletheproject.

Saia-Burgess Controls AG

Manual SNMP │ Document 27-639 – Edition ENG03 │ 2017-09-14

3-5

Getting Started with the SNMP function

CongurationandstartwithSNMP

HowtogeneratethedeviceMIBle

ByinsertingadevicemiblewithFile/Newinthe«ProgramFiles»folderandcon-

guringthe«SymbolTagNames»(asused/denedinthesymboleditor).

OpenthesymbolMIB.mibleandaddthetagfromthesymboleditor

(here:S_SNMP)

Afterthatthe.mibFileswillbecreatedautomaticallywiththenextcompilation.The

generatedlescanbefoundinthedevice«DocumentationFiles»folder,aswells

intherelatedlogle.

ThefunctionwillalwaysgeneratethestandardSaiaMIB_Classic.mibleaswell.

ThisleisneededinadditiontothesymbolMIB.miblewegenerated.

Saia-Burgess Controls AG

Manual SNMP │ Document 27-639 – Edition ENG03 │ 2017-09-14

3-6

Getting Started with the SNMP function

CongurationandstartwithSNMP

3.4.3 PCconguration

InstallationoftheMIBBrowsersoftwarefromhttp://www.ireasoning.com/

OpentheMIBBrowserandselecttheMIBFilesfromyourprojectfolder(openthe

projectfolderinPG5ProjectManagerwithTools/Explorer)withFile/LoadMIBs.

Figure3.2:MIBTreeiniReasoning

ConnectyourComputerviatheEthernetcabletoyourPCDandensurethatthe

Windowsrewall–oranyothersoftwarerewallyouareusing–iscorrectlyad-

justed.Itiseasiertoshutdownthere-wallservicecompletely.Theriskinvolvedis

small,becauseyouareonlyusingtheLAN.Attheendofthetest,theservicemust

be reactivated.

Saia-Burgess Controls AG

Manual SNMP │ Document 27-639 – Edition ENG03 │ 2017-09-14

3-7

Getting Started with the SNMP function

CongurationandstartwithSNMP

3.4.4 Examples of Snmpget function

ToreaddatafromyourPCDyouhavetofollowtheinstructionsbelow.

1. WritetheIPaddressofyourPCDdevice(SNMPAgent)intheaddresswindow

2. Selecttheregisterreg1000-32sintheMIBtree

TheOIDnumberoftheregisterwillappearautomaticallyintheOIDwindow

3. ThelastnumberoftheOIDistheregisteraddress.Inourexampleregister1is

selected.YoucanchangethisdirectlyintheOIDwindow.

4. SettheOperationstoGet

Thisfunctionreadsthevaluefromtheregister

5. Press Go to read the value

Intheexampletheregisterhasthevalue0

Figure3.3:Readvaluefromregister1withiReasoning

Saia-Burgess Controls AG

Manual SNMP │ Document 27-639 – Edition ENG03 │ 2017-09-14

3-8

Getting Started with the SNMP function

CongurationandstartwithSNMP

ThevalueofRegister1cannowbechangedwiththeSBCOnlineDebuggerand

thesnmpgetcommandcanbeexecutedagain.

Figure3.4:OnlineDebuggerinPG5towrite10toregister1

Figure3.5:ChangedregistervalueiniReasoning

Further examples for reading values:

PCD Run / Stop switch:

MIBTree:Private/enterprises/saiapcdMIB/pcdSwitchState

→pcdSwitchState.0=1(PCDinrun)

MIBTree:Private/enterprises/saiapcdMIB/pcdSwitchState

→pcdSwitchState.0=0(PCDinstop)

Saia-Burgess Controls AG

Manual SNMP │ Document 27-639 – Edition ENG03 │ 2017-09-14

3-9

Getting Started with the SNMP function

CongurationandstartwithSNMP

3.4.5 Examples of Snmpset function

Inthisexample,thevaluesbc123hasbeensetfortheparameterWritecom-

munity.Thisistoprotectagainstunauthorizedwriteaccess.However,itmustbe

rememberedthatthesepasswordsaresentoverthenetworkwithoutencryption.

Figure3.6:Settingsinthedevicecongurator

Thesettingsyoumadeinthedeviceconguratorhavetobemadeinthead-

vancedsettingsoftheMIBbrowseraswell:

1. Writecommunity=sbc123

2. SNMPversion=2(inthedeviceconguratorV2c)

Figure3.7:SettingsforwriteaccessintheMIBBrowser

Afterthatchangetheoperationsparameterto<set>andllinanyvalueyouwant

towritetoregister1.PressOKtoexecutethewritecommand.

Figure3.8:SetcommandiniReasoning

Saia-Burgess Controls AG

Manual SNMP │ Document 27-639 – Edition ENG03 │ 2017-09-14

3-10

Getting Started with the SNMP function

CongurationandstartwithSNMP

Aftersettingthevalue,youcanreaditagaintomakesureithasworked.

Figure3.9:Checkifthesetcommandworked

3.4.6 Switching Symbols via SNMP

OpentheMIBBrowserandselecttheMIBlefromyourprojectfolder.TheSaia-

MIB_Classic.mibmusthavebeenloadedinadvance!

Youwillndthesymbolsintherelatedmediatable.Inourexampletheags

switch0andswitch1areagvaluesandtheregisternumberisaregistervalue.

Youcanchangethevariablesdirectlywiththesetcommand.Rememberto

changethewritecommunityintheadvancedfunctionstothesamesettingsasin

Saia-Burgess Controls AG

Manual SNMP │ Document 27-639 – Edition ENG03 │ 2017-09-14

3-11

Getting Started with the SNMP function

CongurationandstartwithSNMP

thedevicecongurator.(Descriptioninchapter3.4.1)

AfteryouhavesetthevariableyoucanseethereactiondirectlyinPG5.

Note:NotalldatatypesinthesymboleditorcanbeaddedtotheMIBle.The

datatypeswillalsobedierenttothetypesinPG5.Refertothetablebelow:

PG5 Data Type SNMP Data Type

IO(Input/Output) Integer32

F(Flag) Integer32

C (Counter) Integer32

R(Register) Integer32

RFLOAT(Registeroat) notsupportedbySNMP

TEXTRAM not available

T(Timer) Integer32

DB Integer32(ForeveryIndexoftheDBa

newIntegerwillbegenerated)

Saia-Burgess Controls AG

Manual SNMP │ Document 27-639 – Edition ENG03 │ 2017-09-14

3-12

Getting Started with the SNMP function

CongurationandstartwithSNMP

SBC SNMP function of Saia PCD® Owner's manual

Related papers

Other documents