339 lines
8.8 KiB
Groff
339 lines
8.8 KiB
Groff
RFC1157-SNMP DEFINITIONS ::= BEGIN
|
|
|
|
-- IMPORTS
|
|
-- ObjectName, ObjectSyntax, NetworkAddress, IpAddress, TimeTicks
|
|
-- FROM RFC1155-SMI;
|
|
--
|
|
-- Local imports
|
|
-- IMPORTS
|
|
-- ObjectName, ObjectSyntax, NetworkAddress, IpAddress, TimeTicks
|
|
-- FROM RFC1155-SMI;
|
|
--
|
|
-- names of objects
|
|
-- (Note that these definitions of ObjectName and NotificationName
|
|
-- are not to be IMPORTed by MIB modules.)
|
|
--
|
|
|
|
--ObjectSyntax ::= CHOICE {
|
|
-- simple SimpleSyntax,
|
|
-- application-wide ApplicationSyntax
|
|
--}
|
|
|
|
--SimpleSyntax ::= CHOICE {
|
|
-- integer-value Integer-value,
|
|
-- string-value String-value,
|
|
-- objectID-value ObjectID-value,
|
|
-- empty Empty
|
|
--}
|
|
|
|
--String-value ::= OCTET STRING (SIZE (0..65535))
|
|
|
|
-- includes Integer32
|
|
--Integer-value ::= INTEGER (-2147483648..2147483647)
|
|
|
|
--Integer32 ::= INTEGER (-2147483648..2147483647)
|
|
|
|
--ObjectID-value ::= OBJECT IDENTIFIER
|
|
|
|
--Empty ::= NULL
|
|
|
|
-- hundredths of seconds since an event, usualy the last restart
|
|
--TimeTicks ::= [APPLICATION 3] IMPLICIT INTEGER (0..4294967295)
|
|
|
|
--Opaque ::= [APPLICATION 4] IMPLICIT OCTET STRING
|
|
|
|
--Counter64 ::= [APPLICATION 6] IMPLICIT INTEGER (0..18446744073709551615)
|
|
|
|
--ApplicationSyntax ::= CHOICE {
|
|
-- ipAddress-value IpAddress,
|
|
-- counter-value Counter32,
|
|
-- timeticks-value TimeTicks,
|
|
-- arbitrary-value Opaque,
|
|
-- big-counter-value Counter64,
|
|
-- unsigned-integer-value Unsigned32
|
|
-- includes Gauge32
|
|
--}
|
|
--NetworkAddress ::= CHOICE { internet IpAddress }
|
|
--IpAddress ::= [APPLICATION 0] IMPLICIT OCTET STRING (SIZE (4))
|
|
|
|
NotificationName ::= OBJECT IDENTIFIER
|
|
EnterpriseOID ::= OBJECT IDENTIFIER
|
|
NetworkAddress ::= [APPLICATION 0] IMPLICIT OCTET STRING (SIZE (4))
|
|
TimeTicks ::= [APPLICATION 3] IMPLICIT INTEGER (0..4294967295)
|
|
Integer32 ::= INTEGER (-2147483648..2147483647)
|
|
ObjectName ::= OBJECT IDENTIFIER
|
|
--Counter32 ::= [APPLICATION 1] IMPLICIT INTEGER (0..4294967295)
|
|
--Gauge32 ::= [APPLICATION 2] IMPLICIT INTEGER (0..4294967295)
|
|
--Unsigned32 ::= [APPLICATION 2] IMPLICIT INTEGER (0..4294967295)
|
|
|
|
-- End Import
|
|
|
|
Message ::= SEQUENCE {
|
|
version Version,
|
|
community OCTET STRING,
|
|
data PDUs
|
|
}
|
|
|
|
Version ::= INTEGER { version-1(0), v2c(1), v2u (2), snmpv3(3) }
|
|
|
|
|
|
Messagev2u ::=
|
|
SEQUENCE {
|
|
version Version,
|
|
parameters OCTET STRING,
|
|
-- <model=1>
|
|
-- <qoS><agentID><agentBoots><agentTime><maxSize>
|
|
-- <userLen><userName><authLen><authDigest>
|
|
-- <contextSelector>
|
|
|
|
datav2u CHOICE {
|
|
plaintext PDUs,
|
|
encrypted OCTET STRING
|
|
}
|
|
}
|
|
|
|
-- USMSecurityParametersSyntax DEFINITIONS IMPLICIT TAGS ::= BEGIN
|
|
|
|
UsmSecurityParameters ::= SEQUENCE {
|
|
-- global User-based security parameters
|
|
msgAuthoritativeEngineID SnmpEngineID,
|
|
msgAuthoritativeEngineBoots INTEGER (0..2147483647),
|
|
msgAuthoritativeEngineTime INTEGER (0..2147483647),
|
|
msgUserName OCTET STRING (SIZE(1..32)),
|
|
-- authentication protocol specific parameters
|
|
msgAuthenticationParameters OCTET STRING,
|
|
-- privacy protocol specific parameters
|
|
msgPrivacyParameters OCTET STRING
|
|
}
|
|
-- END USMSecurityParametersSyntax
|
|
|
|
SnmpEngineID ::= OCTET STRING
|
|
|
|
-- SNMPv3MessageSyntax DEFINITIONS IMPLICIT TAGS ::= BEGIN
|
|
|
|
SNMPv3Message ::= SEQUENCE {
|
|
-- identify the layout of the SNMPv3Message
|
|
-- this element is in same position as in SNMPv1
|
|
-- and SNMPv2c, allowing recognition
|
|
-- the value 3 is used for snmpv3
|
|
msgVersion Version,
|
|
-- INTEGER ( 0 .. 2147483647 ),
|
|
-- administrative parameters
|
|
msgGlobalData HeaderData,
|
|
-- security model-specific parameters
|
|
-- format defined by Security Model
|
|
msgSecurityParameters OCTET STRING,
|
|
msgData ScopedPduData
|
|
}
|
|
|
|
HeaderData ::= SEQUENCE {
|
|
msgID INTEGER (0..2147483647),
|
|
msgMaxSize INTEGER (484..2147483647),
|
|
|
|
msgFlags OCTET STRING (SIZE(1)),
|
|
-- .... ...1 authFlag
|
|
-- .... ..1. privFlag
|
|
-- .... .1.. reportableFlag
|
|
-- Please observe:
|
|
-- .... ..00 is OK, means noAuthNoPriv
|
|
-- .... ..01 is OK, means authNoPriv
|
|
-- .... ..10 reserved, must NOT be used.
|
|
-- .... ..11 is OK, means authPriv
|
|
|
|
msgSecurityModel INTEGER (1..2147483647)
|
|
}
|
|
|
|
|
|
ScopedPduData ::= CHOICE {
|
|
plaintext ScopedPDU,
|
|
encryptedPDU OCTET STRING -- encrypted scopedPDU value
|
|
}
|
|
|
|
ScopedPDU ::= SEQUENCE {
|
|
contextEngineID SnmpEngineID,
|
|
contextName OCTET STRING,
|
|
data PDUs
|
|
-- ANY
|
|
-- e.g., PDUs as defined in RFC 1905
|
|
}
|
|
|
|
-- END SNMPv3MessageSyntax
|
|
-- protocol data units
|
|
|
|
PDUs ::= CHOICE {
|
|
get-request GetRequest-PDU,
|
|
get-next-request GetNextRequest-PDU,
|
|
get-response GetResponse-PDU,
|
|
set-request SetRequest-PDU,
|
|
trap Trap-PDU,
|
|
getBulkRequest GetBulkRequest-PDU,
|
|
informRequest InformRequest-PDU,
|
|
snmpV2-trap SNMPv2-Trap-PDU,
|
|
report Report-PDU
|
|
}
|
|
|
|
-- PDUs
|
|
|
|
GetRequest-PDU ::= [0] IMPLICIT PDU
|
|
GetNextRequest-PDU ::= [1] IMPLICIT PDU
|
|
GetResponse-PDU ::= [2] IMPLICIT PDU
|
|
|
|
SetRequest-PDU ::= [3] IMPLICIT PDU
|
|
|
|
-- v2 added
|
|
-- [4] is obsolete
|
|
GetBulkRequest-PDU ::= [5] IMPLICIT BulkPDU
|
|
InformRequest-PDU ::= [6] IMPLICIT PDU
|
|
SNMPv2-Trap-PDU ::= [7] IMPLICIT PDU
|
|
|
|
-- Usage and precise semantics of Report-PDU are not presently
|
|
-- defined. Any SNMP administrative framework making use of
|
|
-- this PDU must define its usage and semantics.
|
|
Report-PDU ::= [8] IMPLICIT PDU
|
|
|
|
|
|
PDU ::= SEQUENCE {
|
|
request-id INTEGER,
|
|
error-status INTEGER {
|
|
noError(0),
|
|
tooBig(1),
|
|
noSuchName(2), -- for proxy compatibility
|
|
badValue(3), -- for proxy compatibility
|
|
readOnly(4), -- for proxy compatibility
|
|
genErr(5),
|
|
noAccess(6),
|
|
wrongType(7),
|
|
wrongLength(8),
|
|
wrongEncoding(9),
|
|
wrongValue(10),
|
|
noCreation(11),
|
|
inconsistentValue(12),
|
|
resourceUnavailable(13),
|
|
commitFailed(14),
|
|
undoFailed(15),
|
|
authorizationError(16),
|
|
notWritable(17),
|
|
inconsistentName(18)
|
|
},
|
|
error-index INTEGER,
|
|
variable-bindings VarBindList
|
|
}
|
|
|
|
-- v2
|
|
BulkPDU ::= SEQUENCE { -- MUST be identical in structure to PDU
|
|
request-id Integer32,
|
|
non-repeaters INTEGER (0..2147483647),
|
|
max-repetitions INTEGER (0..2147483647),
|
|
variable-bindings VarBindList
|
|
}
|
|
|
|
-- end v2
|
|
Trap-PDU ::= [4] IMPLICIT SEQUENCE {
|
|
enterprise EnterpriseOID, -- type of object generating trap, see sysObjectID in [5]
|
|
agent-addr NetworkAddress, -- address of object generating trap
|
|
generic-trap INTEGER { -- generic trap type
|
|
coldStart(0),
|
|
warmStart(1),
|
|
linkDown(2),
|
|
linkUp(3),
|
|
authenticationFailure(4),
|
|
egpNeighborLoss(5),
|
|
enterpriseSpecific(6)
|
|
},
|
|
specific-trap INTEGER, -- specific code, present even if generic-trap is not enterpriseSpecific
|
|
time-stamp TimeTicks, -- time elapsed between the last (re)initialization of the network entity and the generation of the trap
|
|
variable-bindings VarBindList -- "interesting" information
|
|
}
|
|
|
|
|
|
-- variable bindings
|
|
|
|
VarBind ::= SEQUENCE { name ObjectName, valueType ValueType }
|
|
-- SEQUENCE {
|
|
-- name ObjectName,
|
|
-- valueType ValueType
|
|
-- }
|
|
|
|
--ValueType ::= CHOICE {
|
|
-- value ObjectSyntax,
|
|
-- unSpecified NULL,
|
|
-- in retrieval requests
|
|
-- exceptions in responses
|
|
-- noSuchObject[0] IMPLICIT NULL,
|
|
-- noSuchInstance[1] IMPLICIT NULL,
|
|
-- endOfMibView[2] IMPLICIT NULL
|
|
--}
|
|
|
|
VarBindList ::= SEQUENCE OF VarBind
|
|
|
|
-- SMUX DEFINITIONS ::= BEGIN RFC 1227
|
|
|
|
SMUX-PDUs ::= CHOICE {
|
|
open OpenPDU,-- SMUX peer uses immediately after TCP open
|
|
close ClosePDU, -- either uses immediately before TCP close
|
|
registerRequest RReqPDU, -- SMUX peer uses
|
|
|
|
-- registerResponse .. SNMP agent uses
|
|
-- RRspPDU,
|
|
--
|
|
-- PDUs,
|
|
-- Rewritten
|
|
registerResponse RegisterResponse,
|
|
-- note that roles are reversed:
|
|
-- SNMP agent does get/get-next/set
|
|
-- SMUX peer does get-response/trap
|
|
|
|
commitOrRollback -- SNMP agent uses
|
|
SOutPDU
|
|
}
|
|
|
|
RegisterResponse ::= CHOICE {
|
|
rRspPDU RRspPDU,
|
|
pDUs PDUs
|
|
}
|
|
|
|
-- open PDU
|
|
-- currently only simple authentication
|
|
|
|
OpenPDU ::= CHOICE {
|
|
smux-simple SimpleOpen
|
|
}
|
|
|
|
SimpleOpen ::= [APPLICATION 0] IMPLICIT SEQUENCE {
|
|
smux-version INTEGER { version-1(0) }, -- of SMUX protocol
|
|
identity OBJECT IDENTIFIER, -- of SMUX peer, authoritative
|
|
description DisplayString, -- of SMUX peer, implementation-specific
|
|
password OCTET STRING -- zero length indicates no authentication
|
|
}
|
|
|
|
DisplayString ::= OCTET STRING
|
|
|
|
ClosePDU ::= [APPLICATION 1] IMPLICIT INTEGER {
|
|
goingDown(0),
|
|
unsupportedVersion(1),
|
|
packetFormat(2),
|
|
protocolError(3),
|
|
internalError(4),
|
|
authenticationFailure(5)
|
|
}
|
|
|
|
|
|
-- insert PDU
|
|
RReqPDU ::= [APPLICATION 2] IMPLICIT SEQUENCE {
|
|
subtree ObjectName,
|
|
priority INTEGER (-1..2147483647), -- the lower the better, "-1" means default
|
|
|
|
operation INTEGER {
|
|
delete(0), -- remove registration
|
|
readOnly(1), -- add registration, objects are RO
|
|
readWrite(2) -- .., objects are RW
|
|
}
|
|
}
|
|
|
|
RRspPDU ::= [APPLICATION 3] IMPLICIT INTEGER { failure(-1) } -- on success the non-negative priority is returned
|
|
SOutPDU ::= [APPLICATION 4] IMPLICIT INTEGER { commit(0), rollback(1) }
|
|
|
|
END
|
|
|
|
|