{ "openapi": "3.0.0", "info": { "title": "CISCO-DIAL-CONTROL-MIB MIB API", "version": "1.0.0", "description": "The MIB module to describe call history information for\n demand access and possibly other kinds of interfaces.\n\nāš ļø **IMPORTANT - MIB DATA ACCESS**:\nThis YANG model exists for SMIv2-to-YANG translation purposes, but MIB data on IOS-XE devices is primarily accessed via **SNMP protocol**, not RESTCONF.\n\n**RESTCONF Limitation**: Many MIB paths may return 404 errors via RESTCONF `/data` endpoints because the device exposes MIB data through SNMP, not the YANG datastore.\n\n**Recommended Access Methods**:\n- Use SNMP (v2c/v3) to query MIB data directly\n- Use NETCONF `` operations for devices supporting YANG-modeled MIB access\n- Check device capabilities: some newer IOS-XE versions may support limited RESTCONF access to specific MIBs\n\n**YANG Model Purpose**: These YANG models define the structure of SNMP MIBs in YANG format for tooling compatibility, but do not guarantee RESTCONF data availability.\n\n\n**šŸ“Š YANG Tree:** [View CISCO-DIAL-CONTROL-MIB structure](https://jeremycohoe.github.io/cisco-ios-xe-openapi-swagger/yang-trees/CISCO-DIAL-CONTROL-MIB.html)", "contact": { "name": "Cisco DevNet", "url": "https://developer.cisco.com" }, "x-yang-module": "CISCO-DIAL-CONTROL-MIB", "x-model-type": "mib" }, "servers": [ { "url": "https://{device}/restconf", "description": "RESTCONF server", "variables": { "device": { "default": "10.1.1.1", "description": "Device hostname or IP address" } } } ], "paths": { "/data/CISCO-DIAL-CONTROL-MIB:cPeerGlobalConfiguration": { "get": { "summary": "Get cPeerGlobalConfiguration data", "description": "Retrieve cPeerGlobalConfiguration operational data from MIB", "tags": [ "CISCO-DIAL-CONTROL-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "cPeerGlobalConfiguration", "properties": { "cPeerSearchType": { "type": "string", "description": "Specifies the peer search preference based on the\n type of peers in an universal/integrated port\n platform.\n \n none - both voice and data peers are searched\n in same preference.\n datavoice - search data peers first. If no data peers\n are found, the voice peers are searched.\n voicedata - search voice peers first. If no voice peers\n are found, the data peers are searched." } } }, "example": { "CISCO-DIAL-CONTROL-MIB:cPeerGlobalConfiguration": { "cPeerSearchType": "ethernetCsmacd(6)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cPeerGlobalConfiguration", "parameters": [ { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ] }, "x-yang-path": "/cPeerGlobalConfiguration", "x-restconf-kind": "container" }, "/data/CISCO-DIAL-CONTROL-MIB:cCallHistoryTable": { "get": { "summary": "Get cCallHistoryTable data", "description": "Retrieve cCallHistoryTable operational data from MIB", "tags": [ "CISCO-DIAL-CONTROL-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "A table containing information about specific\n calls to a specific destination.", "properties": { "cCallHistoryEntry": { "type": "array", "description": "The information regarding a single Connection.", "items": { "type": "object", "properties": { "cCallHistoryIndex": { "type": "integer", "description": "A monotonically increasing integer for the sole purpose of\n indexing call disconnection events. When it reaches the \n maximum value, an extremely unlikely event, the agent wraps \n the value back to 1 and may flush existing entries.", "minimum": 0, "maximum": 4294967295 }, "cCallHistorySetupTime": { "type": "string", "description": "The value of sysUpTime when the call setup was started.\n This will be useful for an NMS to sort the call history\n entry with call setup time. Also, this object\n can be useful in finding large delays between the time the\n call was started and the time the call was connected.\n For ISDN media, this will be the time when the setup\n message was received from or sent to the network.\n The value of this object is the same as callActiveSetupTime\n in the callActiveTable", "x-yang-type": "yang:timestamp" }, "cCallHistoryPeerAddress": { "type": "string", "description": "The number this call was connected to. If the number is\n not available, then it will have a length of zero.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cCallHistoryPeerSubAddress": { "type": "string", "description": "The subaddress this call was connected to. If the subaddress\n is undefined or not available, this will be a zero length\n string.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cCallHistoryPeerId": { "type": "integer", "description": "This is the Id value of the peer table entry\n to which this call was made. If a peer table entry\n for this call does not exist, the value of this object\n will be zero.", "minimum": -2147483648, "maximum": 2147483647 }, "cCallHistoryPeerIfIndex": { "type": "integer", "description": "This is the ifIndex value of the peer table entry\n to which this call was made. If a peer table entry\n for this call does not exist, the value of this object\n will be zero.", "minimum": -2147483648, "maximum": 2147483647 }, "cCallHistoryLogicalIfIndex": { "type": "string", "description": "This is the ifIndex value of the logical interface through\n which this call was made. For ISDN media, this would be\n the ifIndex of the B channel which was used for this call.\n If the ifIndex value is unknown, the value of this object \n will be zero. For an IP call, the value will be zero.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "cCallHistoryDisconnectCause": { "type": "string", "description": "The encoded network cause value associated with this call.\n \n The value of this object will depend on the interface type\n as well as on the protocol and protocol version being\n used on this interface. Some references for possible cause\n values are given below.", "format": "binary" }, "cCallHistoryDisconnectText": { "type": "string", "description": "ASCII text describing the reason for call termination.\n \n This object exists because it would be impossible for\n a management station to store all possible cause values\n for all types of interfaces. It should be used only if\n a management station is unable to decode the value of\n dialCtlPeerStatsLastDisconnectCause.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cCallHistoryConnectTime": { "type": "string", "description": "The value of sysUpTime when the call was connected.", "x-yang-type": "yang:timestamp" }, "cCallHistoryDisconnectTime": { "type": "string", "description": "The value of sysUpTime when the call was disconnected.", "x-yang-type": "yang:timestamp" }, "cCallHistoryCallOrigin": { "type": "string", "description": "The call origin." }, "cCallHistoryChargedUnits": { "type": "string", "description": "The number of charged units for this connection.\n For incoming calls or if charging information is\n not supplied by the switch, the value of this object\n will be zero.", "x-yang-type": "dial-control:AbsoluteCounter32" }, "cCallHistoryInfoType": { "type": "string", "description": "The information type for this call." }, "cCallHistoryTransmitPackets": { "type": "string", "description": "The number of packets which were transmitted while this\n call was active.", "x-yang-type": "dial-control:AbsoluteCounter32" }, "cCallHistoryTransmitBytes": { "type": "string", "description": "The number of bytes which were transmitted while this\n call was active.", "x-yang-type": "dial-control:AbsoluteCounter32" }, "cCallHistoryReceivePackets": { "type": "string", "description": "The number of packets which were received while this\n call was active.", "x-yang-type": "dial-control:AbsoluteCounter32" }, "cCallHistoryReceiveBytes": { "type": "string", "description": "The number of bytes which were received while this\n call was active.", "x-yang-type": "dial-control:AbsoluteCounter32" }, "cCallHistoryReleaseSource": { "type": "string", "description": "Originator of the call release." }, "cCallHistoryReleaseSrc": { "type": "string", "description": "Originator of the call release. Indicates the source of \n the call release as follows : \n 1) callingPartyInPstn : Calling party in PSTN.\n 2) callingPartyInVoip : Calling party in VoIP.\n 3) calledPartyInPstn : Called party in PSTN.\n 4) calledPartyInVoip : Called party in VoIP.\n 5) internalReleaseInPotsLeg : Due to an internal error \n in Telephony call leg.\n 6) internalReleaseInVoipLeg : Due to an internal error\n in VoIP call leg.\n 7) internalCallControlApp : Due to an internal error\n in Session Application or Tcl or VXML script originated\n release. \n 8) internalReleaseInVoipAAA : Due to an internal error\n in VoIP AAA module.\n 9) consoleCommand : Due to CLI or MML.\n 10) externalRadiusServer : Call failed during authorization\n , authentication or due to receipt of POD from the \n RADIUS server.\n 11) externalNmsApp : Due to SNMP request to clear \n the call.\n 12) externalCallControlAgent : External Call Control Agent\n initiated clear.\n 13) gatekeeper : Gatekeeper initiated clear due to receipt\n of Admission Reject, Disengage Request message.\n 14) externalGKTMPServer : External GKTMP server initiated\n clear due to receipt of Admission Reject message from\n the gatekeeper, triggered by RESPONSE.ARJ message from\n the GKTMP server." } } } } } }, "example": { "CISCO-DIAL-CONTROL-MIB:cCallHistoryTable": { "cCallHistoryEntry": [ { "cCallHistoryIndex": 1, "cCallHistorySetupTime": "example-string", "cCallHistoryPeerAddress": "192.168.1.1", "cCallHistoryPeerSubAddress": "192.168.1.1", "cCallHistoryPeerId": -2147483648, "cCallHistoryPeerIfIndex": 1, "cCallHistoryLogicalIfIndex": "1", "cCallHistoryDisconnectCause": "example-string", "cCallHistoryDisconnectText": "example-string", "cCallHistoryConnectTime": "example-string", "cCallHistoryDisconnectTime": "example-string", "cCallHistoryCallOrigin": "example-string", "cCallHistoryChargedUnits": "example-string", "cCallHistoryInfoType": "ethernetCsmacd(6)", "cCallHistoryTransmitPackets": "example-string", "cCallHistoryTransmitBytes": "example-string", "cCallHistoryReceivePackets": "example-string", "cCallHistoryReceiveBytes": "example-string", "cCallHistoryReleaseSource": "example-string", "cCallHistoryReleaseSrc": "example-string" }, { "cCallHistoryIndex": 2, "cCallHistorySetupTime": "example-string", "cCallHistoryPeerAddress": "192.168.1.1", "cCallHistoryPeerSubAddress": "192.168.1.1", "cCallHistoryPeerId": -2147483648, "cCallHistoryPeerIfIndex": 2, "cCallHistoryLogicalIfIndex": "2", "cCallHistoryDisconnectCause": "example-string", "cCallHistoryDisconnectText": "example-string", "cCallHistoryConnectTime": "example-string", "cCallHistoryDisconnectTime": "example-string", "cCallHistoryCallOrigin": "example-string", "cCallHistoryChargedUnits": "example-string", "cCallHistoryInfoType": "ethernetCsmacd(6)", "cCallHistoryTransmitPackets": "example-string", "cCallHistoryTransmitBytes": "example-string", "cCallHistoryReceivePackets": "example-string", "cCallHistoryReceiveBytes": "example-string", "cCallHistoryReleaseSource": "example-string", "cCallHistoryReleaseSrc": "example-string" }, { "cCallHistoryIndex": 3, "cCallHistorySetupTime": "example-string", "cCallHistoryPeerAddress": "192.168.1.1", "cCallHistoryPeerSubAddress": "192.168.1.1", "cCallHistoryPeerId": -2147483648, "cCallHistoryPeerIfIndex": 3, "cCallHistoryLogicalIfIndex": "3", "cCallHistoryDisconnectCause": "example-string", "cCallHistoryDisconnectText": "example-string", "cCallHistoryConnectTime": "example-string", "cCallHistoryDisconnectTime": "example-string", "cCallHistoryCallOrigin": "example-string", "cCallHistoryChargedUnits": "example-string", "cCallHistoryInfoType": "ethernetCsmacd(6)", "cCallHistoryTransmitPackets": "example-string", "cCallHistoryTransmitBytes": "example-string", "cCallHistoryReceivePackets": "example-string", "cCallHistoryReceiveBytes": "example-string", "cCallHistoryReleaseSource": "example-string", "cCallHistoryReleaseSrc": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cCallHistoryTable", "parameters": [ { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ] }, "x-yang-path": "/cCallHistoryTable", "x-restconf-kind": "container" }, "/data/CISCO-DIAL-CONTROL-MIB:cCallHistoryTable/cCallHistoryEntry": { "get": { "summary": "Get cCallHistoryEntry list", "description": "Retrieve list of cCallHistoryEntry entries from MIB", "tags": [ "CISCO-DIAL-CONTROL-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "The information regarding a single Connection.", "items": { "type": "object", "properties": { "cCallHistoryIndex": { "type": "integer", "description": "A monotonically increasing integer for the sole purpose of\n indexing call disconnection events. When it reaches the \n maximum value, an extremely unlikely event, the agent wraps \n the value back to 1 and may flush existing entries.", "minimum": 0, "maximum": 4294967295 }, "cCallHistorySetupTime": { "type": "string", "description": "The value of sysUpTime when the call setup was started.\n This will be useful for an NMS to sort the call history\n entry with call setup time. Also, this object\n can be useful in finding large delays between the time the\n call was started and the time the call was connected.\n For ISDN media, this will be the time when the setup\n message was received from or sent to the network.\n The value of this object is the same as callActiveSetupTime\n in the callActiveTable", "x-yang-type": "yang:timestamp" }, "cCallHistoryPeerAddress": { "type": "string", "description": "The number this call was connected to. If the number is\n not available, then it will have a length of zero.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cCallHistoryPeerSubAddress": { "type": "string", "description": "The subaddress this call was connected to. If the subaddress\n is undefined or not available, this will be a zero length\n string.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cCallHistoryPeerId": { "type": "integer", "description": "This is the Id value of the peer table entry\n to which this call was made. If a peer table entry\n for this call does not exist, the value of this object\n will be zero.", "minimum": -2147483648, "maximum": 2147483647 }, "cCallHistoryPeerIfIndex": { "type": "integer", "description": "This is the ifIndex value of the peer table entry\n to which this call was made. If a peer table entry\n for this call does not exist, the value of this object\n will be zero.", "minimum": -2147483648, "maximum": 2147483647 }, "cCallHistoryLogicalIfIndex": { "type": "string", "description": "This is the ifIndex value of the logical interface through\n which this call was made. For ISDN media, this would be\n the ifIndex of the B channel which was used for this call.\n If the ifIndex value is unknown, the value of this object \n will be zero. For an IP call, the value will be zero.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "cCallHistoryDisconnectCause": { "type": "string", "description": "The encoded network cause value associated with this call.\n \n The value of this object will depend on the interface type\n as well as on the protocol and protocol version being\n used on this interface. Some references for possible cause\n values are given below.", "format": "binary" }, "cCallHistoryDisconnectText": { "type": "string", "description": "ASCII text describing the reason for call termination.\n \n This object exists because it would be impossible for\n a management station to store all possible cause values\n for all types of interfaces. It should be used only if\n a management station is unable to decode the value of\n dialCtlPeerStatsLastDisconnectCause.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cCallHistoryConnectTime": { "type": "string", "description": "The value of sysUpTime when the call was connected.", "x-yang-type": "yang:timestamp" }, "cCallHistoryDisconnectTime": { "type": "string", "description": "The value of sysUpTime when the call was disconnected.", "x-yang-type": "yang:timestamp" }, "cCallHistoryCallOrigin": { "type": "string", "description": "The call origin." }, "cCallHistoryChargedUnits": { "type": "string", "description": "The number of charged units for this connection.\n For incoming calls or if charging information is\n not supplied by the switch, the value of this object\n will be zero.", "x-yang-type": "dial-control:AbsoluteCounter32" }, "cCallHistoryInfoType": { "type": "string", "description": "The information type for this call." }, "cCallHistoryTransmitPackets": { "type": "string", "description": "The number of packets which were transmitted while this\n call was active.", "x-yang-type": "dial-control:AbsoluteCounter32" }, "cCallHistoryTransmitBytes": { "type": "string", "description": "The number of bytes which were transmitted while this\n call was active.", "x-yang-type": "dial-control:AbsoluteCounter32" }, "cCallHistoryReceivePackets": { "type": "string", "description": "The number of packets which were received while this\n call was active.", "x-yang-type": "dial-control:AbsoluteCounter32" }, "cCallHistoryReceiveBytes": { "type": "string", "description": "The number of bytes which were received while this\n call was active.", "x-yang-type": "dial-control:AbsoluteCounter32" }, "cCallHistoryReleaseSource": { "type": "string", "description": "Originator of the call release." }, "cCallHistoryReleaseSrc": { "type": "string", "description": "Originator of the call release. Indicates the source of \n the call release as follows : \n 1) callingPartyInPstn : Calling party in PSTN.\n 2) callingPartyInVoip : Calling party in VoIP.\n 3) calledPartyInPstn : Called party in PSTN.\n 4) calledPartyInVoip : Called party in VoIP.\n 5) internalReleaseInPotsLeg : Due to an internal error \n in Telephony call leg.\n 6) internalReleaseInVoipLeg : Due to an internal error\n in VoIP call leg.\n 7) internalCallControlApp : Due to an internal error\n in Session Application or Tcl or VXML script originated\n release. \n 8) internalReleaseInVoipAAA : Due to an internal error\n in VoIP AAA module.\n 9) consoleCommand : Due to CLI or MML.\n 10) externalRadiusServer : Call failed during authorization\n , authentication or due to receipt of POD from the \n RADIUS server.\n 11) externalNmsApp : Due to SNMP request to clear \n the call.\n 12) externalCallControlAgent : External Call Control Agent\n initiated clear.\n 13) gatekeeper : Gatekeeper initiated clear due to receipt\n of Admission Reject, Disengage Request message.\n 14) externalGKTMPServer : External GKTMP server initiated\n clear due to receipt of Admission Reject message from\n the gatekeeper, triggered by RESPONSE.ARJ message from\n the GKTMP server." } } } }, "example": { "CISCO-DIAL-CONTROL-MIB:cCallHistoryEntry": [ { "cCallHistoryIndex": 1, "cCallHistorySetupTime": "example-string", "cCallHistoryPeerAddress": "192.168.1.1", "cCallHistoryPeerSubAddress": "192.168.1.1", "cCallHistoryPeerId": -2147483648, "cCallHistoryPeerIfIndex": 1, "cCallHistoryLogicalIfIndex": "example-string", "cCallHistoryDisconnectCause": "example-string", "cCallHistoryDisconnectText": "example-string", "cCallHistoryConnectTime": "example-string", "cCallHistoryDisconnectTime": "example-string", "cCallHistoryCallOrigin": "example-string", "cCallHistoryChargedUnits": "example-string", "cCallHistoryInfoType": "ethernetCsmacd(6)", "cCallHistoryTransmitPackets": "example-string", "cCallHistoryTransmitBytes": "example-string", "cCallHistoryReceivePackets": "example-string", "cCallHistoryReceiveBytes": "example-string", "cCallHistoryReleaseSource": "example-string", "cCallHistoryReleaseSrc": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cCallHistoryEntry", "parameters": [ { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ] }, "x-yang-path": "/cCallHistoryTable/cCallHistoryEntry", "x-restconf-kind": "container" }, "/data/CISCO-DIAL-CONTROL-MIB:cCallHistoryTable/cCallHistoryEntry={cCallHistoryIndex}": { "get": { "summary": "Get cCallHistoryEntry entry", "description": "Retrieve specific cCallHistoryEntry entry by key from MIB", "tags": [ "CISCO-DIAL-CONTROL-MIB" ], "parameters": [ { "name": "cCallHistoryIndex", "in": "path", "required": true, "schema": { "type": "string" }, "example": "1" }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "cCallHistoryIndex": { "type": "integer", "description": "A monotonically increasing integer for the sole purpose of\n indexing call disconnection events. When it reaches the \n maximum value, an extremely unlikely event, the agent wraps \n the value back to 1 and may flush existing entries.", "minimum": 0, "maximum": 4294967295 }, "cCallHistorySetupTime": { "type": "string", "description": "The value of sysUpTime when the call setup was started.\n This will be useful for an NMS to sort the call history\n entry with call setup time. Also, this object\n can be useful in finding large delays between the time the\n call was started and the time the call was connected.\n For ISDN media, this will be the time when the setup\n message was received from or sent to the network.\n The value of this object is the same as callActiveSetupTime\n in the callActiveTable", "x-yang-type": "yang:timestamp" }, "cCallHistoryPeerAddress": { "type": "string", "description": "The number this call was connected to. If the number is\n not available, then it will have a length of zero.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cCallHistoryPeerSubAddress": { "type": "string", "description": "The subaddress this call was connected to. If the subaddress\n is undefined or not available, this will be a zero length\n string.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cCallHistoryPeerId": { "type": "integer", "description": "This is the Id value of the peer table entry\n to which this call was made. If a peer table entry\n for this call does not exist, the value of this object\n will be zero.", "minimum": -2147483648, "maximum": 2147483647 }, "cCallHistoryPeerIfIndex": { "type": "integer", "description": "This is the ifIndex value of the peer table entry\n to which this call was made. If a peer table entry\n for this call does not exist, the value of this object\n will be zero.", "minimum": -2147483648, "maximum": 2147483647 }, "cCallHistoryLogicalIfIndex": { "type": "string", "description": "This is the ifIndex value of the logical interface through\n which this call was made. For ISDN media, this would be\n the ifIndex of the B channel which was used for this call.\n If the ifIndex value is unknown, the value of this object \n will be zero. For an IP call, the value will be zero.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "cCallHistoryDisconnectCause": { "type": "string", "description": "The encoded network cause value associated with this call.\n \n The value of this object will depend on the interface type\n as well as on the protocol and protocol version being\n used on this interface. Some references for possible cause\n values are given below.", "format": "binary" }, "cCallHistoryDisconnectText": { "type": "string", "description": "ASCII text describing the reason for call termination.\n \n This object exists because it would be impossible for\n a management station to store all possible cause values\n for all types of interfaces. It should be used only if\n a management station is unable to decode the value of\n dialCtlPeerStatsLastDisconnectCause.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cCallHistoryConnectTime": { "type": "string", "description": "The value of sysUpTime when the call was connected.", "x-yang-type": "yang:timestamp" }, "cCallHistoryDisconnectTime": { "type": "string", "description": "The value of sysUpTime when the call was disconnected.", "x-yang-type": "yang:timestamp" }, "cCallHistoryCallOrigin": { "type": "string", "description": "The call origin." }, "cCallHistoryChargedUnits": { "type": "string", "description": "The number of charged units for this connection.\n For incoming calls or if charging information is\n not supplied by the switch, the value of this object\n will be zero.", "x-yang-type": "dial-control:AbsoluteCounter32" }, "cCallHistoryInfoType": { "type": "string", "description": "The information type for this call." }, "cCallHistoryTransmitPackets": { "type": "string", "description": "The number of packets which were transmitted while this\n call was active.", "x-yang-type": "dial-control:AbsoluteCounter32" }, "cCallHistoryTransmitBytes": { "type": "string", "description": "The number of bytes which were transmitted while this\n call was active.", "x-yang-type": "dial-control:AbsoluteCounter32" }, "cCallHistoryReceivePackets": { "type": "string", "description": "The number of packets which were received while this\n call was active.", "x-yang-type": "dial-control:AbsoluteCounter32" }, "cCallHistoryReceiveBytes": { "type": "string", "description": "The number of bytes which were received while this\n call was active.", "x-yang-type": "dial-control:AbsoluteCounter32" }, "cCallHistoryReleaseSource": { "type": "string", "description": "Originator of the call release." }, "cCallHistoryReleaseSrc": { "type": "string", "description": "Originator of the call release. Indicates the source of \n the call release as follows : \n 1) callingPartyInPstn : Calling party in PSTN.\n 2) callingPartyInVoip : Calling party in VoIP.\n 3) calledPartyInPstn : Called party in PSTN.\n 4) calledPartyInVoip : Called party in VoIP.\n 5) internalReleaseInPotsLeg : Due to an internal error \n in Telephony call leg.\n 6) internalReleaseInVoipLeg : Due to an internal error\n in VoIP call leg.\n 7) internalCallControlApp : Due to an internal error\n in Session Application or Tcl or VXML script originated\n release. \n 8) internalReleaseInVoipAAA : Due to an internal error\n in VoIP AAA module.\n 9) consoleCommand : Due to CLI or MML.\n 10) externalRadiusServer : Call failed during authorization\n , authentication or due to receipt of POD from the \n RADIUS server.\n 11) externalNmsApp : Due to SNMP request to clear \n the call.\n 12) externalCallControlAgent : External Call Control Agent\n initiated clear.\n 13) gatekeeper : Gatekeeper initiated clear due to receipt\n of Admission Reject, Disengage Request message.\n 14) externalGKTMPServer : External GKTMP server initiated\n clear due to receipt of Admission Reject message from\n the gatekeeper, triggered by RESPONSE.ARJ message from\n the GKTMP server." } } }, "example": { "CISCO-DIAL-CONTROL-MIB:cCallHistoryEntry": { "cCallHistoryIndex": 1, "cCallHistorySetupTime": "example-string", "cCallHistoryPeerAddress": "192.168.1.1", "cCallHistoryPeerSubAddress": "192.168.1.1", "cCallHistoryPeerId": -2147483648, "cCallHistoryPeerIfIndex": 1, "cCallHistoryLogicalIfIndex": "example-string", "cCallHistoryDisconnectCause": "example-string", "cCallHistoryDisconnectText": "example-string", "cCallHistoryConnectTime": "example-string", "cCallHistoryDisconnectTime": "example-string", "cCallHistoryCallOrigin": "example-string", "cCallHistoryChargedUnits": "example-string", "cCallHistoryInfoType": "ethernetCsmacd(6)", "cCallHistoryTransmitPackets": "example-string", "cCallHistoryTransmitBytes": "example-string", "cCallHistoryReceivePackets": "example-string", "cCallHistoryReceiveBytes": "example-string", "cCallHistoryReleaseSource": "example-string", "cCallHistoryReleaseSrc": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cCallHistoryEntry-2" }, "x-yang-path": "/cCallHistoryTable/cCallHistoryEntry={cCallHistoryIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cCallHistoryIndex" ] }, "/data/CISCO-DIAL-CONTROL-MIB:cCallHistoryIecTable": { "get": { "summary": "Get cCallHistoryIecTable data", "description": "Retrieve cCallHistoryIecTable operational data from MIB", "tags": [ "CISCO-DIAL-CONTROL-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table contains information about Internal Error\n Code(s) (IEC) which caused the call to fail.", "properties": { "cCallHistoryIecEntry": { "type": "array", "description": "The IEC information regarding a single call.", "items": { "type": "object", "properties": { "cCallHistoryIndex": { "type": "string", "description": "cCallHistoryIndex", "x-yang-type": "leafref" }, "cCallHistoryIecIndex": { "type": "integer", "description": "This object is used to index one or more IECs in the\n context of a single call. In most cases there will\n only be one IEC when a call fails. However, it is\n possible for the software processing the call to \n generate multiple IECs before the call ultimately fails.\n In that scenario, there will be multiple entries in\n this table related to a single call (cCallHistoryIndex)\n and this object will serve to uniquely identify each IEC.", "minimum": 0, "maximum": 4294967295 }, "cCallHistoryIec": { "type": "string", "description": "This object reflects the Internal Error Code.\n The format is a string of dotted decimal numbers\n composed of the following components:\n \n Version.Entity.Category.Subsystem.Errorcode.Diagnostic\n \n Each component is defined as follows:\n Version : The version of IEC software.\n Entity : The network entity that originated\n the error.\n Category : The category of the error (eg, software\n error, hardware resource unavailable, ...)\n Subsystem : The subsystem in which the error occurred.\n Errorcode : A subsytem-specific error code.\n Diagnostic : An implementation-specific diagnostic code.", "x-yang-type": "snmp-framework:SnmpAdminString" } } } } } }, "example": { "CISCO-DIAL-CONTROL-MIB:cCallHistoryIecTable": { "cCallHistoryIecEntry": [ { "cCallHistoryIndex": "1", "cCallHistoryIecIndex": 1, "cCallHistoryIec": "example-string" }, { "cCallHistoryIndex": "2", "cCallHistoryIecIndex": 2, "cCallHistoryIec": "example-string" }, { "cCallHistoryIndex": "3", "cCallHistoryIecIndex": 3, "cCallHistoryIec": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cCallHistoryIecTable", "parameters": [ { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ] }, "x-yang-path": "/cCallHistoryIecTable", "x-restconf-kind": "container" }, "/data/CISCO-DIAL-CONTROL-MIB:cCallHistoryIecTable/cCallHistoryIecEntry": { "get": { "summary": "Get cCallHistoryIecEntry list", "description": "Retrieve list of cCallHistoryIecEntry entries from MIB", "tags": [ "CISCO-DIAL-CONTROL-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "The IEC information regarding a single call.", "items": { "type": "object", "properties": { "cCallHistoryIndex": { "type": "string", "description": "cCallHistoryIndex", "x-yang-type": "leafref" }, "cCallHistoryIecIndex": { "type": "integer", "description": "This object is used to index one or more IECs in the\n context of a single call. In most cases there will\n only be one IEC when a call fails. However, it is\n possible for the software processing the call to \n generate multiple IECs before the call ultimately fails.\n In that scenario, there will be multiple entries in\n this table related to a single call (cCallHistoryIndex)\n and this object will serve to uniquely identify each IEC.", "minimum": 0, "maximum": 4294967295 }, "cCallHistoryIec": { "type": "string", "description": "This object reflects the Internal Error Code.\n The format is a string of dotted decimal numbers\n composed of the following components:\n \n Version.Entity.Category.Subsystem.Errorcode.Diagnostic\n \n Each component is defined as follows:\n Version : The version of IEC software.\n Entity : The network entity that originated\n the error.\n Category : The category of the error (eg, software\n error, hardware resource unavailable, ...)\n Subsystem : The subsystem in which the error occurred.\n Errorcode : A subsytem-specific error code.\n Diagnostic : An implementation-specific diagnostic code.", "x-yang-type": "snmp-framework:SnmpAdminString" } } } }, "example": { "CISCO-DIAL-CONTROL-MIB:cCallHistoryIecEntry": [ { "cCallHistoryIndex": "example-string", "cCallHistoryIecIndex": 1, "cCallHistoryIec": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cCallHistoryIecEntry", "parameters": [ { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ] }, "x-yang-path": "/cCallHistoryIecTable/cCallHistoryIecEntry", "x-restconf-kind": "container" }, "/data/CISCO-DIAL-CONTROL-MIB:cCallHistoryEntry": { "get": { "summary": "Get cCallHistoryEntry list", "description": "Retrieve list of cCallHistoryEntry entries from MIB", "tags": [ "CISCO-DIAL-CONTROL-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "The information regarding a single Connection.", "items": { "type": "object", "properties": { "cCallHistoryIndex": { "type": "integer", "description": "A monotonically increasing integer for the sole purpose of\n indexing call disconnection events. When it reaches the \n maximum value, an extremely unlikely event, the agent wraps \n the value back to 1 and may flush existing entries.", "minimum": 0, "maximum": 4294967295 }, "cCallHistorySetupTime": { "type": "string", "description": "The value of sysUpTime when the call setup was started.\n This will be useful for an NMS to sort the call history\n entry with call setup time. Also, this object\n can be useful in finding large delays between the time the\n call was started and the time the call was connected.\n For ISDN media, this will be the time when the setup\n message was received from or sent to the network.\n The value of this object is the same as callActiveSetupTime\n in the callActiveTable", "x-yang-type": "yang:timestamp" }, "cCallHistoryPeerAddress": { "type": "string", "description": "The number this call was connected to. If the number is\n not available, then it will have a length of zero.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cCallHistoryPeerSubAddress": { "type": "string", "description": "The subaddress this call was connected to. If the subaddress\n is undefined or not available, this will be a zero length\n string.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cCallHistoryPeerId": { "type": "integer", "description": "This is the Id value of the peer table entry\n to which this call was made. If a peer table entry\n for this call does not exist, the value of this object\n will be zero.", "minimum": -2147483648, "maximum": 2147483647 }, "cCallHistoryPeerIfIndex": { "type": "integer", "description": "This is the ifIndex value of the peer table entry\n to which this call was made. If a peer table entry\n for this call does not exist, the value of this object\n will be zero.", "minimum": -2147483648, "maximum": 2147483647 }, "cCallHistoryLogicalIfIndex": { "type": "string", "description": "This is the ifIndex value of the logical interface through\n which this call was made. For ISDN media, this would be\n the ifIndex of the B channel which was used for this call.\n If the ifIndex value is unknown, the value of this object \n will be zero. For an IP call, the value will be zero.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "cCallHistoryDisconnectCause": { "type": "string", "description": "The encoded network cause value associated with this call.\n \n The value of this object will depend on the interface type\n as well as on the protocol and protocol version being\n used on this interface. Some references for possible cause\n values are given below.", "format": "binary" }, "cCallHistoryDisconnectText": { "type": "string", "description": "ASCII text describing the reason for call termination.\n \n This object exists because it would be impossible for\n a management station to store all possible cause values\n for all types of interfaces. It should be used only if\n a management station is unable to decode the value of\n dialCtlPeerStatsLastDisconnectCause.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cCallHistoryConnectTime": { "type": "string", "description": "The value of sysUpTime when the call was connected.", "x-yang-type": "yang:timestamp" }, "cCallHistoryDisconnectTime": { "type": "string", "description": "The value of sysUpTime when the call was disconnected.", "x-yang-type": "yang:timestamp" }, "cCallHistoryCallOrigin": { "type": "string", "description": "The call origin." }, "cCallHistoryChargedUnits": { "type": "string", "description": "The number of charged units for this connection.\n For incoming calls or if charging information is\n not supplied by the switch, the value of this object\n will be zero.", "x-yang-type": "dial-control:AbsoluteCounter32" }, "cCallHistoryInfoType": { "type": "string", "description": "The information type for this call." }, "cCallHistoryTransmitPackets": { "type": "string", "description": "The number of packets which were transmitted while this\n call was active.", "x-yang-type": "dial-control:AbsoluteCounter32" }, "cCallHistoryTransmitBytes": { "type": "string", "description": "The number of bytes which were transmitted while this\n call was active.", "x-yang-type": "dial-control:AbsoluteCounter32" }, "cCallHistoryReceivePackets": { "type": "string", "description": "The number of packets which were received while this\n call was active.", "x-yang-type": "dial-control:AbsoluteCounter32" }, "cCallHistoryReceiveBytes": { "type": "string", "description": "The number of bytes which were received while this\n call was active.", "x-yang-type": "dial-control:AbsoluteCounter32" }, "cCallHistoryReleaseSource": { "type": "string", "description": "Originator of the call release." }, "cCallHistoryReleaseSrc": { "type": "string", "description": "Originator of the call release. Indicates the source of \n the call release as follows : \n 1) callingPartyInPstn : Calling party in PSTN.\n 2) callingPartyInVoip : Calling party in VoIP.\n 3) calledPartyInPstn : Called party in PSTN.\n 4) calledPartyInVoip : Called party in VoIP.\n 5) internalReleaseInPotsLeg : Due to an internal error \n in Telephony call leg.\n 6) internalReleaseInVoipLeg : Due to an internal error\n in VoIP call leg.\n 7) internalCallControlApp : Due to an internal error\n in Session Application or Tcl or VXML script originated\n release. \n 8) internalReleaseInVoipAAA : Due to an internal error\n in VoIP AAA module.\n 9) consoleCommand : Due to CLI or MML.\n 10) externalRadiusServer : Call failed during authorization\n , authentication or due to receipt of POD from the \n RADIUS server.\n 11) externalNmsApp : Due to SNMP request to clear \n the call.\n 12) externalCallControlAgent : External Call Control Agent\n initiated clear.\n 13) gatekeeper : Gatekeeper initiated clear due to receipt\n of Admission Reject, Disengage Request message.\n 14) externalGKTMPServer : External GKTMP server initiated\n clear due to receipt of Admission Reject message from\n the gatekeeper, triggered by RESPONSE.ARJ message from\n the GKTMP server." } } } }, "example": { "CISCO-DIAL-CONTROL-MIB:cCallHistoryEntry": [ { "cCallHistoryIndex": 1, "cCallHistorySetupTime": "example-string", "cCallHistoryPeerAddress": "192.168.1.1", "cCallHistoryPeerSubAddress": "192.168.1.1", "cCallHistoryPeerId": -2147483648, "cCallHistoryPeerIfIndex": 1, "cCallHistoryLogicalIfIndex": "example-string", "cCallHistoryDisconnectCause": "example-string", "cCallHistoryDisconnectText": "example-string", "cCallHistoryConnectTime": "example-string", "cCallHistoryDisconnectTime": "example-string", "cCallHistoryCallOrigin": "example-string", "cCallHistoryChargedUnits": "example-string", "cCallHistoryInfoType": "ethernetCsmacd(6)", "cCallHistoryTransmitPackets": "example-string", "cCallHistoryTransmitBytes": "example-string", "cCallHistoryReceivePackets": "example-string", "cCallHistoryReceiveBytes": "example-string", "cCallHistoryReleaseSource": "example-string", "cCallHistoryReleaseSrc": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cCallHistoryEntry-3", "parameters": [ { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ] }, "x-yang-path": "/cCallHistoryEntry", "x-restconf-kind": "container" }, "/data/CISCO-DIAL-CONTROL-MIB:cCallHistoryEntry={cCallHistoryIndex}": { "get": { "summary": "Get cCallHistoryEntry entry", "description": "Retrieve specific cCallHistoryEntry entry by key from MIB", "tags": [ "CISCO-DIAL-CONTROL-MIB" ], "parameters": [ { "name": "cCallHistoryIndex", "in": "path", "required": true, "schema": { "type": "string" }, "example": "1" }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "cCallHistoryIndex": { "type": "integer", "description": "A monotonically increasing integer for the sole purpose of\n indexing call disconnection events. When it reaches the \n maximum value, an extremely unlikely event, the agent wraps \n the value back to 1 and may flush existing entries.", "minimum": 0, "maximum": 4294967295 }, "cCallHistorySetupTime": { "type": "string", "description": "The value of sysUpTime when the call setup was started.\n This will be useful for an NMS to sort the call history\n entry with call setup time. Also, this object\n can be useful in finding large delays between the time the\n call was started and the time the call was connected.\n For ISDN media, this will be the time when the setup\n message was received from or sent to the network.\n The value of this object is the same as callActiveSetupTime\n in the callActiveTable", "x-yang-type": "yang:timestamp" }, "cCallHistoryPeerAddress": { "type": "string", "description": "The number this call was connected to. If the number is\n not available, then it will have a length of zero.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cCallHistoryPeerSubAddress": { "type": "string", "description": "The subaddress this call was connected to. If the subaddress\n is undefined or not available, this will be a zero length\n string.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cCallHistoryPeerId": { "type": "integer", "description": "This is the Id value of the peer table entry\n to which this call was made. If a peer table entry\n for this call does not exist, the value of this object\n will be zero.", "minimum": -2147483648, "maximum": 2147483647 }, "cCallHistoryPeerIfIndex": { "type": "integer", "description": "This is the ifIndex value of the peer table entry\n to which this call was made. If a peer table entry\n for this call does not exist, the value of this object\n will be zero.", "minimum": -2147483648, "maximum": 2147483647 }, "cCallHistoryLogicalIfIndex": { "type": "string", "description": "This is the ifIndex value of the logical interface through\n which this call was made. For ISDN media, this would be\n the ifIndex of the B channel which was used for this call.\n If the ifIndex value is unknown, the value of this object \n will be zero. For an IP call, the value will be zero.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "cCallHistoryDisconnectCause": { "type": "string", "description": "The encoded network cause value associated with this call.\n \n The value of this object will depend on the interface type\n as well as on the protocol and protocol version being\n used on this interface. Some references for possible cause\n values are given below.", "format": "binary" }, "cCallHistoryDisconnectText": { "type": "string", "description": "ASCII text describing the reason for call termination.\n \n This object exists because it would be impossible for\n a management station to store all possible cause values\n for all types of interfaces. It should be used only if\n a management station is unable to decode the value of\n dialCtlPeerStatsLastDisconnectCause.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cCallHistoryConnectTime": { "type": "string", "description": "The value of sysUpTime when the call was connected.", "x-yang-type": "yang:timestamp" }, "cCallHistoryDisconnectTime": { "type": "string", "description": "The value of sysUpTime when the call was disconnected.", "x-yang-type": "yang:timestamp" }, "cCallHistoryCallOrigin": { "type": "string", "description": "The call origin." }, "cCallHistoryChargedUnits": { "type": "string", "description": "The number of charged units for this connection.\n For incoming calls or if charging information is\n not supplied by the switch, the value of this object\n will be zero.", "x-yang-type": "dial-control:AbsoluteCounter32" }, "cCallHistoryInfoType": { "type": "string", "description": "The information type for this call." }, "cCallHistoryTransmitPackets": { "type": "string", "description": "The number of packets which were transmitted while this\n call was active.", "x-yang-type": "dial-control:AbsoluteCounter32" }, "cCallHistoryTransmitBytes": { "type": "string", "description": "The number of bytes which were transmitted while this\n call was active.", "x-yang-type": "dial-control:AbsoluteCounter32" }, "cCallHistoryReceivePackets": { "type": "string", "description": "The number of packets which were received while this\n call was active.", "x-yang-type": "dial-control:AbsoluteCounter32" }, "cCallHistoryReceiveBytes": { "type": "string", "description": "The number of bytes which were received while this\n call was active.", "x-yang-type": "dial-control:AbsoluteCounter32" }, "cCallHistoryReleaseSource": { "type": "string", "description": "Originator of the call release." }, "cCallHistoryReleaseSrc": { "type": "string", "description": "Originator of the call release. Indicates the source of \n the call release as follows : \n 1) callingPartyInPstn : Calling party in PSTN.\n 2) callingPartyInVoip : Calling party in VoIP.\n 3) calledPartyInPstn : Called party in PSTN.\n 4) calledPartyInVoip : Called party in VoIP.\n 5) internalReleaseInPotsLeg : Due to an internal error \n in Telephony call leg.\n 6) internalReleaseInVoipLeg : Due to an internal error\n in VoIP call leg.\n 7) internalCallControlApp : Due to an internal error\n in Session Application or Tcl or VXML script originated\n release. \n 8) internalReleaseInVoipAAA : Due to an internal error\n in VoIP AAA module.\n 9) consoleCommand : Due to CLI or MML.\n 10) externalRadiusServer : Call failed during authorization\n , authentication or due to receipt of POD from the \n RADIUS server.\n 11) externalNmsApp : Due to SNMP request to clear \n the call.\n 12) externalCallControlAgent : External Call Control Agent\n initiated clear.\n 13) gatekeeper : Gatekeeper initiated clear due to receipt\n of Admission Reject, Disengage Request message.\n 14) externalGKTMPServer : External GKTMP server initiated\n clear due to receipt of Admission Reject message from\n the gatekeeper, triggered by RESPONSE.ARJ message from\n the GKTMP server." } } }, "example": { "CISCO-DIAL-CONTROL-MIB:cCallHistoryEntry": { "cCallHistoryIndex": 1, "cCallHistorySetupTime": "example-string", "cCallHistoryPeerAddress": "192.168.1.1", "cCallHistoryPeerSubAddress": "192.168.1.1", "cCallHistoryPeerId": -2147483648, "cCallHistoryPeerIfIndex": 1, "cCallHistoryLogicalIfIndex": "example-string", "cCallHistoryDisconnectCause": "example-string", "cCallHistoryDisconnectText": "example-string", "cCallHistoryConnectTime": "example-string", "cCallHistoryDisconnectTime": "example-string", "cCallHistoryCallOrigin": "example-string", "cCallHistoryChargedUnits": "example-string", "cCallHistoryInfoType": "ethernetCsmacd(6)", "cCallHistoryTransmitPackets": "example-string", "cCallHistoryTransmitBytes": "example-string", "cCallHistoryReceivePackets": "example-string", "cCallHistoryReceiveBytes": "example-string", "cCallHistoryReleaseSource": "example-string", "cCallHistoryReleaseSrc": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cCallHistoryEntry-4" }, "x-yang-path": "/cCallHistoryEntry={cCallHistoryIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cCallHistoryIndex" ] }, "/data/CISCO-DIAL-CONTROL-MIB:cCallHistoryIecEntry": { "get": { "summary": "Get cCallHistoryIecEntry list", "description": "Retrieve list of cCallHistoryIecEntry entries from MIB", "tags": [ "CISCO-DIAL-CONTROL-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "The IEC information regarding a single call.", "items": { "type": "object", "properties": { "cCallHistoryIndex": { "type": "string", "description": "cCallHistoryIndex", "x-yang-type": "leafref" }, "cCallHistoryIecIndex": { "type": "integer", "description": "This object is used to index one or more IECs in the\n context of a single call. In most cases there will\n only be one IEC when a call fails. However, it is\n possible for the software processing the call to \n generate multiple IECs before the call ultimately fails.\n In that scenario, there will be multiple entries in\n this table related to a single call (cCallHistoryIndex)\n and this object will serve to uniquely identify each IEC.", "minimum": 0, "maximum": 4294967295 }, "cCallHistoryIec": { "type": "string", "description": "This object reflects the Internal Error Code.\n The format is a string of dotted decimal numbers\n composed of the following components:\n \n Version.Entity.Category.Subsystem.Errorcode.Diagnostic\n \n Each component is defined as follows:\n Version : The version of IEC software.\n Entity : The network entity that originated\n the error.\n Category : The category of the error (eg, software\n error, hardware resource unavailable, ...)\n Subsystem : The subsystem in which the error occurred.\n Errorcode : A subsytem-specific error code.\n Diagnostic : An implementation-specific diagnostic code.", "x-yang-type": "snmp-framework:SnmpAdminString" } } } }, "example": { "CISCO-DIAL-CONTROL-MIB:cCallHistoryIecEntry": [ { "cCallHistoryIndex": "example-string", "cCallHistoryIecIndex": 1, "cCallHistoryIec": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cCallHistoryIecEntry-3", "parameters": [ { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ] }, "x-yang-path": "/cCallHistoryIecEntry", "x-restconf-kind": "container" }, "/data/CISCO-DIAL-CONTROL-MIB:cCallHistoryIecTable/cCallHistoryIecEntry={cCallHistoryIndex},{cCallHistoryIecIndex}": { "get": { "summary": "Get cCallHistoryIecEntry entry", "description": "Retrieve specific cCallHistoryIecEntry entry by key from MIB", "tags": [ "CISCO-DIAL-CONTROL-MIB" ], "parameters": [ { "name": "cCallHistoryIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cCallHistoryIecIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "cCallHistoryIndex": { "type": "string", "description": "cCallHistoryIndex", "x-yang-type": "leafref" }, "cCallHistoryIecIndex": { "type": "integer", "description": "This object is used to index one or more IECs in the\n context of a single call. In most cases there will\n only be one IEC when a call fails. However, it is\n possible for the software processing the call to \n generate multiple IECs before the call ultimately fails.\n In that scenario, there will be multiple entries in\n this table related to a single call (cCallHistoryIndex)\n and this object will serve to uniquely identify each IEC.", "minimum": 0, "maximum": 4294967295 }, "cCallHistoryIec": { "type": "string", "description": "This object reflects the Internal Error Code.\n The format is a string of dotted decimal numbers\n composed of the following components:\n \n Version.Entity.Category.Subsystem.Errorcode.Diagnostic\n \n Each component is defined as follows:\n Version : The version of IEC software.\n Entity : The network entity that originated\n the error.\n Category : The category of the error (eg, software\n error, hardware resource unavailable, ...)\n Subsystem : The subsystem in which the error occurred.\n Errorcode : A subsytem-specific error code.\n Diagnostic : An implementation-specific diagnostic code.", "x-yang-type": "snmp-framework:SnmpAdminString" } } }, "example": { "CISCO-DIAL-CONTROL-MIB:cCallHistoryIecEntry": { "cCallHistoryIndex": "example-string", "cCallHistoryIecIndex": 1, "cCallHistoryIec": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cCallHistoryIecEntry-2" }, "x-yang-path": "/cCallHistoryIecTable/cCallHistoryIecEntry={cCallHistoryIndex cCallHistoryIecIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cCallHistoryIndex cCallHistoryIecIndex" ] }, "/data/CISCO-DIAL-CONTROL-MIB:cCallHistoryIecEntry={cCallHistoryIndex},{cCallHistoryIecIndex}": { "get": { "summary": "Get cCallHistoryIecEntry entry", "description": "Retrieve specific cCallHistoryIecEntry entry by key from MIB", "tags": [ "CISCO-DIAL-CONTROL-MIB" ], "parameters": [ { "name": "cCallHistoryIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cCallHistoryIecIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "cCallHistoryIndex": { "type": "string", "description": "cCallHistoryIndex", "x-yang-type": "leafref" }, "cCallHistoryIecIndex": { "type": "integer", "description": "This object is used to index one or more IECs in the\n context of a single call. In most cases there will\n only be one IEC when a call fails. However, it is\n possible for the software processing the call to \n generate multiple IECs before the call ultimately fails.\n In that scenario, there will be multiple entries in\n this table related to a single call (cCallHistoryIndex)\n and this object will serve to uniquely identify each IEC.", "minimum": 0, "maximum": 4294967295 }, "cCallHistoryIec": { "type": "string", "description": "This object reflects the Internal Error Code.\n The format is a string of dotted decimal numbers\n composed of the following components:\n \n Version.Entity.Category.Subsystem.Errorcode.Diagnostic\n \n Each component is defined as follows:\n Version : The version of IEC software.\n Entity : The network entity that originated\n the error.\n Category : The category of the error (eg, software\n error, hardware resource unavailable, ...)\n Subsystem : The subsystem in which the error occurred.\n Errorcode : A subsytem-specific error code.\n Diagnostic : An implementation-specific diagnostic code.", "x-yang-type": "snmp-framework:SnmpAdminString" } } }, "example": { "CISCO-DIAL-CONTROL-MIB:cCallHistoryIecEntry": { "cCallHistoryIndex": "example-string", "cCallHistoryIecIndex": 1, "cCallHistoryIec": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cCallHistoryIecEntry-4" }, "x-yang-path": "/cCallHistoryIecEntry={cCallHistoryIndex cCallHistoryIecIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cCallHistoryIndex cCallHistoryIecIndex" ] } }, "components": { "schemas": { "CISCO-DIAL-CONTROL-MIB_CISCO-DIAL-CONTROL-MIB": { "type": "object", "description": "CISCO-DIAL-CONTROL-MIB", "properties": { "cCallHistoryEntry": { "type": "array", "description": "The information regarding a single Connection.", "items": { "type": "object", "properties": { "cCallHistoryIndex": { "type": "integer", "description": "A monotonically increasing integer for the sole purpose of\n indexing call disconnection events. When it reaches the \n maximum value, an extremely unlikely event, the agent wraps \n the value back to 1 and may flush existing entries.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cCallHistorySetupTime": { "type": "string", "description": "The value of sysUpTime when the call setup was started.\n This will be useful for an NMS to sort the call history\n entry with call setup time. Also, this object\n can be useful in finding large delays between the time the\n call was started and the time the call was connected.\n For ISDN media, this will be the time when the setup\n message was received from or sent to the network.\n The value of this object is the same as callActiveSetupTime\n in the callActiveTable", "x-yang-type": "yang:timestamp", "readOnly": true }, "cCallHistoryPeerAddress": { "type": "string", "description": "The number this call was connected to. If the number is\n not available, then it will have a length of zero.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cCallHistoryPeerSubAddress": { "type": "string", "description": "The subaddress this call was connected to. If the subaddress\n is undefined or not available, this will be a zero length\n string.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cCallHistoryPeerId": { "type": "integer", "description": "This is the Id value of the peer table entry\n to which this call was made. If a peer table entry\n for this call does not exist, the value of this object\n will be zero.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cCallHistoryPeerIfIndex": { "type": "integer", "description": "This is the ifIndex value of the peer table entry\n to which this call was made. If a peer table entry\n for this call does not exist, the value of this object\n will be zero.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cCallHistoryLogicalIfIndex": { "type": "string", "description": "This is the ifIndex value of the logical interface through\n which this call was made. For ISDN media, this would be\n the ifIndex of the B channel which was used for this call.\n If the ifIndex value is unknown, the value of this object \n will be zero. For an IP call, the value will be zero.", "x-yang-type": "if-mib:InterfaceIndexOrZero", "readOnly": true }, "cCallHistoryDisconnectCause": { "type": "string", "description": "The encoded network cause value associated with this call.\n \n The value of this object will depend on the interface type\n as well as on the protocol and protocol version being\n used on this interface. Some references for possible cause\n values are given below.", "format": "binary", "readOnly": true }, "cCallHistoryDisconnectText": { "type": "string", "description": "ASCII text describing the reason for call termination.\n \n This object exists because it would be impossible for\n a management station to store all possible cause values\n for all types of interfaces. It should be used only if\n a management station is unable to decode the value of\n dialCtlPeerStatsLastDisconnectCause.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cCallHistoryConnectTime": { "type": "string", "description": "The value of sysUpTime when the call was connected.", "x-yang-type": "yang:timestamp", "readOnly": true }, "cCallHistoryDisconnectTime": { "type": "string", "description": "The value of sysUpTime when the call was disconnected.", "x-yang-type": "yang:timestamp", "readOnly": true }, "cCallHistoryCallOrigin": { "type": "string", "description": "The call origin.", "readOnly": true }, "cCallHistoryChargedUnits": { "type": "string", "description": "The number of charged units for this connection.\n For incoming calls or if charging information is\n not supplied by the switch, the value of this object\n will be zero.", "x-yang-type": "dial-control:AbsoluteCounter32", "readOnly": true }, "cCallHistoryInfoType": { "type": "string", "description": "The information type for this call.", "readOnly": true }, "cCallHistoryTransmitPackets": { "type": "string", "description": "The number of packets which were transmitted while this\n call was active.", "x-yang-type": "dial-control:AbsoluteCounter32", "readOnly": true }, "cCallHistoryTransmitBytes": { "type": "string", "description": "The number of bytes which were transmitted while this\n call was active.", "x-yang-type": "dial-control:AbsoluteCounter32", "readOnly": true }, "cCallHistoryReceivePackets": { "type": "string", "description": "The number of packets which were received while this\n call was active.", "x-yang-type": "dial-control:AbsoluteCounter32", "readOnly": true }, "cCallHistoryReceiveBytes": { "type": "string", "description": "The number of bytes which were received while this\n call was active.", "x-yang-type": "dial-control:AbsoluteCounter32", "readOnly": true }, "cCallHistoryReleaseSource": { "type": "string", "description": "Originator of the call release.", "readOnly": true }, "cCallHistoryReleaseSrc": { "type": "string", "description": "Originator of the call release. Indicates the source of \n the call release as follows : \n 1) callingPartyInPstn : Calling party in PSTN.\n 2) callingPartyInVoip : Calling party in VoIP.\n 3) calledPartyInPstn : Called party in PSTN.\n 4) calledPartyInVoip : Called party in VoIP.\n 5) internalReleaseInPotsLeg : Due to an internal error \n in Telephony call leg.\n 6) internalReleaseInVoipLeg : Due to an internal error\n in VoIP call leg.\n 7) internalCallControlApp : Due to an internal error\n in Session Application or Tcl or VXML script originated\n release. \n 8) internalReleaseInVoipAAA : Due to an internal error\n in VoIP AAA module.\n 9) consoleCommand : Due to CLI or MML.\n 10) externalRadiusServer : Call failed during authorization\n , authentication or due to receipt of POD from the \n RADIUS server.\n 11) externalNmsApp : Due to SNMP request to clear \n the call.\n 12) externalCallControlAgent : External Call Control Agent\n initiated clear.\n 13) gatekeeper : Gatekeeper initiated clear due to receipt\n of Admission Reject, Disengage Request message.\n 14) externalGKTMPServer : External GKTMP server initiated\n clear due to receipt of Admission Reject message from\n the gatekeeper, triggered by RESPONSE.ARJ message from\n the GKTMP server.", "readOnly": true } } }, "readOnly": true }, "cCallHistoryIecEntry": { "type": "array", "description": "The IEC information regarding a single call.", "items": { "type": "object", "properties": { "cCallHistoryIndex": { "type": "string", "description": "cCallHistoryIndex", "x-yang-type": "leafref", "readOnly": true }, "cCallHistoryIecIndex": { "type": "integer", "description": "This object is used to index one or more IECs in the\n context of a single call. In most cases there will\n only be one IEC when a call fails. However, it is\n possible for the software processing the call to \n generate multiple IECs before the call ultimately fails.\n In that scenario, there will be multiple entries in\n this table related to a single call (cCallHistoryIndex)\n and this object will serve to uniquely identify each IEC.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cCallHistoryIec": { "type": "string", "description": "This object reflects the Internal Error Code.\n The format is a string of dotted decimal numbers\n composed of the following components:\n \n Version.Entity.Category.Subsystem.Errorcode.Diagnostic\n \n Each component is defined as follows:\n Version : The version of IEC software.\n Entity : The network entity that originated\n the error.\n Category : The category of the error (eg, software\n error, hardware resource unavailable, ...)\n Subsystem : The subsystem in which the error occurred.\n Errorcode : A subsytem-specific error code.\n Diagnostic : An implementation-specific diagnostic code.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true } } }, "readOnly": true }, "cPeerGlobalConfiguration": { "type": "object", "description": "cPeerGlobalConfiguration", "properties": { "cPeerSearchType": { "type": "string", "description": "Specifies the peer search preference based on the\n type of peers in an universal/integrated port\n platform.\n \n none - both voice and data peers are searched\n in same preference.\n datavoice - search data peers first. If no data peers\n are found, the voice peers are searched.\n voicedata - search voice peers first. If no voice peers\n are found, the data peers are searched.", "readOnly": true } }, "readOnly": true }, "cCallHistoryTable": { "type": "object", "description": "A table containing information about specific\n calls to a specific destination.", "properties": { "cCallHistoryEntry": { "type": "array", "description": "The information regarding a single Connection.", "items": { "type": "object", "properties": { "cCallHistoryIndex": { "type": "integer", "description": "A monotonically increasing integer for the sole purpose of\n indexing call disconnection events. When it reaches the \n maximum value, an extremely unlikely event, the agent wraps \n the value back to 1 and may flush existing entries.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cCallHistorySetupTime": { "type": "string", "description": "The value of sysUpTime when the call setup was started.\n This will be useful for an NMS to sort the call history\n entry with call setup time. Also, this object\n can be useful in finding large delays between the time the\n call was started and the time the call was connected.\n For ISDN media, this will be the time when the setup\n message was received from or sent to the network.\n The value of this object is the same as callActiveSetupTime\n in the callActiveTable", "x-yang-type": "yang:timestamp", "readOnly": true }, "cCallHistoryPeerAddress": { "type": "string", "description": "The number this call was connected to. If the number is\n not available, then it will have a length of zero.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cCallHistoryPeerSubAddress": { "type": "string", "description": "The subaddress this call was connected to. If the subaddress\n is undefined or not available, this will be a zero length\n string.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cCallHistoryPeerId": { "type": "integer", "description": "This is the Id value of the peer table entry\n to which this call was made. If a peer table entry\n for this call does not exist, the value of this object\n will be zero.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cCallHistoryPeerIfIndex": { "type": "integer", "description": "This is the ifIndex value of the peer table entry\n to which this call was made. If a peer table entry\n for this call does not exist, the value of this object\n will be zero.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cCallHistoryLogicalIfIndex": { "type": "string", "description": "This is the ifIndex value of the logical interface through\n which this call was made. For ISDN media, this would be\n the ifIndex of the B channel which was used for this call.\n If the ifIndex value is unknown, the value of this object \n will be zero. For an IP call, the value will be zero.", "x-yang-type": "if-mib:InterfaceIndexOrZero", "readOnly": true }, "cCallHistoryDisconnectCause": { "type": "string", "description": "The encoded network cause value associated with this call.\n \n The value of this object will depend on the interface type\n as well as on the protocol and protocol version being\n used on this interface. Some references for possible cause\n values are given below.", "format": "binary", "readOnly": true }, "cCallHistoryDisconnectText": { "type": "string", "description": "ASCII text describing the reason for call termination.\n \n This object exists because it would be impossible for\n a management station to store all possible cause values\n for all types of interfaces. It should be used only if\n a management station is unable to decode the value of\n dialCtlPeerStatsLastDisconnectCause.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cCallHistoryConnectTime": { "type": "string", "description": "The value of sysUpTime when the call was connected.", "x-yang-type": "yang:timestamp", "readOnly": true }, "cCallHistoryDisconnectTime": { "type": "string", "description": "The value of sysUpTime when the call was disconnected.", "x-yang-type": "yang:timestamp", "readOnly": true }, "cCallHistoryCallOrigin": { "type": "string", "description": "The call origin.", "readOnly": true }, "cCallHistoryChargedUnits": { "type": "string", "description": "The number of charged units for this connection.\n For incoming calls or if charging information is\n not supplied by the switch, the value of this object\n will be zero.", "x-yang-type": "dial-control:AbsoluteCounter32", "readOnly": true }, "cCallHistoryInfoType": { "type": "string", "description": "The information type for this call.", "readOnly": true }, "cCallHistoryTransmitPackets": { "type": "string", "description": "The number of packets which were transmitted while this\n call was active.", "x-yang-type": "dial-control:AbsoluteCounter32", "readOnly": true }, "cCallHistoryTransmitBytes": { "type": "string", "description": "The number of bytes which were transmitted while this\n call was active.", "x-yang-type": "dial-control:AbsoluteCounter32", "readOnly": true }, "cCallHistoryReceivePackets": { "type": "string", "description": "The number of packets which were received while this\n call was active.", "x-yang-type": "dial-control:AbsoluteCounter32", "readOnly": true }, "cCallHistoryReceiveBytes": { "type": "string", "description": "The number of bytes which were received while this\n call was active.", "x-yang-type": "dial-control:AbsoluteCounter32", "readOnly": true }, "cCallHistoryReleaseSource": { "type": "string", "description": "Originator of the call release.", "readOnly": true }, "cCallHistoryReleaseSrc": { "type": "string", "description": "Originator of the call release. Indicates the source of \n the call release as follows : \n 1) callingPartyInPstn : Calling party in PSTN.\n 2) callingPartyInVoip : Calling party in VoIP.\n 3) calledPartyInPstn : Called party in PSTN.\n 4) calledPartyInVoip : Called party in VoIP.\n 5) internalReleaseInPotsLeg : Due to an internal error \n in Telephony call leg.\n 6) internalReleaseInVoipLeg : Due to an internal error\n in VoIP call leg.\n 7) internalCallControlApp : Due to an internal error\n in Session Application or Tcl or VXML script originated\n release. \n 8) internalReleaseInVoipAAA : Due to an internal error\n in VoIP AAA module.\n 9) consoleCommand : Due to CLI or MML.\n 10) externalRadiusServer : Call failed during authorization\n , authentication or due to receipt of POD from the \n RADIUS server.\n 11) externalNmsApp : Due to SNMP request to clear \n the call.\n 12) externalCallControlAgent : External Call Control Agent\n initiated clear.\n 13) gatekeeper : Gatekeeper initiated clear due to receipt\n of Admission Reject, Disengage Request message.\n 14) externalGKTMPServer : External GKTMP server initiated\n clear due to receipt of Admission Reject message from\n the gatekeeper, triggered by RESPONSE.ARJ message from\n the GKTMP server.", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cCallHistoryIecTable": { "type": "object", "description": "This table contains information about Internal Error\n Code(s) (IEC) which caused the call to fail.", "properties": { "cCallHistoryIecEntry": { "type": "array", "description": "The IEC information regarding a single call.", "items": { "type": "object", "properties": { "cCallHistoryIndex": { "type": "string", "description": "cCallHistoryIndex", "x-yang-type": "leafref", "readOnly": true }, "cCallHistoryIecIndex": { "type": "integer", "description": "This object is used to index one or more IECs in the\n context of a single call. In most cases there will\n only be one IEC when a call fails. However, it is\n possible for the software processing the call to \n generate multiple IECs before the call ultimately fails.\n In that scenario, there will be multiple entries in\n this table related to a single call (cCallHistoryIndex)\n and this object will serve to uniquely identify each IEC.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cCallHistoryIec": { "type": "string", "description": "This object reflects the Internal Error Code.\n The format is a string of dotted decimal numbers\n composed of the following components:\n \n Version.Entity.Category.Subsystem.Errorcode.Diagnostic\n \n Each component is defined as follows:\n Version : The version of IEC software.\n Entity : The network entity that originated\n the error.\n Category : The category of the error (eg, software\n error, hardware resource unavailable, ...)\n Subsystem : The subsystem in which the error occurred.\n Errorcode : A subsytem-specific error code.\n Diagnostic : An implementation-specific diagnostic code.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true } } }, "readOnly": true } }, "readOnly": true } } }, "CISCO-DIAL-CONTROL-MIB_cCallHistoryEntry": { "type": "array", "description": "The information regarding a single Connection.", "items": { "type": "object", "properties": { "cCallHistoryIndex": { "type": "integer", "description": "A monotonically increasing integer for the sole purpose of\n indexing call disconnection events. When it reaches the \n maximum value, an extremely unlikely event, the agent wraps \n the value back to 1 and may flush existing entries.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cCallHistorySetupTime": { "type": "string", "description": "The value of sysUpTime when the call setup was started.\n This will be useful for an NMS to sort the call history\n entry with call setup time. Also, this object\n can be useful in finding large delays between the time the\n call was started and the time the call was connected.\n For ISDN media, this will be the time when the setup\n message was received from or sent to the network.\n The value of this object is the same as callActiveSetupTime\n in the callActiveTable", "x-yang-type": "yang:timestamp", "readOnly": true }, "cCallHistoryPeerAddress": { "type": "string", "description": "The number this call was connected to. If the number is\n not available, then it will have a length of zero.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cCallHistoryPeerSubAddress": { "type": "string", "description": "The subaddress this call was connected to. If the subaddress\n is undefined or not available, this will be a zero length\n string.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cCallHistoryPeerId": { "type": "integer", "description": "This is the Id value of the peer table entry\n to which this call was made. If a peer table entry\n for this call does not exist, the value of this object\n will be zero.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cCallHistoryPeerIfIndex": { "type": "integer", "description": "This is the ifIndex value of the peer table entry\n to which this call was made. If a peer table entry\n for this call does not exist, the value of this object\n will be zero.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "cCallHistoryLogicalIfIndex": { "type": "string", "description": "This is the ifIndex value of the logical interface through\n which this call was made. For ISDN media, this would be\n the ifIndex of the B channel which was used for this call.\n If the ifIndex value is unknown, the value of this object \n will be zero. For an IP call, the value will be zero.", "x-yang-type": "if-mib:InterfaceIndexOrZero", "readOnly": true }, "cCallHistoryDisconnectCause": { "type": "string", "description": "The encoded network cause value associated with this call.\n \n The value of this object will depend on the interface type\n as well as on the protocol and protocol version being\n used on this interface. Some references for possible cause\n values are given below.", "format": "binary", "readOnly": true }, "cCallHistoryDisconnectText": { "type": "string", "description": "ASCII text describing the reason for call termination.\n \n This object exists because it would be impossible for\n a management station to store all possible cause values\n for all types of interfaces. It should be used only if\n a management station is unable to decode the value of\n dialCtlPeerStatsLastDisconnectCause.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cCallHistoryConnectTime": { "type": "string", "description": "The value of sysUpTime when the call was connected.", "x-yang-type": "yang:timestamp", "readOnly": true }, "cCallHistoryDisconnectTime": { "type": "string", "description": "The value of sysUpTime when the call was disconnected.", "x-yang-type": "yang:timestamp", "readOnly": true }, "cCallHistoryCallOrigin": { "type": "string", "description": "The call origin.", "readOnly": true }, "cCallHistoryChargedUnits": { "type": "string", "description": "The number of charged units for this connection.\n For incoming calls or if charging information is\n not supplied by the switch, the value of this object\n will be zero.", "x-yang-type": "dial-control:AbsoluteCounter32", "readOnly": true }, "cCallHistoryInfoType": { "type": "string", "description": "The information type for this call.", "readOnly": true }, "cCallHistoryTransmitPackets": { "type": "string", "description": "The number of packets which were transmitted while this\n call was active.", "x-yang-type": "dial-control:AbsoluteCounter32", "readOnly": true }, "cCallHistoryTransmitBytes": { "type": "string", "description": "The number of bytes which were transmitted while this\n call was active.", "x-yang-type": "dial-control:AbsoluteCounter32", "readOnly": true }, "cCallHistoryReceivePackets": { "type": "string", "description": "The number of packets which were received while this\n call was active.", "x-yang-type": "dial-control:AbsoluteCounter32", "readOnly": true }, "cCallHistoryReceiveBytes": { "type": "string", "description": "The number of bytes which were received while this\n call was active.", "x-yang-type": "dial-control:AbsoluteCounter32", "readOnly": true }, "cCallHistoryReleaseSource": { "type": "string", "description": "Originator of the call release.", "readOnly": true }, "cCallHistoryReleaseSrc": { "type": "string", "description": "Originator of the call release. Indicates the source of \n the call release as follows : \n 1) callingPartyInPstn : Calling party in PSTN.\n 2) callingPartyInVoip : Calling party in VoIP.\n 3) calledPartyInPstn : Called party in PSTN.\n 4) calledPartyInVoip : Called party in VoIP.\n 5) internalReleaseInPotsLeg : Due to an internal error \n in Telephony call leg.\n 6) internalReleaseInVoipLeg : Due to an internal error\n in VoIP call leg.\n 7) internalCallControlApp : Due to an internal error\n in Session Application or Tcl or VXML script originated\n release. \n 8) internalReleaseInVoipAAA : Due to an internal error\n in VoIP AAA module.\n 9) consoleCommand : Due to CLI or MML.\n 10) externalRadiusServer : Call failed during authorization\n , authentication or due to receipt of POD from the \n RADIUS server.\n 11) externalNmsApp : Due to SNMP request to clear \n the call.\n 12) externalCallControlAgent : External Call Control Agent\n initiated clear.\n 13) gatekeeper : Gatekeeper initiated clear due to receipt\n of Admission Reject, Disengage Request message.\n 14) externalGKTMPServer : External GKTMP server initiated\n clear due to receipt of Admission Reject message from\n the gatekeeper, triggered by RESPONSE.ARJ message from\n the GKTMP server.", "readOnly": true } } } }, "CISCO-DIAL-CONTROL-MIB_cCallHistoryIecEntry": { "type": "array", "description": "The IEC information regarding a single call.", "items": { "type": "object", "properties": { "cCallHistoryIndex": { "type": "string", "description": "cCallHistoryIndex", "x-yang-type": "leafref", "readOnly": true }, "cCallHistoryIecIndex": { "type": "integer", "description": "This object is used to index one or more IECs in the\n context of a single call. In most cases there will\n only be one IEC when a call fails. However, it is\n possible for the software processing the call to \n generate multiple IECs before the call ultimately fails.\n In that scenario, there will be multiple entries in\n this table related to a single call (cCallHistoryIndex)\n and this object will serve to uniquely identify each IEC.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cCallHistoryIec": { "type": "string", "description": "This object reflects the Internal Error Code.\n The format is a string of dotted decimal numbers\n composed of the following components:\n \n Version.Entity.Category.Subsystem.Errorcode.Diagnostic\n \n Each component is defined as follows:\n Version : The version of IEC software.\n Entity : The network entity that originated\n the error.\n Category : The category of the error (eg, software\n error, hardware resource unavailable, ...)\n Subsystem : The subsystem in which the error occurred.\n Errorcode : A subsytem-specific error code.\n Diagnostic : An implementation-specific diagnostic code.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true } } } }, "restconf-error": { "type": "object", "description": "Standard RESTCONF error response (RFC 8040 Section 7.1)", "properties": { "ietf-restconf:errors": { "type": "object", "properties": { "error": { "type": "array", "items": { "type": "object", "properties": { "error-type": { "type": "string", "enum": [ "transport", "rpc", "protocol", "application" ], "description": "Layer where the error occurred" }, "error-tag": { "type": "string", "description": "Enumerated error tag (e.g. invalid-value, data-missing, access-denied)" }, "error-severity": { "type": "string", "enum": [ "error", "warning" ], "description": "Error severity" }, "error-app-tag": { "type": "string", "description": "Application-specific error tag" }, "error-path": { "type": "string", "description": "YANG instance-identifier of the error node" }, "error-message": { "type": "string", "description": "Human-readable error description" } }, "required": [ "error-type", "error-tag" ] } } } } }, "example": { "ietf-restconf:errors": { "error": [ { "error-type": "protocol", "error-tag": "invalid-value", "error-severity": "error", "error-message": "Invalid input parameter" } ] } } } }, "securitySchemes": { "basicAuth": { "type": "http", "scheme": "basic" } } }, "security": [ { "basicAuth": [] } ], "tags": [ { "name": "CISCO-DIAL-CONTROL-MIB", "description": "MIB operations for CISCO-DIAL-CONTROL-MIB" } ], "externalDocs": { "description": "Cisco SNMP Object Navigator", "url": "https://snmp.cloudapps.cisco.com/Support/IOS/do/BrowseMIB.do" } }