com.sun.management.snmp
Interface SnmpDefinitions

All Known Subinterfaces:
SnmpInformHandler, SnmpRequestHandler
All Known Implementing Classes:
SnmpAdaptorServer, SnmpInformRequest, SnmpMessage, SnmpMsg, SnmpParams, SnmpPdu, SnmpRequest, SnmpSession, SnmpStatusException

public interface SnmpDefinitions

Contains SNMP constants related to command and response codes. All members are static and can be used by any application.

Since:
Java DMK 5.1
Version:
4.28 04/22/04
Author:
Sun Microsystems, Inc, Cisco Systems, Inc.

Field Summary
static int authMask
          Mask used to isolate authentication information within a message flag.
static int authNoPriv
          Security level.
static int authPriv
          Security level.
static int authPrivMask
          Mask used to isolate authentication and privacy information within a message flag.
static int CtxtConsFlag
          ASN.1 prefix for encoding PDU types.
static int noAuthNoPriv
          Security level.
static int noGroupName
          Error that is returned by VACM.
static int noSuchContext
          Error that is returned by VACM.
static int noSuchView
          Error that is returned by VACM.
static int notInView
          Error that is returned by VACM.
static int pduGetBulkRequestPdu
          Represents a GetBulkRequest PDU type (V2 only).
static int pduGetNextRequestPdu
          Represents a GetNextRequest PDU type (V1 or V2).
static int pduGetRequestPdu
          Represents a GetRequest PDU type (V1 or V2).
static int pduGetResponsePdu
          Represents a GetResponse PDU type (V1 or V2).
static int pduInformRequestPdu
          Represents an InformRequest PDU type (V2 only).
static int pduReportPdu
          Represents a Report PDU type (V2 only).
static int pduSetRequestPdu
          Represents a SetRequest PDU type (V1 or V2).
static int pduV1TrapPdu
          Represents a V1Trap PDU type (V1 only).
static int pduV2TrapPdu
          Represents a V2Trap PDU type (V2 only).
static int pduWalkRequest
          Represents a Walk request.
static int privMask
          Mask used to isolate privacy information within a message flag.
static int reportableFlag
          Flag that indicates that a report is to be sent.
static int snmpAuthNotSupported
          SNMP V3 Error code specific to the API.
static int snmpBadSecurityLevel
          SNMP V3 Error code specific to the API.
static int snmpPrivNotSupported
          SNMP V3 Error code specific to the API.
static int snmpReqAborted
          Error code specific to the API.
static int snmpReqEncodingError
          Error code specific to the API.
static int snmpReqHandleTooBig
          Error code specific to the API.
static int snmpReqInternalError
          Error code specific to the API.
static int snmpReqPacketOverflow
          Error code specific to the API.
static int snmpReqRefireAfterVbFix
          Error code specific to the API.
static int snmpReqSocketIOError
          Error code specific to the API.
static int snmpReqTimeout
          Error code specific to the API.
static int snmpReqTooBigImpossible
          Error code specific to the API.
static int snmpReqUnknownError
          Error code specific to the API.
static int snmpRspAuthorizationError
          Error code as defined in RFC 1448 for: authorizationError.
static int snmpRspBadValue
          Error code as defined in RFC 1448 for: badValue.
static int snmpRspCommitFailed
          Error code as defined in RFC 1448 for: commitFailed.
static int snmpRspDecodingError
          Error code specific to the API.
static int snmpRspEndOfTable
          Error code specific to the API.
static int snmpRspGenErr
          Error code as defined in RFC 1448 for: genErr.
static int snmpRspInconsistentName
          Error code as defined in RFC 1448 for: inconsistentName.
static int snmpRspInconsistentValue
          Error code as defined in RFC 1448 for: inconsistentValue.
static int snmpRspNoAccess
          Error code as defined in RFC 1448 for: noAccess.
static int snmpRspNoCreation
          Error code as defined in RFC 1448 for: noCreation.
static int snmpRspNoError
          Error code as defined in RFC 1448 for: noError.
static int snmpRspNoSuchName
          Error code as defined in RFC 1448 for: noSuchName.
static int snmpRspNotWritable
          Error code as defined in RFC 1448 for: notWritable.
static int snmpRspReadOnly
          Error code as defined in RFC 1448 for: readOnly.
static int snmpRspResourceUnavailable
          Error code as defined in RFC 1448 for: resourceUnavailable.
static int snmpRspTooBig
          Error code as defined in RFC 1448 for: tooBig.
static int snmpRspUndoFailed
          Error code as defined in RFC 1448 for: undoFailed.
static int snmpRspWrongEncoding
          Error code as defined in RFC 1448 for: wrongEncoding.
static int snmpRspWrongLength
          Error code as defined in RFC 1448 for: wrongLength.
static int snmpRspWrongType
          Error code as defined in RFC 1448 for: wrongType.
static int snmpRspWrongValue
          Error code as defined in RFC 1448 for: wrongValue.
static int snmpUnknownPrincipal
          SNMP V3 Error code specific to the API.
static int snmpUsmBadEngineId
          SNMP Usm V3 Error code specific to the API.
static int snmpUsmInvalidTimeliness
          SNMP Usm V3 Error code specific to the API.
static int snmpUsmSecurityModel
          Snmp V3 security model id (3).
static int snmpV1AccessControlModel
          Snmp V1 access control model id (0).
static int snmpV1MsgProcessingModel
          Snmp V1 msg processing model id (0).
static int snmpV1SecurityModel
          Snmp V1 security model id (1).
static int snmpV2AccessControlModel
          Snmp V2 access control model id (1).
static int snmpV2MsgProcessingModel
          Snmp V2 msg processing model id (1).
static int snmpV2SecurityModel
          Snmp V2 security model id (2).
static int snmpV3AccessControlModel
          Snmp V3 access control model id (3).
static int snmpV3MsgProcessingModel
          Snmp V3 msg processing model id (3).
static byte snmpVersionOne
          Represents the SNMP protocol version: SnmpV1.
static byte snmpVersionThree
          Represents the SNMP protocol version: SnmpV3.
static byte snmpVersionTwo
          Represents the SNMP protocol version: SnmpV2.
static int snmpWrongSnmpVersion
          Error code specific to the API.
static int trapAuthenticationFailure
          Code as defined in RFC 1157 for generic trap info in Trap-PDU: authenticationFailure.
static int trapColdStart
          Code as defined in RFC 1157 for generic trap info in Trap-PDU: coldStart.
static int trapEgpNeighborLoss
          Code as defined in RFC 1157 for generic trap info in Trap-PDU: egpNeighborLoss.
static int trapEnterpriseSpecific
          Code as defined in RFC 1157 for generic trap info in Trap-PDU: enterpriseSpecific.
static int trapLinkDown
          Code as defined in RFC 1157 for generic trap info in Trap-PDU: linkDown.
static int trapLinkUp
          Code as defined in RFC 1157 for generic trap info in Trap-PDU: linkUp.
static int trapWarmStart
          Code as defined in RFC 1157 for generic trap info in Trap-PDU: warmStart.
 

Field Detail

noAuthNoPriv

public static final int noAuthNoPriv
Security level. No authentication, no privacy. Value is 0, as defined in RFC 2572.

See Also:
Constant Field Values

authNoPriv

public static final int authNoPriv
Security level. Authentication, no privacy. Value is 1, as defined in RFC 2572.

See Also:
Constant Field Values

authPriv

public static final int authPriv
Security level. Authentication, privacy. Value is 3, as defined in RFC 2572.

See Also:
Constant Field Values

reportableFlag

public static final int reportableFlag
Flag that indicates that a report is to be sent. Value is 4, as defined in RFC 2572.

See Also:
Constant Field Values

authMask

public static final int authMask
Mask used to isolate authentication information within a message flag.

See Also:
Constant Field Values

privMask

public static final int privMask
Mask used to isolate privacy information within a message flag.

See Also:
Constant Field Values

authPrivMask

public static final int authPrivMask
Mask used to isolate authentication and privacy information within a message flag.

See Also:
Constant Field Values

CtxtConsFlag

public static final int CtxtConsFlag
ASN.1 prefix for encoding PDU types.

See Also:
Constant Field Values

snmpVersionOne

public static final byte snmpVersionOne
Represents the SNMP protocol version: SnmpV1.

See Also:
Constant Field Values

snmpVersionTwo

public static final byte snmpVersionTwo
Represents the SNMP protocol version: SnmpV2.

See Also:
Constant Field Values

snmpVersionThree

public static final byte snmpVersionThree
Represents the SNMP protocol version: SnmpV3.

See Also:
Constant Field Values

pduGetRequestPdu

public static final int pduGetRequestPdu
Represents a GetRequest PDU type (V1 or V2).

See Also:
Constant Field Values

pduGetNextRequestPdu

public static final int pduGetNextRequestPdu
Represents a GetNextRequest PDU type (V1 or V2).

See Also:
Constant Field Values

pduGetResponsePdu

public static final int pduGetResponsePdu
Represents a GetResponse PDU type (V1 or V2).

See Also:
Constant Field Values

pduSetRequestPdu

public static final int pduSetRequestPdu
Represents a SetRequest PDU type (V1 or V2).

See Also:
Constant Field Values

pduGetBulkRequestPdu

public static final int pduGetBulkRequestPdu
Represents a GetBulkRequest PDU type (V2 only).

See Also:
Constant Field Values

pduWalkRequest

public static final int pduWalkRequest
Represents a Walk request. A walk uses the getNext request to "walk" through a given MIB.

See Also:
Constant Field Values

pduV1TrapPdu

public static final int pduV1TrapPdu
Represents a V1Trap PDU type (V1 only).

See Also:
Constant Field Values

pduV2TrapPdu

public static final int pduV2TrapPdu
Represents a V2Trap PDU type (V2 only).

See Also:
Constant Field Values

pduInformRequestPdu

public static final int pduInformRequestPdu
Represents an InformRequest PDU type (V2 only).

See Also:
Constant Field Values

pduReportPdu

public static final int pduReportPdu
Represents a Report PDU type (V2 only).

See Also:
Constant Field Values

trapColdStart

public static final int trapColdStart
Code as defined in RFC 1157 for generic trap info in Trap-PDU: coldStart.

See Also:
Constant Field Values

trapWarmStart

public static final int trapWarmStart
Code as defined in RFC 1157 for generic trap info in Trap-PDU: warmStart.

See Also:
Constant Field Values

trapLinkDown

public static final int trapLinkDown
Code as defined in RFC 1157 for generic trap info in Trap-PDU: linkDown.

See Also:
Constant Field Values

trapLinkUp

public static final int trapLinkUp
Code as defined in RFC 1157 for generic trap info in Trap-PDU: linkUp.

See Also:
Constant Field Values

trapAuthenticationFailure

public static final int trapAuthenticationFailure
Code as defined in RFC 1157 for generic trap info in Trap-PDU: authenticationFailure.

See Also:
Constant Field Values

trapEgpNeighborLoss

public static final int trapEgpNeighborLoss
Code as defined in RFC 1157 for generic trap info in Trap-PDU: egpNeighborLoss.

See Also:
Constant Field Values

trapEnterpriseSpecific

public static final int trapEnterpriseSpecific
Code as defined in RFC 1157 for generic trap info in Trap-PDU: enterpriseSpecific.

See Also:
Constant Field Values

snmpRspNoError

public static final int snmpRspNoError
Error code as defined in RFC 1448 for: noError.

See Also:
Constant Field Values

snmpRspTooBig

public static final int snmpRspTooBig
Error code as defined in RFC 1448 for: tooBig.

See Also:
Constant Field Values

snmpRspNoSuchName

public static final int snmpRspNoSuchName
Error code as defined in RFC 1448 for: noSuchName.

See Also:
Constant Field Values

snmpRspBadValue

public static final int snmpRspBadValue
Error code as defined in RFC 1448 for: badValue.

See Also:
Constant Field Values

snmpRspReadOnly

public static final int snmpRspReadOnly
Error code as defined in RFC 1448 for: readOnly.

See Also:
Constant Field Values

snmpRspGenErr

public static final int snmpRspGenErr
Error code as defined in RFC 1448 for: genErr.

See Also:
Constant Field Values

snmpRspNoAccess

public static final int snmpRspNoAccess
Error code as defined in RFC 1448 for: noAccess.

See Also:
Constant Field Values

snmpRspWrongType

public static final int snmpRspWrongType
Error code as defined in RFC 1448 for: wrongType.

See Also:
Constant Field Values

snmpRspWrongLength

public static final int snmpRspWrongLength
Error code as defined in RFC 1448 for: wrongLength.

See Also:
Constant Field Values

snmpRspWrongEncoding

public static final int snmpRspWrongEncoding
Error code as defined in RFC 1448 for: wrongEncoding.

See Also:
Constant Field Values

snmpRspWrongValue

public static final int snmpRspWrongValue
Error code as defined in RFC 1448 for: wrongValue.

See Also:
Constant Field Values

snmpRspNoCreation

public static final int snmpRspNoCreation
Error code as defined in RFC 1448 for: noCreation.

See Also:
Constant Field Values

snmpRspInconsistentValue

public static final int snmpRspInconsistentValue
Error code as defined in RFC 1448 for: inconsistentValue.

See Also:
Constant Field Values

snmpRspResourceUnavailable

public static final int snmpRspResourceUnavailable
Error code as defined in RFC 1448 for: resourceUnavailable.

See Also:
Constant Field Values

snmpRspCommitFailed

public static final int snmpRspCommitFailed
Error code as defined in RFC 1448 for: commitFailed.

See Also:
Constant Field Values

snmpRspUndoFailed

public static final int snmpRspUndoFailed
Error code as defined in RFC 1448 for: undoFailed.

See Also:
Constant Field Values

snmpRspAuthorizationError

public static final int snmpRspAuthorizationError
Error code as defined in RFC 1448 for: authorizationError.

See Also:
Constant Field Values

snmpRspNotWritable

public static final int snmpRspNotWritable
Error code as defined in RFC 1448 for: notWritable.

See Also:
Constant Field Values

snmpRspInconsistentName

public static final int snmpRspInconsistentName
Error code as defined in RFC 1448 for: inconsistentName.

See Also:
Constant Field Values

noSuchView

public static final int noSuchView
Error that is returned by VACM.

See Also:
Constant Field Values

noSuchContext

public static final int noSuchContext
Error that is returned by VACM.

See Also:
Constant Field Values

noGroupName

public static final int noGroupName
Error that is returned by VACM.

See Also:
Constant Field Values

notInView

public static final int notInView
Error that is returned by VACM.

See Also:
Constant Field Values

snmpReqTimeout

public static final int snmpReqTimeout
Error code specific to the API.

Used if the request PDU exceeds the maxTries limit defined in the SnmpPeer object.

See Also:
Constant Field Values

snmpReqAborted

public static final int snmpReqAborted
Error code specific to the API.

Used if the pending request PDU is canceled.

See Also:
Constant Field Values

snmpRspDecodingError

public static final int snmpRspDecodingError
Error code specific to the API.

Used if the response to the request PDU fails at decoding time.

See Also:
Constant Field Values

snmpReqEncodingError

public static final int snmpReqEncodingError
Error code specific to the API.

Used if the request PDU does not retrieve the community string at authentication encoding time.

See Also:
Constant Field Values

snmpReqPacketOverflow

public static final int snmpReqPacketOverflow
Error code specific to the API.

Used if the request PDU does not fit in the maxSnmpPktSize limit defined in the SnmpPeer object.

See Also:
Constant Field Values

snmpRspEndOfTable

public static final int snmpRspEndOfTable
Error code specific to the API.

Used for the last variable returned by a Walk request PDU.

See Also:
Constant Field Values

snmpReqRefireAfterVbFix

public static final int snmpReqRefireAfterVbFix
Error code specific to the API.

Used if the request PDU is retried after a noSuchName error fixed. This is an internal temporary status.

See Also:
Constant Field Values

snmpReqHandleTooBig

public static final int snmpReqHandleTooBig
Error code specific to the API.

Used if the size of the request PDU varBindList exceeds the maxVarBindLimit limit defined in the SnmpPeer object.

See Also:
Constant Field Values

snmpReqTooBigImpossible

public static final int snmpReqTooBigImpossible
Error code specific to the API.

Used if the request PDU fails with a tooBig error status but its varBindList contains just one element.

See Also:
Constant Field Values

snmpReqInternalError

public static final int snmpReqInternalError
Error code specific to the API.

Used if an internal error occurs when processing the request PDU.

See Also:
Constant Field Values

snmpReqSocketIOError

public static final int snmpReqSocketIOError
Error code specific to the API.

Used if an I/O error occurs when sending the request PDU.

See Also:
Constant Field Values

snmpReqUnknownError

public static final int snmpReqUnknownError
Error code specific to the API.

Used if the request PDU fails at encoding time or sending time for a reason not covered by the previous error codes.

See Also:
Constant Field Values

snmpWrongSnmpVersion

public static final int snmpWrongSnmpVersion
Error code specific to the API.

See Also:
Constant Field Values

snmpUnknownPrincipal

public static final int snmpUnknownPrincipal
SNMP V3 Error code specific to the API.

Used if the used principal is unknown.

See Also:
Constant Field Values

snmpAuthNotSupported

public static final int snmpAuthNotSupported
SNMP V3 Error code specific to the API.

Used if authentication is not supported for the current user.

See Also:
Constant Field Values

snmpPrivNotSupported

public static final int snmpPrivNotSupported
SNMP V3 Error code specific to the API.

Used if privacy is not supported for the current user.

See Also:
Constant Field Values

snmpBadSecurityLevel

public static final int snmpBadSecurityLevel
SNMP V3 Error code specific to the API.

Used if privacy is not supported for the current user.

See Also:
Constant Field Values

snmpUsmBadEngineId

public static final int snmpUsmBadEngineId
SNMP Usm V3 Error code specific to the API.

Used if the authoritative engine Id is not associated to the current user.

See Also:
Constant Field Values

snmpUsmInvalidTimeliness

public static final int snmpUsmInvalidTimeliness
SNMP Usm V3 Error code specific to the API.

Used if the timeliness params are invalid.

See Also:
Constant Field Values

snmpV1SecurityModel

public static final int snmpV1SecurityModel
Snmp V1 security model id (1).

See Also:
Constant Field Values

snmpV2SecurityModel

public static final int snmpV2SecurityModel
Snmp V2 security model id (2).

See Also:
Constant Field Values

snmpUsmSecurityModel

public static final int snmpUsmSecurityModel
Snmp V3 security model id (3).

See Also:
Constant Field Values

snmpV1MsgProcessingModel

public static final int snmpV1MsgProcessingModel
Snmp V1 msg processing model id (0).

See Also:
Constant Field Values

snmpV2MsgProcessingModel

public static final int snmpV2MsgProcessingModel
Snmp V2 msg processing model id (1).

See Also:
Constant Field Values

snmpV3MsgProcessingModel

public static final int snmpV3MsgProcessingModel
Snmp V3 msg processing model id (3).

See Also:
Constant Field Values

snmpV1AccessControlModel

public static final int snmpV1AccessControlModel
Snmp V1 access control model id (0).

See Also:
Constant Field Values

snmpV2AccessControlModel

public static final int snmpV2AccessControlModel
Snmp V2 access control model id (1).

See Also:
Constant Field Values

snmpV3AccessControlModel

public static final int snmpV3AccessControlModel
Snmp V3 access control model id (3).

See Also:
Constant Field Values

FCS Release
jdmk-5_1-b34.2 2005.11.29_16:24:00_MET

Copyright 1998-2004 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.