CISCO-SIP-CALLS-MIB

File: CISCO-SIP-CALLS-MIB.mib (37304 bytes)

Imported modules

SNMPv2-SMI SNMP-FRAMEWORK-MIB SNMPv2-CONF
SNMPv2-TC CISCO-SMI DIAL-CONTROL-MIB
CISCO-VOICE-COMMON-DIAL-CONTROL-MIB INET-ADDRESS-MIB

Imported symbols

MODULE-IDENTITY OBJECT-TYPE Integer32
Unsigned32 Gauge32 SnmpAdminString
MODULE-COMPLIANCE OBJECT-GROUP TEXTUAL-CONVENTION
ciscoMgmt callActiveSetupTime callActiveIndex
CvcCoderTypeRate InetAddressType InetAddress
InetPortNumber

Defined Types

CSipCallState  
A textual convention containing the list of call states a SIP call undergoes. The list of call states and their descriptions are given below : 'none' - None of the following. 'idle' - SIP communication has not been initiated. 'setupBuffered' - A setup indication has been received from the application, but it has been buffered. The INVITE will be sent at a later time. 'sentInvite' - A SIP INVITE request has been sent and no response has been received. 'rcvdProceeding' - A non-final response (1xx) has been received in response to an INVITE request. 'outgoingResrResv' - A PRACK has been sent after receiving a 183 and QoS resource reservation has been initiated. 'outgoingResrAllocated' - QoS reservations have completed and an UPDATE has been sent. 'active' - A 2xx (Success) response has been received for an INVITE message and the call is now active. 'rcvdTransfer' - A SIP REFER request was received for an active call. 'disconnecting' - A SIP BYE or CANCEL request has been sent and no response has been received. 'dead' - The call has been cleared in normal or abnormal fashion. 'rcvdInvite' - A SIP INVITE request has been received for an incoming SIP call. 'sentQosProgress' - An INVITE with QoS precondition has been received. A 183 Session Progress response has been sent in response. 'incomingResrResv' - A 200 (OK) for a PRACK has been sent out and QoS resource reservation has been initiated. 'sentAlerting' - A SIP 180 (Ringing) response has been sent. 'sentSuccess' - A SIP 2xx response has been sent. 'midCallLocalRespPending' - A SIP mid-call INVITE was received and the response has not been sent yet. 'sendMidCallInvitePending' - A SIP call is active and a mid-call INVITE needs to be sent. 'sentMidCallInvite' - A SIP mid-call INVITE has been sent. 'rcvdSubscribe' - A SIP SUBSCRIBE request was received. 'subscribeSuccess' - A response for the SUBSCRIBE request was received. 'subscribeExpired' - The SUBSCRIBE request for a particular event has expired. 'sentPreAuthRequest' - A SIP INVITE was received and a preauthorization request has been sent. 'sendNotify' - A NOTIFY message for an event earlier subscribed was sent. 'subscribeIdle' - This state is the initialization state for SUBSCRIBE/NOTIFY messages. 'sentSubscribe' - A SIP SUBSCRIBE request has been sent. 'subscribed' - The user agent has been subscribed with the messaging system. 'initTransfer' - A SIP REFER request was received and the call was placed on hold in preparation for the transfer. 'outgoingRegister' - A SIP REGISTER message has been sent. 'incomingRegister' - A SIP REGISTER message has been received. 'rcvdUnsolicitedNotify' - A Cisco-proprietary unsolicited NOTIFY message was received.
TEXTUAL-CONVENTION    
  INTEGER none(1), idle(2), setupBuffered(3), sentInvite(4), rcvdProceeding(5), outgoingResrResv(6), outgoingResrAllocated(7), active(8), rcvdTransfer(9), disconnecting(10), dead(11), rcvdInvite(12), sentQosProgress(13), incomingResrResv(14), sentAlerting(15), sentSuccess(16), midCallLocalRespPending(17), sendMidCallInvitePending(18), sentMidCallInvite(19), rcvdSubscribe(20), subscribeSuccess(21), subscribeExpired(22), sentPreAuthRequest(23), sendNotify(24), subscribeIdle(25), sentSubscribe(26), subscribed(27), initTransfer(28), outgoingRegister(29), incomingRegister(30), rcvdUnsolicitedNotify(31)  

CSipCallSubstate  
A textual convention containing the list of call substates a SIP call undergoes. The list of substates and their descriptions are given below: 'none' - None of the following. 'sentDns' - A DNS request has been sent to the DNS server. 'proceedingProceeding' - A non-final 1xx response was received, while in rcvdProceeding state. 'rcvdInviteCallSetup' - A SIP INVITE has been received and the call is being set up. 'rcvdInviteProceeding' - A 100 (Trying) response was received for a INVITE request. 'sentEnum' - An ENUM query is in progress. 'ackPending' - An acknowledgement pending for any message sent. 'sentNotify' - A NOTIFY message for any subscribed event was sent. 'callTransferSendByeAlso' - A BYE request was sent with an 'Also' header.
TEXTUAL-CONVENTION    
  INTEGER none(1), sentDns(2), proceedingProceeding(3), rcvdInviteCallSetup(4), rcvdInviteProceeding(5), sentEnum(6), ackPending(7), sentNotify(8), callTransferSendByeAlso(9)  

CSipCallActiveEntry  
SEQUENCE    
  cSipCallActiveId SnmpAdminString
  cSipCallActiveType INTEGER
  cSipCallActiveState CSipCallState
  cSipCallActiveSubstate CSipCallSubstate
  cSipCallActiveCallingNumber SnmpAdminString
  cSipCallActiveCalledNumber SnmpAdminString
  cSipCallActiveSigSrcIpAddrType InetAddressType
  cSipCallActiveSigSrcIpAddr InetAddress
  cSipCallActiveDestReqIpAddrType InetAddressType
  cSipCallActiveDestReqIpAddr InetAddress
  cSipCallActiveDestReqPort InetPortNumber
  cSipCallActiveDestResIpAddrType InetAddressType
  cSipCallActiveDestResIpAddr InetAddress
  cSipCallActiveDestResPort InetPortNumber
  cSipCallActiveDestIpAddrType InetAddressType
  cSipCallActiveDestIpAddr InetAddress
  cSipCallActiveMediaStreams Unsigned32
  cSipCallActiveMediaStreamsActive Unsigned32

CSipMediaStreamsEntry  
SEQUENCE    
  cSipMediaStreamIndex Unsigned32
  cSipMediaStreamState INTEGER
  cSipMediaStreamCallId Integer32
  cSipMediaStreamType INTEGER
  cSipMediaStreamNegotdCodec CvcCoderTypeRate
  cSipMediaStreamCodecPayloadType Integer32
  cSipMediaStreamNegotdDtmfRelay INTEGER
  cSipMediaStreamDtmfPayloadType Integer32
  cSipMediaStreamSrcIpAddrType InetAddressType
  cSipMediaStreamSrcIpAddr InetAddress
  cSipMediaStreamSrcPort InetPortNumber
  cSipMediaStreamDestIpAddrType InetAddressType
  cSipMediaStreamDestIpAddr InetAddress
  cSipMediaStreamDestPort InetPortNumber

Defined Values

ciscoSipCallsMIB 1.3.6.1.4.1.9.9.995
The Cisco Session Initiation Protocol (SIP) Calls MIB module is designed to provide protocol-specific information on SIP calls which are currently active. SIP is an application-layer signalling protocol for creating, modifying and terminating multimedia sessions with one or more participants. SIP is defined in RFC 3261 (June 2002). The endpoints in a SIP communication are called user agents. A user agent is an application which contains both a User Agent Client (UAC) and a User Agent Server (UAS). A UAC is an application that initiates a SIP request. A UAS is an application that contacts the user when a SIP request is received and that returns a response on behalf of the user. This MIB module provides information on SIP calls and the user agents initiating these calls. Also, it provides a way to manage media forking of SIP calls.
MODULE-IDENTITY    

ciscoSipCallsMIBNotifs 1.3.6.1.4.1.9.9.995.0
OBJECT IDENTIFIER    

ciscoSipCallsMIBObjects 1.3.6.1.4.1.9.9.995.1
OBJECT IDENTIFIER    

cSipCallActive 1.3.6.1.4.1.9.9.995.1.1
OBJECT IDENTIFIER    

cSipCallsMIBConformance 1.3.6.1.4.1.9.9.995.1.2
OBJECT IDENTIFIER    

cSipUACActiveCalls 1.3.6.1.4.1.9.9.995.1.1.1
This object reflects the number of UAC calls currently active. UAC calls are those calls which are initiated by this system's SIP user agent on behalf of users acting as the calling party.
Status: current Access: read-only
OBJECT-TYPE    
  Gauge32  

cSipUASActiveCalls 1.3.6.1.4.1.9.9.995.1.1.2
This object reflects the number of UAS calls currently active. UAS calls are those calls which are received by this system's SIP user agent on behalf of users acting as the called party.
Status: current Access: read-only
OBJECT-TYPE    
  Gauge32  

cSipCallActiveTable 1.3.6.1.4.1.9.9.995.1.1.3
This table is the SIP extension to cvVoIPCallActiveTable of CISCO-VOICE-DIAL-CONTROL-MIB. It represents UAC and UAS information on active SIP calls.
Status: current Access: not-accessible
OBJECT-TYPE    
  SEQUENCE OF  
    CSipCallActiveEntry

cSipCallActiveEntry 1.3.6.1.4.1.9.9.995.1.1.3.1
An entry contains information regarding a single active SIP Call. The active call entry is identified by using the same index objects that are used by callActiveTable of IETF DIAL-CONTROL-MIB to identify the call.
Status: current Access: not-accessible
OBJECT-TYPE    
  CSipCallActiveEntry  

cSipCallActiveId 1.3.6.1.4.1.9.9.995.1.1.3.1.1
This object represents the protocol specific unique identifier for this call.
Status: current Access: read-only
OBJECT-TYPE    
  SnmpAdminString  

cSipCallActiveType 1.3.6.1.4.1.9.9.995.1.1.3.1.2
This object denotes whether the call is a UAC or a UAS one. 'uac' - User Agent Client 'uas' - User Agent Server.
Status: current Access: read-only
OBJECT-TYPE    
  INTEGER uac(1), uas(2)  

cSipCallActiveState 1.3.6.1.4.1.9.9.995.1.1.3.1.3
This object reflects the current state of the call.
Status: current Access: read-only
OBJECT-TYPE    
  CSipCallState  

cSipCallActiveSubstate 1.3.6.1.4.1.9.9.995.1.1.3.1.4
This object reflects the current substate of the call.
Status: current Access: read-only
OBJECT-TYPE    
  CSipCallSubstate  

cSipCallActiveCallingNumber 1.3.6.1.4.1.9.9.995.1.1.3.1.5
Indicates the calling number.
Status: current Access: read-only
OBJECT-TYPE    
  SnmpAdminString Size(0..64)  

cSipCallActiveCalledNumber 1.3.6.1.4.1.9.9.995.1.1.3.1.6
Indicates the called Number.
Status: current Access: read-only
OBJECT-TYPE    
  SnmpAdminString Size(0..64)  

cSipCallActiveSigSrcIpAddrType 1.3.6.1.4.1.9.9.995.1.1.3.1.7
Internet type of the signaling source IP address.
Status: current Access: read-only
OBJECT-TYPE    
  InetAddressType  

cSipCallActiveSigSrcIpAddr 1.3.6.1.4.1.9.9.995.1.1.3.1.8
This object reflects the signaling source IP address. Its value should be interpreted within the context of the associated cSipCallActiveSigSrcIpAddrType object.
Status: current Access: read-only
OBJECT-TYPE    
  InetAddress  

cSipCallActiveDestReqIpAddrType 1.3.6.1.4.1.9.9.995.1.1.3.1.9
Internet type of the signaling destination request IP address.
Status: current Access: read-only
OBJECT-TYPE    
  InetAddressType  

cSipCallActiveDestReqIpAddr 1.3.6.1.4.1.9.9.995.1.1.3.1.10
This object reflects the signaling destination request IP address. Its value should be interpreted within the context of the associated cSipCallActiveDestReqIpAddrType object.
Status: current Access: read-only
OBJECT-TYPE    
  InetAddress  

cSipCallActiveDestReqPort 1.3.6.1.4.1.9.9.995.1.1.3.1.11
This object reflects the signaling destination request port number.
Status: current Access: read-only
OBJECT-TYPE    
  InetPortNumber  

cSipCallActiveDestResIpAddrType 1.3.6.1.4.1.9.9.995.1.1.3.1.12
Internet type of the signaling destination response IP address.
Status: current Access: read-only
OBJECT-TYPE    
  InetAddressType  

cSipCallActiveDestResIpAddr 1.3.6.1.4.1.9.9.995.1.1.3.1.13
This object reflects the signaling destination response IP address. Its value should be interpreted within the context of the associated cSipCallActiveDestResIpAddrType object.
Status: current Access: read-only
OBJECT-TYPE    
  InetAddress  

cSipCallActiveDestResPort 1.3.6.1.4.1.9.9.995.1.1.3.1.14
This object reflects the signaling destination response port number.
Status: current Access: read-only
OBJECT-TYPE    
  InetPortNumber  

cSipCallActiveDestIpAddrType 1.3.6.1.4.1.9.9.995.1.1.3.1.15
Internet type of the signaling destination IP address.
Status: current Access: read-only
OBJECT-TYPE    
  InetAddressType  

cSipCallActiveDestIpAddr 1.3.6.1.4.1.9.9.995.1.1.3.1.16
This object reflects the signaling destination IP address. It may be either a DNS hostname or an IP address. Its value should be interpreted within the context of the associated cSipCallActiveDestIpAddrType object.
Status: current Access: read-only
OBJECT-TYPE    
  InetAddress  

cSipCallActiveMediaStreams 1.3.6.1.4.1.9.9.995.1.1.3.1.17
If the call is a media-forked one, this object reflects the number of media streams.
Status: current Access: read-only
OBJECT-TYPE    
  Unsigned32  

cSipCallActiveMediaStreamsActive 1.3.6.1.4.1.9.9.995.1.1.3.1.18
If the call is a media-forked one, this object reflects the number of media streams currently active.
Status: current Access: read-only
OBJECT-TYPE    
  Unsigned32  

cSipMediaStreamsTable 1.3.6.1.4.1.9.9.995.1.1.4
This table contains objects relating to the media streams that get forked in a SIP call. It includes information about each media stream, if it is a media-forked call.
Status: current Access: not-accessible
OBJECT-TYPE    
  SEQUENCE OF  
    CSipMediaStreamsEntry

cSipMediaStreamsEntry 1.3.6.1.4.1.9.9.995.1.1.4.1
Each entry in this table, represents information regarding a media stream associated with a SIP call. Conceptually it is a nested table within a call entry in the cSipCallActiveTable.
Status: current Access: not-accessible
OBJECT-TYPE    
  CSipMediaStreamsEntry  

cSipMediaStreamIndex 1.3.6.1.4.1.9.9.995.1.1.4.1.1
The unique media stream identifier for a single call.
Status: current Access: not-accessible
OBJECT-TYPE    
  Unsigned32  

cSipMediaStreamState 1.3.6.1.4.1.9.9.995.1.1.4.1.2
The current state of the media stream. 'invalidStreamState' - None of the following. 'idle' - Initialization state. The stream is yet to be forked. 'adding' - The stream is getting forked. 'deleting' - The stream is being deleted from the call. 'changing' - The stream is in the process of changing its state. 'active' - The stream is now active and communication is on. 'dead' - The stream has been cleared.
Status: current Access: read-only
OBJECT-TYPE    
  INTEGER invalidStreamState(1), idle(2), adding(3), deleting(4), changing(5), active(6), dead(7)  

cSipMediaStreamCallId 1.3.6.1.4.1.9.9.995.1.1.4.1.3
This object represents the stream call identifier indicated by the media stream header. A value of -1 indicates that the stream is in DEAD state.
Status: current Access: read-only
OBJECT-TYPE    
  Integer32 -1..2147483647  

cSipMediaStreamType 1.3.6.1.4.1.9.9.995.1.1.4.1.4
This object identifies the type of the Media Stream. 'voiceOnly' - Voice-only media streams send all audio from the DS0 channel. 'dtmfRelay' - Dual Tone Multi Frequency Tones. 'voiceAndDtmfRelay' - Send both encoded voice and DTMF-relay packets.
Status: current Access: read-only
OBJECT-TYPE    
  INTEGER voiceOnly(1), dtmfRelay(2), voiceAndDtmfRelay(3)  

cSipMediaStreamNegotdCodec 1.3.6.1.4.1.9.9.995.1.1.4.1.5
This object reflects the codec selected for the media stream.
Status: current Access: read-only
OBJECT-TYPE    
  CvcCoderTypeRate  

cSipMediaStreamCodecPayloadType 1.3.6.1.4.1.9.9.995.1.1.4.1.6
The RTP payload type of the media stream. RTP payload specifies the data transported by RTP in a packet, for example audio samples or compressed video data. A value of -1 means that no codec has been negotiated. RFC 3551 specifies the payload type number to be used with different codecs. The following are some of the standard payload types applicable to SIP calls : PT Encoding Name 0 PCMU(G711ulaw) 3 GSM 4 G723 8 PCMA(G711alaw) 9 G722 15 G728 18 G729 96--127 dynamic For other codecs, dynamic payload types in the range 96--127 are negotiated during call setup. Also note that Cisco has preassigned certain payload types in this dynamic range for certain encodings: PT Function 96 fax 97 fax-ack 100 NSE 101 NTE 121 DTMF-relay 122 Fax-relay 123 CAS 125 ClearChan
Status: current Access: read-only
OBJECT-TYPE    
  Integer32 -1..127  

cSipMediaStreamNegotdDtmfRelay 1.3.6.1.4.1.9.9.995.1.1.4.1.7
This object reflects the DTMF-relay selected for the media stream indicated by the media stream header. 'inBandVoice' - DTMF digits are sent as in-band audio. 'rtpNte' - RTP Named Telephony Event. RTP-NTE is described in RFC 2833.
Status: current Access: read-only
OBJECT-TYPE    
  INTEGER inBandVoice(1), rtpNte(2)  

cSipMediaStreamDtmfPayloadType 1.3.6.1.4.1.9.9.995.1.1.4.1.8
The RTP payload type of the negotiated DTMF-relay. RTP payload specifies the data transported by RTP in a packet, for example audio samples or compressed video data. A value of -1 means that no codec has been negotiated. RFC 3551 specifies the payload type number to be used with different codecs. The following are some of the standard payload types applicable to SIP calls : PT Encoding Name 0 PCMU(G711ulaw) 3 GSM 4 G723 8 PCMA(G711alaw) 9 G722 15 G728 18 G729 96--127 dynamic For other codecs, dynamic payload types in the range 96--127 are negotiated during call setup. Also note that Cisco has preassigned certain payload types in this dynamic range for certain encodings: PT Function 96 fax 97 fax-ack 100 NSE 101 NTE 121 DTMF-relay 122 Fax-relay 123 CAS 125 ClearChan
Status: current Access: read-only
OBJECT-TYPE    
  Integer32 -1..127  

cSipMediaStreamSrcIpAddrType 1.3.6.1.4.1.9.9.995.1.1.4.1.9
Internet type of the media stream source IP address.
Status: current Access: read-only
OBJECT-TYPE    
  InetAddressType  

cSipMediaStreamSrcIpAddr 1.3.6.1.4.1.9.9.995.1.1.4.1.10
This object reflects the source IP address of the media stream. Its value should be interpreted within the context of the associated cSipMediaStreamSrcIpAddrType object.
Status: current Access: read-only
OBJECT-TYPE    
  InetAddress  

cSipMediaStreamSrcPort 1.3.6.1.4.1.9.9.995.1.1.4.1.11
This object reflects the UDP port of the media stream source.
Status: current Access: read-only
OBJECT-TYPE    
  InetPortNumber  

cSipMediaStreamDestIpAddrType 1.3.6.1.4.1.9.9.995.1.1.4.1.12
Internet type of the media stream destination IP address.
Status: current Access: read-only
OBJECT-TYPE    
  InetAddressType  

cSipMediaStreamDestIpAddr 1.3.6.1.4.1.9.9.995.1.1.4.1.13
This object reflects the destination IP address of the media stream. Its value should be interpreted within the context of the associated cSipMediaStreamDestIpAddrType object.
Status: current Access: read-only
OBJECT-TYPE    
  InetAddress  

cSipMediaStreamDestPort 1.3.6.1.4.1.9.9.995.1.1.4.1.14
This object reflects the UDP port of the media stream destination.
Status: current Access: read-only
OBJECT-TYPE    
  InetPortNumber  

cSipCallsMIBCompliances 1.3.6.1.4.1.9.9.995.1.2.1
OBJECT IDENTIFIER    

cSipCallsMIBGroups 1.3.6.1.4.1.9.9.995.1.2.2
OBJECT IDENTIFIER    

cSipCallsMIBCompliance 1.3.6.1.4.1.9.9.995.1.2.1.1
The compliance statement for entities which implement the CISCO-SIP-CALLS-MIB
Status: current Access: read-only
MODULE-COMPLIANCE    

cSipCallActiveGroup 1.3.6.1.4.1.9.9.995.1.2.2.1
A collection of objects providing the active SIP calls capability.
Status: current Access: read-only
OBJECT-GROUP    

cSipMediaStreamGroup 1.3.6.1.4.1.9.9.995.1.2.2.2
A collection of objects providing the media stream information capability.
Status: current Access: read-only
OBJECT-GROUP