MrMeeb/snmp_mib_archive
1
0
Fork 0
mirror of https://github.com/hsnodgrass/snmp_mib_archive.git synced 2025-04-17 16:03:04 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
snmp_mib_archive/XGCP-MIB.my 2
Heston Snodgrass 89bf4b016e initial commit
2016-12-15 15:03:18 -07:00

863 lines
27 KiB
Plaintext
Raw Blame History

-- ********************************************************************
-- XGCP-MIB.my: Media Gateway Control Protocol Management Information
-- Base
--
-- November 1998, Dinh D. Nguyen and Rick Chen
--
-- Copyright (c) 1998-99 by cisco Systems, Inc.
-- All rights reserved.
-- ********************************************************************
--
-- Currently, no RFC or Internet-Draft MIB is defined to manage Media
-- Gateway Control protocols - XGCP (e.g. MGCP, SGCP).This new XGCP-MIB
-- has to be defined for managing SGCP/MGCP interfaces and information.
--
-- The MIB is based on the following control protocol specifications:
-- 1. Simple Gateway Control Protocol, Maurico Arango, Christian
-- Huitema, Draft16, Version 1.1, June 30, 1998
-- 2. Media Gateway Control Protocol, Mauricio Arango, Andrew Dugan,
-- Issac Elliot, Christian Huitema, Scott Pickett, INTERNET-DRAFT,
-- Feb 1, 1999
XGCP-MIB DEFINITIONS ::= BEGIN
IMPORTS
experimental,
MODULE-IDENTITY,
OBJECT-TYPE,
Integer32,
Counter32,
IpAddress,
NOTIFICATION-TYPE
FROM SNMPv2-SMI
TimeStamp,
TruthValue,
DisplayString
FROM SNMPv2-TC
MODULE-COMPLIANCE,
OBJECT-GROUP
FROM SNMPv2-CONF;
xgcpMIB MODULE-IDENTITY
LAST-UPDATED "9902170000Z"
ORGANIZATION "Will submit this new XGCP-MIB to IETF-DRAFT"
CONTACT-INFO
" Dinh D. Nguyen
Postal: Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA 95134-1706
US
Phone: +1 408 525 1624
Email: dinhn@cisco.com
Rick N. Chen
Postal: Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA 95134-1706
US
Phone: +1 408 525 6367
Email: richen@cisco.com"
DESCRIPTION
"The MIB module for managing XGCP implementations."
REVISION "9902170000Z"
DESCRIPTION
"This is initial version of XGCP MIB."
::= { experimental 90 }
xgcpObjects OBJECT IDENTIFIER ::= { xgcpMIB 1 }
xgcpCoreObjects OBJECT IDENTIFIER ::= { xgcpObjects 1 }
xgcpExtensionObjects OBJECT IDENTIFIER ::= { xgcpObjects 2 }
xgcpPackageObjects OBJECT IDENTIFIER ::= { xgcpObjects 3 }
xgcpVoiceQualityObjects OBJECT IDENTIFIER ::= { xgcpObjects 4 }
xgcpDefaultMGCObjects OBJECT IDENTIFIER ::= { xgcpObjects 5 }
-- *********************************************************************
-- The XGCP Core Group
-- *********************************************************************
xgcpInBadVersions OBJECT-TYPE
SYNTAX Counter32
UNITS "messages"
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The total number of incoming messages which were delivered to
the protocol entity and were for an unsupported protocol
version.
"
::= { xgcpCoreObjects 1 }
xgcpRequestTimeOut OBJECT-TYPE
SYNTAX Integer32 (1..10000)
UNITS "milliseconds"
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The request timeout is used to determine the timeout value used
for retransmitting unacknowledged message.
It is the responsibility of the requesting entity to provide
suitable timeouts for all outstanding commands, and to retry
commands when timeouts exceeded.
The default value of this object is 500 milliseconds.
"
::= { xgcpCoreObjects 2 }
xgcpRequestRetries OBJECT-TYPE
SYNTAX Integer32 (0..10)
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"This object specifies the number of retries for a request that
exceeds timeout.
It is the responsibility of the requesting entity to provide
suitable timeouts for all outstanding commands, and to retry
when times out.
The default value of this object is 3.
"
::= { xgcpCoreObjects 3 }
xgcpAdminStatus OBJECT-TYPE
SYNTAX INTEGER {
up (1),
down (2),
gracefulDown (3)
}
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The desired state of the protocol entity.
The possible admin status are:
up - bring up protocol entity administratively
down - bring down protocol entity adiministratively
gracefulDown - gracefully shut down protocol entity
administratively.
A graceful shutdown indicates that the protocol
will be taken out of service after the restart
delay timer timeouts or all connections are torn down.
When in graceDown, the xgcpOperStatus goes from up to
down via shutDownInProgress.
If there is no connection or restart delay timer
timeouts then xgcpOperStatus moves from
shutDownInProgress to down.
"
DEFVAL { down }
::= { xgcpCoreObjects 4 }
xgcpOperStatus OBJECT-TYPE
SYNTAX INTEGER {
up (1),
down (2),
shutDownInProgress (3)
}
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object indicates the current operational
status of the protocol entity.
The possible operating status are:
up - protocol up
down - protocol down
shutDownInProgress - Shut down in progress.
The operating status - shutDownInProgress indicates
that the Media Gateway is in a transition state from
up to down. This state happens when resources are in
the process of being cleaned up and new resource
can't be allocated.
"
::= { xgcpCoreObjects 5 }
xgcpUnRecognizedPackets OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
" This refers to the count of unrecognized packets
since reset.
"
::= { xgcpCoreObjects 6 }
-- *****************************************************************
-- The XGCP Statistics table
-- *****************************************************************
xgcpMsgStatTable OBJECT-TYPE
SYNTAX SEQUENCE OF XgcpMsgStatEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This table contains XGCP statistics information since reset.
XGCP statistics are kept in this table, with each
table entry containing the statistics of XGCP that
communicates with a Media Gateway Controller (MGC) at
a specific IP address of the MGC.
Each table entry is composed of the following information:
1) Messages successfully received/transmitted per IP device
2) Messages failed to be received/transmitted per IP device
"
::= { xgcpCoreObjects 7 }
xgcpMsgStatEntry OBJECT-TYPE
SYNTAX XgcpMsgStatEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The row of the xgcpMsgStatTable contains
information about XGCP message statistics per IP address
of the Media Gateway Controller.
An entry is created when a request messge with new IP
address is received from Medida Gateway Controller.
When the table is full, an entry is deleted if it is
LRU (Least Recently Used).
"
INDEX { xgcpIPAddress }
::= { xgcpMsgStatTable 1 }
XgcpMsgStatEntry ::= SEQUENCE {
xgcpIPAddress IpAddress,
xgcpSuccessMessages Counter32,
xgcpFailMessages Counter32
}
xgcpIPAddress OBJECT-TYPE
SYNTAX IpAddress
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
" This object specifies the IP address of the
Media Gateway Controller.
"
::= { xgcpMsgStatEntry 1 }
xgcpSuccessMessages OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the count of successful messages
that communicate with the Media Gateway Controller on
that IP address.
Successful messages apply to both transmit and
receive messages.
Transmit: Positive ACK is received from the Media
Gateway Controller
Receive: Positive ACK is sent to the Media Gateway
Controller. This implies that the format
of the message is correct and the request
can be fulfilled.
"
::= { xgcpMsgStatEntry 2 }
xgcpFailMessages OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the count of failed messages
that communicate with the Media Gateway Controller on
that IP address.
Failed messages apply to both transmit and receive
messages.
Transmit: Either NAK is received from the MGC or message
times out waiting for ACK.
Receive: Format of the received message is bad or
the request can not be fulfilled.
"
::= { xgcpMsgStatEntry 3 }
-- *****************************************************************
-- The XGCP Extension Group
-- *****************************************************************
xgcpRestartInProgressMWD OBJECT-TYPE
SYNTAX Integer32 (0..600000)
UNITS "milliseconds"
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The maximum waiting delay (MWD) timeout value is used for the
Media Gateway to send the Restart In Progress to the Media
Gateway Controller.
The default value of this object is chosen in an
implementation-dependent manner by the MGCP functionality
based on the call volume of the system.
"
REFERENCE
" Media Gateway Control Protocol (MGCP),
version 0.1 draft, Feb 1, 1999 : Section 4.3.4
"
::= { xgcpExtensionObjects 1 }
xgcpRestartDelay OBJECT-TYPE
SYNTAX Integer32 (0..600)
UNITS "seconds"
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"This object specifies the Restart Delay Timeout for
the restart process.
The purpose of setting the restart timer before sending
the Restart In Progress notification to the media gateway
controller is to avoid the network congestion
during the critical period of service restoration.
The default value of this object is 0.
"
REFERENCE
" Media Gateway Control Protocol (MGCP),
version 0.1 draft, Feb 1, 1999 : Section 4.3.4
"
::= { xgcpExtensionObjects 2 }
-- *****************************************************************
-- The XGCP Defalut MGC Group
-- *****************************************************************
xgcpMGCCfgAddress OBJECT-TYPE
SYNTAX DisplayString (SIZE (1..64))
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"This object is used to configure either the domain
name or the IP address of the Default Media Gateway
Controller in standard dot notation.
The complete address of a default MGC is cmposed of
IP address/Domain Name and UDP port.
xgcpMGCCfgaddress specifies address of the default Media
Gateway Controller to which RSIP(RestartInProgress) message
is sent whenever system starts up or line goes up.
If DNS name is entered and the IP address is found,
MG will send RSIP to the desired MGC. If no IP address is
found or no such DNS name exists, no RSIP will be sent.
If IP address is entered, MG will send RSIP to that address.
If there is no response, it could be that the network is down
or user misconfigures the address (IP address, Domain Name or
UDP port number)
"
::= { xgcpDefaultMGCObjects 1 }
xgcpMGCCfgUDPPort OBJECT-TYPE
SYNTAX Integer32(1025..65535)
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"This object is used to configure the UDP port
of the Media Gateway Controller.
The UDP port is used together with xgcpMGCCfgAddress to
specify the destination address of the default Media
Gateway Controller to which RSIP message is sent when
system starts up or line goes up.
"
::= { xgcpDefaultMGCObjects 2 }
xgcpMGCCfgConnStatus OBJECT-TYPE
SYNTAX INTEGER {
unknown (1),
connected (2),
connecting (3),
unknownName (4),
noResponse (5)
}
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object is used to specify the connection status
of the Default Media Gateway Controller.
When sending RSIP to default Media Gateway Controller,
there could be the following status:
unknown - undefined stauts.
connected - RSIP sent and response to it is received.
connecting - RSIP is sent and waiting for response.
unknownName - no domain name/ip address is found
when checking the DNS for the domain name
entered in xgcpMGCCfgAddress. No RSIP
message is sent.
noResponse - timeout on RSIP message.
The possible casues for no response on RSIP message:
1) Address(IP Address/Domain Name and UDP) for the default
MGC is correct but MGC in not up or network is down.
2) MGC is up but at a different address (IP Address/
Domain Name)
3) MGC is up and at the same address(IP address/
Domain Name) but wrong UDP port.
4) MGC is down and address is wrong.
"
::= { xgcpDefaultMGCObjects 3 }
xgcpMGCCfgTimeStamp OBJECT-TYPE
SYNTAX TimeStamp
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object contains the time stamp of
state transition of xgcpMGCCfgConnStatus.
"
::= { xgcpDefaultMGCObjects 4 }
-- *****************************************************************
-- The XGCP Package Group
-- *****************************************************************
-- *****************************************************************
-- The XGCP Capability Package table
-- *****************************************************************
xgcpCapabilityPackageTable OBJECT-TYPE
SYNTAX SEQUENCE OF XgcpCapabilityPackageEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This table contains XGCP capability packages.
The Capability Package table - This table is
used to specify the availability of the packages.
The Capabality Package Name is used as the
index for the table.
Each entry contains a CapabilityPackageEnable
object. It is used to enable/disable a package
on the Media Gateway.
"
::= { xgcpPackageObjects 1 }
xgcpCapabilityPackageEntry OBJECT-TYPE
SYNTAX XgcpCapabilityPackageEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The entry specifies the availability of the XGCP
package.
Each entry is created when the MGCP software
detects a new package. The entry goes away
only if the package is removed.
"
INDEX { IMPLIED xgcpCapabilityPackageName }
::= { xgcpCapabilityPackageTable 1 }
XgcpCapabilityPackageEntry ::= SEQUENCE {
xgcpCapabilityPackageName DisplayString (SIZE (1..64)),
xgcpCapabilityPackageEnable TruthValue
}
xgcpCapabilityPackageName OBJECT-TYPE
SYNTAX DisplayString (SIZE (1..64))
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
" This object specifies the Name of the
Capability Package.
The list of basic packages includes the following:
_________________________________________
| Package | name |
|______________________________|_________|
| Generic Media Package | G |
| DTMF package | D |
| MF Package | M |
| Trunk Package | T |
| Line Package | L |
| Handset Package | H |
| RTP Package | R |
| Netwark Access Server Package| N |
| Announcement Server Package | A |
| Script Package | S |
|______________________________|_________|
"
REFERENCE
" Media Gateway Control Protocol (MGCP),
version 0.1 draft, Feb 1, 1999 : Section 6.1
"
::= { xgcpCapabilityPackageEntry 1 }
xgcpCapabilityPackageEnable OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-write
STATUS current
DESCRIPTION
" This object eables/disables the Package Capability
"
DEFVAL { true }
::= { xgcpCapabilityPackageEntry 2 }
xgcpDefaultPackage OBJECT-TYPE
SYNTAX DisplayString (SIZE (1..64))
MAX-ACCESS read-write
STATUS current
DESCRIPTION
" This object contains the default package name for
the MGCP/SGCP protocol and it should have the
same value as xgcpCapabilityPackageName.
"
REFERENCE
" Media Gateway Control Protocol (MGCP),
version 0.1 draft, Feb 1, 1998 : Section 2.1.6
"
::= { xgcpPackageObjects 2 }
-- *****************************************************************
-- The XGCP Voice Quality Group
-- *****************************************************************
xgcpLowerBoundForPacketLoss OBJECT-TYPE
SYNTAX Integer32 (1..3000)
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"This object specifies the lower bound for voice
quality packet loss per 100,000 packets. Voice quality
packet loss may happen due to network congestion or due
to network overload.
When packet loss(number of packet per 100,000) is high
enough to reach lower bound(e.g. 1500) and then higher
bound(e.g. 2500) the first time, a MGCP/SGCP Notify
message is sent to the Media Gateway Controller.
Subsequent hits of the higher bound results in a
MGCP/SGCP Notify message being sent to the Media Gateway
Controller only after the lower bound is hit.
| Ntfy
| Ntfy Ntfy | Ntfy
| | | v |
| v v * * v
+ * * * * * * * * <--- higher bound
| * * * * * * * * *
+ * * * * * <---- lower bound
| * *
| * *
|*
+------------------------------------
The default value of this object is 1000.
"
::= { xgcpVoiceQualityObjects 1 }
xgcpHigherBoundForPacketLoss OBJECT-TYPE
SYNTAX Integer32 (5000..25000)
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"This object specifies the higher bound for voice quality
packet loss per 100,000 packets. Voice quality packet loss
may happen due to network congestion or due to network
overload.
The default value of this object is 10,000.
"
::= { xgcpVoiceQualityObjects 2 }
xgcpLowerBoundForJitter OBJECT-TYPE
SYNTAX Integer32 (4..60)
UNITS "milliseconds"
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"This object is the lower bound for Quality Alert for
Jitter.
Jitter is an estimate of the statistical variance of the RTP
data packet interval-rival time measured in milliseconds and
expressed as an unsigned integer.
When jitter(milliseconds) is long enough to reach lower
bound(e.g.30 ) and then higher bound(e.g. 150) the first
time, a MGCP/SGCP Notify message is sent to the Media
Gateway Controller.
Subsequent hits of the higher bound results in a
MGCP/SGCP Notify message being sent to the Media Gateway
Controller only after the lower bound is hit.
The default value of this object is 30.
"
::= { xgcpVoiceQualityObjects 3 }
xgcpHigherBoundForJitter OBJECT-TYPE
SYNTAX Integer32 (100..200)
UNITS "milliseconds"
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"This object is the higher bound for Quality Alert for
Jitter.
Jitter is an estimate of the statistical variance of the RTP
data packet interval-rival time measured in milliseconds and
expressed as an unsigned integer.
The default value of this object is 150.
"
::= { xgcpVoiceQualityObjects 4 }
xgcpLowerBoundForLatency OBJECT-TYPE
SYNTAX Integer32 (125..200)
UNITS "milliseconds"
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"This object is the higher bound for Quality Alert for
latency.
QA latency is an estimate of the network delay, expressed
in milliseconds. This is the average value of the difference
between the Network Time Protocol (NTP) timestamp indicated
by the senders of the RTCP messages and the NTP timestamp
of the receivers, measured when these messages are received.
When latency (milliseconds) is long enough to reach lower
bound (e.g.150 ) and then higher bound(e.g. 300) the first
time, a MGCP/SGCP Notify message is sent to the Media
Gateway Controller.
Subsequent hits of the higher bound results in a
MGCP/SGCP Notify message being sent to the Media Gateway
Controller only after the lower bound is hit.
The default value of this object is 150.
"
::= { xgcpVoiceQualityObjects 5 }
xgcpHigherBoundForLatency OBJECT-TYPE
SYNTAX Integer32 (250..400)
UNITS "milliseconds"
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"This object is the higher bound for Quality Alert for
latency.
QA latency is an estimate of the network delay, expressed
in milliseconds. This is the average value of the difference
between the NTP timestamp indicated by the senders of the
RTCP messages and the NTP timestamp of the receivers,
measured when these messages are received.
The default value of this object is 300.
"
::= { xgcpVoiceQualityObjects 6 }
-- *********************************************************************
-- Media gateway control notification
-- *********************************************************************
xgcpNotificationPrefix OBJECT IDENTIFIER ::= { xgcpMIB 2 }
xgcpNotifications OBJECT IDENTIFIER ::= { xgcpNotificationPrefix 0 }
xgcpUpDownNotification NOTIFICATION-TYPE
OBJECTS {
xgcpOperStatus
}
STATUS current
DESCRIPTION
"This notification is sent when the protocol status changes
between up and down.
The following information is returned:
xgcpOperStatus -> Current operational status of XGCP
"
::= { xgcpNotifications 1 }
--**********************************************************************
-- Conformance
--**********************************************************************
--
-- conformance information
--
xgcpMIBConformance OBJECT IDENTIFIER ::= { xgcpMIB 3 }
xgcpMIBCompliances OBJECT IDENTIFIER ::= { xgcpMIBConformance 1 }
xgcpMIBGroups OBJECT IDENTIFIER ::= { xgcpMIBConformance 2 }
--
-- Conformance and compliance statements statements
--
xgcpMIBCompliance MODULE-COMPLIANCE
STATUS current
DESCRIPTION
"The compliance statement for the SNMPv2 entities
which implement XGCP."
MODULE -- this module
MANDATORY-GROUPS { xgcpCoreGroup
}
GROUP xgcpExtensionGroup
DESCRIPTION
"The xgcp Extension Group is mandatory for MGCP
on the Media Gateway.
"
GROUP xgcpPackageGroup
DESCRIPTION
"The xgcp Package Group is mandatory for MGCP on
the Media Gateway Controller and the Media
Gateway.
"
GROUP xgcpVoiceQualityGroup
DESCRIPTION
"The xgcp Voice Quality Group is mandatory for MGCP on
the Media Gateway.
"
GROUP xgcpDefaultMGCGroup
DESCRIPTION
"The xgcp default MGC Group is mandatory for MGCP on
the Media Gateway.
"
::= { xgcpMIBCompliances 1 }
--
-- units of conformance
--
-- MIB Groups
--
xgcpCoreGroup OBJECT-GROUP
OBJECTS {
xgcpInBadVersions,
xgcpRequestTimeOut,
xgcpRequestRetries,
xgcpAdminStatus,
xgcpOperStatus,
xgcpUnRecognizedPackets,
xgcpSuccessMessages,
xgcpFailMessages
}
STATUS current
DESCRIPTION
"This group contains core objects for SGCP/MGCP on the
Media Gateway Controller and the Media Gateway.
"
::= { xgcpMIBGroups 1 }
xgcpExtensionGroup OBJECT-GROUP
OBJECTS {
xgcpRestartInProgressMWD,
xgcpRestartDelay
}
STATUS current
DESCRIPTION
"This group contains extension objects for MGCP on
the Media Gateway.
"
::= { xgcpMIBGroups 2 }
xgcpPackageGroup OBJECT-GROUP
OBJECTS {
xgcpCapabilityPackageEnable,
xgcpDefaultPackage
}
STATUS current
DESCRIPTION
"This group contains package objects for MGCP on
the Media Gateway or the Media Gateway Controller.
"
::= { xgcpMIBGroups 3 }
xgcpVoiceQualityGroup OBJECT-GROUP
OBJECTS {
xgcpLowerBoundForPacketLoss,
xgcpHigherBoundForPacketLoss,
xgcpLowerBoundForJitter,
xgcpHigherBoundForJitter,
xgcpLowerBoundForLatency,
xgcpHigherBoundForLatency
}
STATUS current
DESCRIPTION
"This group contains voice quality objects for
the Media Gateway ."
::= { xgcpMIBGroups 4 }
xgcpDefaultMGCGroup OBJECT-GROUP
OBJECTS {
xgcpMGCCfgAddress,
xgcpMGCCfgUDPPort,
xgcpMGCCfgConnStatus,
xgcpMGCCfgTimeStamp
}
STATUS current
DESCRIPTION
"This group contains address objects for default
Media Gateway Controller.
"
::= { xgcpMIBGroups 5 }
END
Reference in New Issue View Git Blame Copy Permalink